diff options
Diffstat (limited to 'upstream/debian-bookworm/man1/icewmbg.1')
| -rw-r--r-- | upstream/debian-bookworm/man1/icewmbg.1 | 357 |
1 files changed, 357 insertions, 0 deletions
diff --git a/upstream/debian-bookworm/man1/icewmbg.1 b/upstream/debian-bookworm/man1/icewmbg.1 new file mode 100644 index 00000000..1234cd9e --- /dev/null +++ b/upstream/debian-bookworm/man1/icewmbg.1 @@ -0,0 +1,357 @@ +.\" 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 "ICEWMBG 1" +.TH ICEWMBG 1 "2023-02-05" "icewm\ 3.3.1" "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 +\& icewmbg \- a background settings manager for the IceWM window manager +.Ve +.SS "\s-1SYNOPSIS\s0" +.IX Subsection "SYNOPSIS" +\&\fBicewmbg\fR [\fI\s-1OPTIONS\s0\fR] +.SS "\s-1DESCRIPTION\s0" +.IX Subsection "DESCRIPTION" +\&\fBicewmbg\fR can assign a colour or image to the \fIX11\fR desktop background. +Common image formats are supported. Each \fBicewm\fR\|(1) work space can have +its own background. +.PP +When the background image has changed, \fBicewmbg\fR can be notified to +update the background. When switching work spaces, it checks the image +file modification time. If the file has changed, it reloads the +image from file. +.PP +\&\fBicewmbg\fR supports semi-transparency. Semitransparent background +images and colours can be configured. +.PP +It uses RandR or Xinerama to support backgrounds on all connected +monitors. When monitors appear/disappear, or change their resolution, +\&\fBicewmbg\fR will adjust. It supports an option for one large background +over all monitors. +.PP +It will update the \f(CW\*(C`_ICEWMBG_IMAGE\*(C'\fR property of the root window to the +path of the background image whenever it changes the desktop background. +.PP +\&\fBicewmbg\fR is started automatically by \fBicewm\-session\fR\|(1). +.SS "\s-1OPTIONS\s0" +.IX Subsection "OPTIONS" +.SS "\s-1SPECIFIC OPTIONS\s0" +.IX Subsection "SPECIFIC OPTIONS" +Where multiple values can be given for images +or colours, they are separated by comma's. +Each such value may be enclosed in double quotes. +If \fI\s-1FILE\s0\fR is a directory, all images +from that directory are used in sorted order. +If the value starts with an exclamation mark, as in \fI!FILE\fR, +the images from the directory \fI\s-1FILE\s0\fR are permuted randomly. +Image file names or directory names may have \fBglob\fR\|(7) wildcards, +.IP "\fB\-p\fR, \fB\-\-replace\fR" 4 +.IX Item "-p, --replace" +Replace an existing \fBicewmbg\fR. If there is a running \fBicewmbg\fR, +it is instructed to quit. The new \fBicewmbg\fR will take over. +.IP "\fB\-q\fR, \fB\-\-quit\fR" 4 +.IX Item "-q, --quit" +Tell the running \fBicewmbg\fR to quit. This option is used by +\&\fBicewm\-session\fR\|(1) when \fBicewm\fR\|(1) exits. +.IP "\fB\-r\fR, \fB\-\-restart\fR" 4 +.IX Item "-r, --restart" +Tell the running \fBicewmbg\fR to restart itself. This is useful when +settings in have changed. If no icewmbg is active, it starts one. +.IP "\fB\-u\fR, \fB\-\-shuffle\fR" 4 +.IX Item "-u, --shuffle" +Shuffle the list of background images randomly. +This option may be given again whenever the running +\&\fBicewmbg\fR should reshuffle its list of background images. +.IP "\fB\-c\fR, \fB\-\-config\fR=\fI\s-1FILE\s0\fR" 4 +.IX Item "-c, --config=FILE" +Load preferences from \fI\s-1FILE\s0\fR. +.IP "\fB\-t\fR, \fB\-\-theme\fR=\fI\s-1THEME\s0\fR" 4 +.IX Item "-t, --theme=THEME" +Use the theme named \fI\s-1THEME\s0\fR. +.IP "\fB\-i\fR, \fB\-\-image\fR=\fI\s-1FILE\s0\fR[,\fI\s-1FILE\s0\fR]*" 4 +.IX Item "-i, --image=FILE[,FILE]*" +Load background images from each \fI\s-1FILE\s0\fR. +This overrules the \f(CW\*(C`DesktopBackgroundImage\*(C'\fR preference. +When more than one image is given, they are assigned +to each workspace in the given order. +.IP "\fB\-k\fR, \fB\-\-color\fR=\fI\s-1COLOR\s0\fR[,\fI\s-1COLOR\s0\fR]*" 4 +.IX Item "-k, --color=COLOR[,COLOR]*" +Use background colours from each \fI\s-1COLOR\s0\fR. +This overrules the \f(CW\*(C`DesktopBackgroundColor\*(C'\fR preference. +.IP "\fB\-s\fR, \fB\-\-semis\fR=\fI\s-1FILE\s0\fR[,\fI\s-1FILE\s0\fR]*" 4 +.IX Item "-s, --semis=FILE[,FILE]*" +Load transparency images from each \fI\s-1FILE\s0\fR. +This overrules the \f(CW\*(C`DesktopTransparencyImage\*(C'\fR preference. +.IP "\fB\-x\fR, \fB\-\-trans\fR=\fI\s-1NAME\s0\fR[,\fI\s-1NAME\s0\fR]" 4 +.IX Item "-x, --trans=NAME[,NAME]" +Use transparency colours for each \fI\s-1NAME\s0\fR. +This overrules the \f(CW\*(C`DesktopTransparencyColor\*(C'\fR preference. +.IP "\fB\-e\fR, \fB\-\-center\fR={\fI0\fR|\fI1\fR}" 4 +.IX Item "-e, --center={0|1}" +Disable/Enable centring background. +This overrules the \f(CW\*(C`DesktopBackgroundCenter\*(C'\fR preference. +.IP "\fB\-a\fR, \fB\-\-scaled\fR={\fI0\fR|\fI1\fR}" 4 +.IX Item "-a, --scaled={0|1}" +Disable/Enable scaling background. +This overrules the \f(CW\*(C`DesktopBackgroundScaled\*(C'\fR preference. +.IP "\fB\-m\fR, \fB\-\-multi\fR={\fI0\fR|\fI1\fR}" 4 +.IX Item "-m, --multi={0|1}" +Disable or enable a single background over all monitors. +This overrules the \f(CW\*(C`DesktopBackgroundMultihead\*(C'\fR preference. +.IP "\fB\-y\fR, \fB\-\-cycle\fR=\fI\s-1SECONDS\s0\fR" 4 +.IX Item "-y, --cycle=SECONDS" +Cycle over the list of background images every \fI\s-1SECONDS\s0\fR. +This overrules the \f(CW\*(C`CycleBackgroundsPeriod\*(C'\fR preference. +.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\-h\fR, \fB\-\-help\fR" 4 +.IX Item "-h, --help" +Print a brief usage statement to \fIstdout\fR and exit. +.IP "\fB\-V\fR, \fB\-\-version\fR" 4 +.IX Item "-V, --version" +Print the program version to \fIstdout\fR and exit. +.IP "\fB\-C\fR, \fB\-\-copying\fR" 4 +.IX Item "-C, --copying" +Print copying permissions to \fIstdout\fR for the program and exit. +.IP "\fB\-\-sync\fR" 4 +.IX Item "--sync" +Use a slower synchronous mode communication with \fIX11\fR server. +.SS "\s-1FILES\s0" +.IX Subsection "FILES" +.SS "\s-1PREFERENCES\s0" +.IX Subsection "PREFERENCES" +By default \fBicewmbg\fR loads settings from the \fBicewm\fR\|(1) +preferences file. See \fBicewm\-preferences\fR\|(5) for details. +The settings read are: +.PP +.Vb 10 +\& DesktopBackgroundCenter \- Display desktop background centered +\& DesktopBackgroundScaled \- Display desktop background scaled +\& DesktopBackgroundColor \- Desktop background color(s) +\& DesktopBackgroundImage \- Desktop background image(s) +\& ShuffleBackgroundImages \- Shuffle the list of background images +\& SupportSemitransparency \- Support for semitransparent terminals +\& DesktopTransparencyColor \- Semitransparency background color(s) +\& DesktopTransparencyImage \- Semitransparency background image(s) +\& DesktopBackgroundMultihead \- One background over all monitors +\& CycleBackgroundsPeriod \- Seconds between cycling over backgrounds +.Ve +.PP +If these settings are set in the \fIpreferences\fR file, they can +be overridden by the theme in the theme defaults file. +To prevent this, set these preferences in \fIprefoverride\fR instead. +See \fBicewm\-prefoverride\fR\|(5). +.SS "\s-1WORK SPACES\s0" +.IX Subsection "WORK SPACES" +Each work space can have a unique image. Specify multiple images to +\&\fBDesktopBackgroundImage\fR separated by comma's. Or give at least one +directory with images. The images are assigned to each work space in +the order given. When icewm changes work space, the running icewmbg +will adapt the desktop background to the assigned image. +.PP +If you specify more images then there are work spaces, then +\&\fBCycleBackgroundsPeriod\fR can set a period. When the period expires, +icewmbg will switch to the next set of images. If you give less images +than there are work spaces, then icewmbg will reuse previous images +for the remaining work spaces. +.SS "\s-1IMAGE SCALING\s0" +.IX Subsection "IMAGE SCALING" +Often a background image has a different width or height than the screen. +The image can then be replicated (tiled), centered or scaled. This is +controlled by \f(CW\*(C`DesktopBackgroundCenter\*(C'\fR and \f(CW\*(C`DesktopBackgroundScaled\*(C'\fR. +What happens for their combination is given by the following table: +.PP +.Vb 4 +\& center:0 scaled:0 = The background is replicated in both directions. +\& center:1 scaled:0 = The background is centered, but not scaled. +\& center:1 scaled:1 = Fill one dimension and preserve the aspect ratio. +\& center:0 scaled:1 = Fill both dimensions and preserve the aspect ratio. +.Ve +.SS "\s-1EXAMPLES\s0" +.IX Subsection "EXAMPLES" +.Vb 1 +\& # For four unique desktop backgrounds for four work spaces do: +\& +\& icewmbg \-p \-i image0,image1,image2,image3 & +\& +\& # Or create a directory with the four images and do: +\& +\& icewmbg \-p \-i /path/to/directory & +\& +\& # The images should have proper image filename extensions. +.Ve +.SS "\s-1SIGNALS\s0" +.IX Subsection "SIGNALS" +\&\fBicewmbg\fR supports the following signals: +.IP "\fB\s-1SIGHUP\s0\fR" 4 +.IX Item "SIGHUP" +\&\fBicewmbg\fR will restart itself. +.IP "\fB\s-1SIGINT\s0\fR, \fB\s-1SIGTERM\s0\fR" 4 +.IX Item "SIGINT, SIGTERM" +\&\fBicewmbg\fR will terminate. +.IP "\fB\s-1SIGUSR1\s0\fR" 4 +.IX Item "SIGUSR1" +\&\fBicewmbg\fR will reshuffle the list of background images and +update the backgrounds of all work spaces. +.SS "\s-1SEE ALSO\s0" +.IX Subsection "SEE ALSO" +\&\fBicewm\fR\|(1), +\&\fBicewm\-preferences\fR\|(5), +\&\fBicewm\-prefoverride\fR\|(5), +\&\fBwmsetbg\fR\|(1), +\&\fBxsetbg\fR\|(1), +\&\fBxwallpaper\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. |