diff options
Diffstat (limited to 'upstream/debian-unstable/man1/icewmbg.1')
| -rw-r--r-- | upstream/debian-unstable/man1/icewmbg.1 | 184 |
1 files changed, 54 insertions, 130 deletions
diff --git a/upstream/debian-unstable/man1/icewmbg.1 b/upstream/debian-unstable/man1/icewmbg.1 index 2050521e..e8aecd1d 100644 --- a/upstream/debian-unstable/man1/icewmbg.1 +++ b/upstream/debian-unstable/man1/icewmbg.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .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' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .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\} @@ -68,85 +52,23 @@ . \} .\} .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-12-31" "icewm\ 3.4.5" "User Commands" +.TH ICEWMBG 1 2024-05-24 "icewm\ 3.5.0" "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" +.SS NAME .IX Subsection "NAME" .Vb 1 -\& icewmbg \- a background settings manager for the IceWM window manager +\& icewmbg \- a desktop background image manager for IceWM .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" -\&\fBicewmbg\fR [\fI\s-1OPTIONS\s0\fR] [\fI\s-1ARGUMENTS\s0\fR] -.SS "\s-1DESCRIPTION\s0" +\&\fBicewmbg\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR] +.SS DESCRIPTION .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) workspace can have @@ -154,8 +76,7 @@ its own background. .PP When the background image changes, \fBicewmbg\fR can be notified to update the background. When switching workspaces, it checks the image -file modification time. If the file has changed, it reloads the -image from file. +file modification time. If it has changed, it reloads the image. .PP \&\fBicewmbg\fR supports semitransparency. Semitransparent background images and colours can be configured. @@ -173,17 +94,17 @@ If there is just a single background for all workspaces, icewmbg may conclude that it can safely exit after setting the desktop background, to free its system memory. If the screen size changes, icewm will then attempt to restart icewmbg, preferably via icewm-session. -.SS "\s-1ARGUMENTS\s0" +.SS ARGUMENTS .IX Subsection "ARGUMENTS" -.SS "\s-1SPECIFIC OPTIONS\s0" +.SS "SPECIFIC OPTIONS" .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 +If \fIFILE\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. +the images from the directory \fIFILE\fR are permuted randomly. Image file names or directory names may have \fBglob\fR\|(7) wildcards, or they may start with a tilde or environment variable. .IP "\fB\-f\fR, \fB\-\-fork\fR" 4 @@ -206,29 +127,29 @@ settings in have changed. If no icewmbg is active, it starts one. 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 +.IP "\fB\-c\fR, \fB\-\-config\fR=\fIFILE\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 +Load preferences from \fIFILE\fR. +.IP "\fB\-t\fR, \fB\-\-theme\fR=\fITHEME\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 +Use the theme named \fITHEME\fR. +.IP "\fB\-i\fR, \fB\-\-image\fR=\fIFILE\fR[,\fIFILE\fR]*" 4 .IX Item "-i, --image=FILE[,FILE]*" -Load background images from each \fI\s-1FILE\s0\fR. +Load background images from each \fIFILE\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 +.IP "\fB\-k\fR, \fB\-\-color\fR=\fICOLOR\fR[,\fICOLOR\fR]*" 4 .IX Item "-k, --color=COLOR[,COLOR]*" -Use background colours from each \fI\s-1COLOR\s0\fR. +Use background colours from each \fICOLOR\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 +.IP "\fB\-s\fR, \fB\-\-semis\fR=\fIFILE\fR[,\fIFILE\fR]*" 4 .IX Item "-s, --semis=FILE[,FILE]*" -Load transparency images from each \fI\s-1FILE\s0\fR. +Load transparency images from each \fIFILE\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 +.IP "\fB\-x\fR, \fB\-\-trans\fR=\fINAME\fR[,\fINAME\fR]" 4 .IX Item "-x, --trans=NAME[,NAME]" -Use transparency colours for each \fI\s-1NAME\s0\fR. +Use transparency colours for each \fINAME\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}" @@ -242,23 +163,26 @@ This overrules the \f(CW\*(C`DesktopBackgroundScaled\*(C'\fR preference. .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 +.IP "\fB\-y\fR, \fB\-\-cycle\fR=\fISECONDS\fR" 4 .IX Item "-y, --cycle=SECONDS" -Cycle over the list of background images every \fI\s-1SECONDS\s0\fR. +Cycle over the list of background images every \fISECONDS\fR. This overrules the \f(CW\*(C`CycleBackgroundsPeriod\*(C'\fR preference. .IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4 .IX Item "-o, --output=FILE" -Redirect all output to \fI\s-1FILE\s0\fR. +Redirect all output to \fIFILE\fR. A leading tilde or environment variable is expanded. -.IP "\fB\-\-postpreferences\fR" 4 +.IP \fB\-\-postpreferences\fR 4 .IX Item "--postpreferences" Print a list of all preference values that \fBicewmbg\fR will use. -.SS "\s-1GENERAL OPTIONS\s0" +.IP \fB\-\-verbose\fR 4 +.IX Item "--verbose" +Print a log of actions and some events. +.SS "GENERAL OPTIONS" .IX Subsection "GENERAL OPTIONS" -.IP "\fB\-d\fR, \fB\-\-display\fR=\fI\s-1DISPLAY\s0\fR" 4 +.IP "\fB\-d\fR, \fB\-\-display\fR=\fIDISPLAY\fR" 4 .IX Item "-d, --display=DISPLAY" -Use \fI\s-1DISPLAY\s0\fR to connect to the X server. -Otherwise use \s-1DISPLAY\s0 from the environment. +Use \fIDISPLAY\fR to connect to the X server. +Otherwise use DISPLAY from the environment. .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Print a brief usage statement to \fIstdout\fR and exit. @@ -268,17 +192,17 @@ 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 +.IP \fB\-\-sync\fR 4 .IX Item "--sync" Use a slow synchronous mode to communicate with the \fIX11\fR server. -.IP "\fB\-\-verbose\fR" 4 +.IP \fB\-\-verbose\fR 4 .IX Item "--verbose" Report on some of the activities. -.SS "\s-1FILES\s0" +.SS FILES .IX Subsection "FILES" Additional arguments, which either are a path or which have an image extension, are assumed to be background image files or directories. -.SS "\s-1PREFERENCES\s0" +.SS PREFERENCES .IX Subsection "PREFERENCES" By default \fBicewmbg\fR loads settings from the \fBicewm\fR\|(1) preferences file. See \fBicewm\-preferences\fR\|(5) for details. @@ -301,7 +225,7 @@ If these settings are set in the \fIpreferences\fR file, they can be overridden by the theme in the theme defaults file. To enforce a certain setting, set it in the \fIprefoverride\fR file instead. See \fBicewm\-prefoverride\fR\|(5). -.SS "\s-1WORKSPACES\s0" +.SS WORKSPACES .IX Subsection "WORKSPACES" Each workspace can have a unique image. Specify multiple images to \&\fBDesktopBackgroundImage\fR separated by comma's. Or give at least one @@ -314,7 +238,7 @@ If you specify more images then there are workspaces, then icewmbg will switch to the next set of images. If you give less images than there are workspaces, then icewmbg will reuse previous images for the remaining workspaces. -.SS "\s-1IMAGE SCALING\s0" +.SS "IMAGE SCALING" .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 @@ -327,7 +251,7 @@ What happens for their combination is given by the following table: \& 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" +.SS EXAMPLES .IX Subsection "EXAMPLES" .Vb 1 \& # For four unique desktop backgrounds for four workspaces do: @@ -340,20 +264,20 @@ What happens for their combination is given by the following table: \& \& # The images should have proper image filename extensions. .Ve -.SS "\s-1SIGNALS\s0" +.SS SIGNALS .IX Subsection "SIGNALS" \&\fBicewmbg\fR supports the following signals: -.IP "\fB\s-1SIGHUP\s0\fR" 4 +.IP \fBSIGHUP\fR 4 .IX Item "SIGHUP" \&\fBicewmbg\fR will restart itself. -.IP "\fB\s-1SIGINT\s0\fR, \fB\s-1SIGTERM\s0\fR" 4 +.IP "\fBSIGINT\fR, \fBSIGTERM\fR" 4 .IX Item "SIGINT, SIGTERM" \&\fBicewmbg\fR will terminate. -.IP "\fB\s-1SIGUSR1\s0\fR" 4 +.IP \fBSIGUSR1\fR 4 .IX Item "SIGUSR1" \&\fBicewmbg\fR will reshuffle the list of background images and update the backgrounds of all workspaces. -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBicewm\-preferences\fR\|(5), @@ -361,16 +285,16 @@ update the backgrounds of all workspaces. \&\fBwmsetbg\fR\|(1), \&\fBxsetbg\fR\|(1), \&\fBxwallpaper\fR\|(1). -.SS "\s-1BUGS\s0" +.SS BUGS .IX Subsection "BUGS" Please report bugs at <https://github.com/bbidulock/icewm/issues>. -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .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" +.SS LICENSE .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 +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag to display copying permissions. |