summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/icewm-session.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man1/icewm-session.1')
-rw-r--r--upstream/debian-unstable/man1/icewm-session.1263
1 files changed, 263 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man1/icewm-session.1 b/upstream/debian-unstable/man1/icewm-session.1
new file mode 100644
index 00000000..7ebe6d6b
--- /dev/null
+++ b/upstream/debian-unstable/man1/icewm-session.1
@@ -0,0 +1,263 @@
+.\" 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-SESSION 1"
+.TH ICEWM-SESSION 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\-session \- X.Org session manager provider with IceWM
+.Ve
+.SS "\s-1SYNOPSIS\s0"
+.IX Subsection "SYNOPSIS"
+\&\fBicewm-session\fR [\fI\s-1OPTIONS\s0\fR]
+.SS "\s-1DESCRIPTION\s0"
+.IX Subsection "DESCRIPTION"
+icewm-session is an implementation of a X.Org session manager and can be
+run from a X11 session setup. It runs \fBicewm\fR as default window manager
+and controls the life cycle of related support applications.
+.SS "\s-1OPTIONS\s0"
+.IX Subsection "OPTIONS"
+.SS "\s-1SPECIFIC OPTIONS\s0"
+.IX Subsection "SPECIFIC OPTIONS"
+.IP "\fB\-c\fR, \fB\-\-config=FILE\fR" 4
+.IX Item "-c, --config=FILE"
+Let IceWM load preferences from \fI\s-1FILE\s0\fR.
+.IP "\fB\-t\fR, \fB\-\-theme=FILE\fR" 4
+.IX Item "-t, --theme=FILE"
+Let IceWM load the theme \fI\s-1FILE\s0\fR.
+.IP "\fB\-i\fR, \fB\-\-icewm=FILE\fR" 4
+.IX Item "-i, --icewm=FILE"
+Use \fI\s-1FILE\s0\fR as the IceWM window manager.
+.IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4
+.IX Item "-o, --output=FILE"
+Redirect all output to \fI\s-1FILE\s0\fR.
+A leading tilde or environment variable is expanded.
+.IP "\fB\-a\fR, \fB\-\-alpha\fR" 4
+.IX Item "-a, --alpha"
+Use a 32\-bit visual for translucency.
+.IP "\fB\-b\fR, \fB\-\-nobg\fR" 4
+.IX Item "-b, --nobg"
+Do not start icewmbg.
+.IP "\fB\-n\fR, \fB\-\-notray\fR" 4
+.IX Item "-n, --notray"
+Do not start icewmtray.
+This is only applicable if IceWM was explicitly configured
+to use an external icewmtray process.
+.IP "\fB\-s\fR, \fB\-\-sound\fR" 4
+.IX Item "-s, --sound"
+Also start icesound.
+.SS "\s-1GENERAL OPTIONS\s0"
+.IX Subsection "GENERAL OPTIONS"
+.IP "\fB\-d\fR, \fB\-\-display\fR=\fI\s-1DISPLAY\s0\fR" 4
+.IX Item "-d, --display=DISPLAY"
+Use \fI\s-1DISPLAY\s0\fR to connect to the X server.
+If this option is missing then \fI\s-1DISPLAY\s0\fR
+is read from the environment variable \f(CW\*(C`DISPLAY\*(C'\fR.
+.IP "\fB\-\-sync\fR" 4
+.IX Item "--sync"
+Use a slower synchronous mode communication with the \fIX11\fR server.
+.IP "\fB\-h\fR, \fB\-\-help\fR" 4
+.IX Item "-h, --help"
+Give a list of all supported options and exit.
+.IP "\fB\-V\fR, \fB\-\-version\fR" 4
+.IX Item "-V, --version"
+Print the program version and exit.
+.IP "\fB\-C\fR, \fB\-\-copying\fR" 4
+.IX Item "-C, --copying"
+Print copying permissions and exit.
+.SS "\s-1DEBUGGING OPTIONS\s0"
+.IX Subsection "DEBUGGING OPTIONS"
+.IP "\fB\-v\fR, \fB\-\-\-valgrind\fR" 4
+.IX Item "-v, ---valgrind"
+Let \f(CW\*(C`/usr/bin/valgrind\*(C'\fR run icewm.
+Thoroughly examines the execution of icewm.
+.IP "\fB\-g\fR, \fB\-\-\-catchsegv\fR" 4
+.IX Item "-g, ---catchsegv"
+Let \f(CW\*(C`/usr/bin/catchsegv\*(C'\fR run icewm.
+Gives a backtrace if icewm segfaults.
+.SS "\s-1USAGE\s0"
+.IX Subsection "USAGE"
+On startup icewm-session executes the following steps.
+From the file \fIenv\fR in the configuration directory
+it loads additional environment variables, if that file exists.
+Then it will start \fIicewmbg\fR to manage root background colors and images.
+It may also start \fIicesound\fR, if this was enabled at configuration time.
+Then \fIicewm\fR is started.
+.PP
+If there exists an executable script \fIstartup\fR in the configuration
+directory, it will be executed. It may contain commands to initialize X11
+settings with \fIxset\fR, load keyboard configuration, start a compositing
+manager like \fIcompton\fR and load system tray applications.
+.PP
+When icewm exits, icewm-session will execute a \fIshutdown\fR script,
+if it exists in the configuration directory.
+When this finishes, icewm-session will terminate icewm, icewmbg
+and icesound. Finally, icewm-session will exit.
+.PP
+If the icewm process crashes then icewm-session will attempt to restart
+it. If two such crashes occur in a short period, then icewm-session will
+attempt to popup a dialog using either \fIyad\fR, \fIxmessage\fR, \fIkdialog\fR
+or \fIzenity\fR. This dialog presents a choice between restarting icewm,
+starting a terminal, or abort execution of icewm-session.
+.SS "\s-1ENVIRONMENT\s0"
+.IX Subsection "ENVIRONMENT"
+.IP "\fB\s-1ICEWM_OPTIONS\s0\fR" 4
+.IX Item "ICEWM_OPTIONS"
+A space separated list of options that will be added to the command
+line invocation of \fIicewm\fR. This can be set in the \fIenv\fR file.
+.SS "\s-1SEE ALSO\s0"
+.IX Subsection "SEE ALSO"
+\&\fBicewm\fR\|(1),
+\&\fBicewm\-env\fR\|(5),
+\&\fBicewm\-shutdown\fR\|(5),
+\&\fBicewm\-startup\fR\|(5),
+\&\fBicewmbg\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"
+Brian Bidulock <mailto:bidulock@openss7.org>.
+.PP
+See \fB\-\-copying\fR for full copyright notice and copying permissions.
+.SS "\s-1LICENSE\s0"
+.IX Subsection "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 or use the \fB\-\-copying\fR flag
+to display copying permissions.