summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/icewm-menu-xrandr.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man1/icewm-menu-xrandr.1')
-rw-r--r--upstream/debian-unstable/man1/icewm-menu-xrandr.1219
1 files changed, 219 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man1/icewm-menu-xrandr.1 b/upstream/debian-unstable/man1/icewm-menu-xrandr.1
new file mode 100644
index 00000000..9065ed4c
--- /dev/null
+++ b/upstream/debian-unstable/man1/icewm-menu-xrandr.1
@@ -0,0 +1,219 @@
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "ICEWM-MENU-XRANDR 1"
+.TH ICEWM-MENU-XRANDR 1 "2023-12-31" "icewm\ 3.4.5" "User Commands"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SS "\s-1NAME\s0"
+.IX Subsection "NAME"
+.Vb 1
+\& icewm\-menu\-xrandr \- IceWM menu provider for multi\-monitor setup shortcuts
+.Ve
+.SS "\s-1SYNOPSIS\s0"
+.IX Subsection "SYNOPSIS"
+\&\fBicewm-menu-xrandr\fR
+.SS "\s-1DESCRIPTION\s0"
+.IX Subsection "DESCRIPTION"
+\&\fBicewm-menu-xrandr\fR is a helper to manage multi-screen configurations
+in a semi-automated way. It is a regular icewm menu generator that
+detects the available xrandr screens (i.e. connected monitors) and
+creates menu entries that call the xrandr command to setup this
+configuration.
+.PP
+Optionally, the contents of the generated configurations can be accessed
+on-the-fly through a \*(L"quick-switch\*(R" style menu which pops up upon
+pressing Super-P key binding (or a manually configured key, see
+\&\fBicewm\-keys\fR\|(5) for the configuration of \fBswitchkey\fR directive).
+.PP
+The tool does not examine the exact monitor resolutions, refresh rates
+or screen orientation. For this matters it uses auto selected mode by
+default. However, it is possible to replace the custom option selection
+for each output using \fIxrandr\fR options in a custom configuration file
+(see \fI\s-1CONFIGURATION\s0\fR below). Also tuning specific options like
+\&\-\-brightness and \-\-gamma is possible there.
+.PP
+The displayed name of the monitors is constructed using the output name
+and the monitor information from its \s-1EDID\s0 data. Either from its \*(L"Display
+Name\*(R" field or from the \*(L"Unspecified \s-1ASCII\s0 text\*(R" fields (concatenated).
+.SS "\s-1OPTIONS\s0"
+.IX Subsection "OPTIONS"
+.IP "\fB\-\-max\fR" 4
+.IX Item "--max"
+Obsolete and ineffective option. Used to select the \fIxrandr\fR mode with the
+highest detected refresh rate. However, the maximum rate might cause
+problems, therefore the explicit configuration in the \fI\s-1INI\s0 file\fR should be
+used now, see \fI\s-1CONFIGURATION\s0\fR.
+.IP "\fB\-\-auto\-number [ init value ]\fR" 4
+.IX Item "--auto-number [ init value ]"
+Adding a auto-incremented numbered prefix to each display name,
+optionally started at the specified value. This mostly useful for menu
+creation.
+.IP "\fB\-\-xrandr command\fR" 4
+.IX Item "--xrandr command"
+Replacement for \fIxrandr\fR command that should deliver equivalent data
+and accept the same options as \fIxrandr\fR.
+.IP "\fB\-\-activate combo-name\fR" 4
+.IX Item "--activate combo-name"
+A shortcut to run the activation command of the specified combo, just
+like \fIIceWM\fR would run the commmand when selected from the menu or
+quick-switch dialog. The \fIcombo-name\fR parameter needs to match the
+displayed name exactly.
+.SS "\s-1CONFIGURATION\s0"
+.IX Subsection "CONFIGURATION"
+Optionally, a local configuration can specify command line options to
+\&\fIxrandr\fR calls, and further commands to run after mode switching.
+.PP
+Refer to configuration examples (\fIxrandr_menu\fR) in \fIicewm\fR
+documentation or its contrib folder for the syntax and rules of that
+file. It can be placed into \fI\f(CI$HOME\fI/.config/icewm\fR or into
+\&\fI\f(CI$HOME\fI/.icewm\fR or wherever \fI\f(CI$XDG_CONFIG_HOME\fI/.config/icewm\fR might
+resolve to.
+.SS "\s-1SEE ALSO\s0"
+.IX Subsection "SEE ALSO"
+\&\fBicewm\fR\|(1),
+\&\fBxrandr\fR\|(1).
+.SS "\s-1BUGS\s0"
+.IX Subsection "BUGS"
+Please report bugs at <https://github.com/bbidulock/icewm/issues>.
+.SS "\s-1AUTHOR\s0"
+.IX Subsection "AUTHOR"
+Eduard Bloch <mailto:edi@gmx.de>.
+.SS "\s-1LICENSE\s0"
+.IX Subsection "LICENSE"
+\&\fBicewm-menu-xrandr\fR is licensed under the Simplified \s-1BSD\s0 License.
+\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License.
+See the \fI\s-1COPYING\s0\fR file in the distribution.