1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
|
Description: Merge the man page with the old debian/hashcash.1 file
Author: Stefan Kangas <stefankangas@gmail.com>
Tomasz Melcer <liori@interia.pl>
Forwarded: https://github.com/sargon/trayer-srg/pull/60 https://github.com/sargon/trayer-srg/pull/61
--- a/man/trayer.1
+++ b/man/trayer.1
@@ -1,169 +1,247 @@
.TH TRAYER-SRG 1 LOCAL
.SH NAME
- trayer-srg - a lightweight GTK2-based systray for UNIX desktop
-.SH SYNOPSYS
-.B trayer
-.B "[
-.I OPTIONS
-.B "]
+ trayer-srg \- a lightweight GTK2\-based systray for UNIX desktop
+.SH SYNOPSIS
+.B trayer
+.\"
+.RB [\| \-\-edge
+.RI \| left \||\| right \||\| top \||\| bottom \||\| none \|]
+.\"
+.RB [\| \-\-align
+.RI \| left \||\| right \||\| center \|]
+.\"
+.RB [\| \-\-margin
+.RI \| <size> \|]
+.\"
+.RB [\| \-\-widthtype
+.RI \| request \||\| pixel \||\| percent
+.RI \|]
+.\"
+.RB [\| \-\-width
+.RI \| <size> \|]
+.\"
+.RB [\| \-\-heighttype
+.RI \| <pixel> \|]
+.\"
+.RB [\| \-\-height
+.RI \| <size> \|]
+.\"
+.RB [\| \-\-SetDockType
+.RI \| true \||\| false \|]
+.\"
+.RB [\| \-\-SetPartialStrut
+.RI \| true \||\| false \|]
+.\"
+.RB [\| \-\-transparent
+.RI \| true \||\| false \|]
+.\"
+.RB [\| \-\-alpha
+.RI \| <value> \|]
+.\"
+.RB [\| \-\-tint
+.RI \| <color> \|]
+.\"
+.RB [\| \-\-distance
+.RI \| <length> \|]
+.\"
+.RB [\| \-\-distancefrom
+.RI \| left \||\| right \||\| top \||\| bottom \||\| none \|]
+.\"
+.RB [\| \-\-expand
+.RI \| true \||\| false \|]
+.\"
+.RB [\| \-\-padding
+.RI \| <size> \|]
+.\"
.SH DESCRIPTION
-trayer is small program designed to provide systray functionality present in GNOME/KDE desktop enviroments for window managers which doesn't support that function. It's similar to other applications such as 'peksystray' and 'docker'.
-
-trayer code was extracted from fbpanel application, you can find more about it on it's homepage:
+
+trayer is small program designed to provide systray functionality present in
+.B GNOME
+/
+.B KDE
+desktop environments for window managers which doesn't support that
+function. It's similar to other applications such as
+.B peksystray
+and \fBdocker\fP.
+
+trayer code was extracted from fbpanel application, you can find more about it on it's homepage:
.IB http://fbpanel.sourceforge.net/
You can find new versions of trayer and support on FVWM-Crystal project homepage:
.IB http://fvwm-crystal.berlios.de/
-trayer-srg was forked from trayer in january 2010 to add some fancy features and clean up code.
+trayer-srg was forked from trayer in January 2010 to add some fancy features and clean up code.
It contains all changes from above versions as far as known.
Code of trayer-srg can be found on github:
.IB http://github.com/sargon/trayer-srg
.SH OPTIONS
-.TP
-.BR \-h
-prints help message and exits
-.TP
-.BR \-v
+.TP
+.B \-h, \-\-help
+prints help message and exits
+.TP
+.B \-v, \-\-version
prints version and exits
.TP
-.BR \--edge " EDGE"
-Use
+\fB\-\-edge\fP \fI<edge>\fP
+Use
.I EDGE
for orientation. Possible values for
.I EDGE
-are
-.BR left,
+are
+.BR left,
.BR right,
.BR top,
.BR bottom
-or
+or
.BR none.
-The default value is
-.BR bottom.
+The default value is
+.BR bottom.
.TP
-.BR \--align " ALIGNMENT"
+\fB\-\-align\fP \fI<alignment>\fP
Orientation of docked icons inside the trayer panel. Possible values are
.BR left,
.BR center,
.BR right,
or
.BR none.
-The default value is
+The default value is
.BR center.
.TP
-.BR \--margin " NUM"
-Length of margin in pixels. The default value is
+\fB\-\-margin\fP \fI<size>\fP
+Length of margin in pixels. The default value is
.BR 0.
.TP
-.BR \--distance " NUM"
-Space between trayer's window and screen edge.
+.TP
+\fB\-\-distance\fP \fI<length>\fP
+Distance between trayer's window and screen edge (in pixels).
When set to 0 the option has no effect.
The default value is
.BR 0.
.TP
-.BR \--distancefrom " EDGE"
-Specifies which edge to calculate distance from, see
-.BR --edge.
-The default value is
-.BR top.
- When
-.BR --distance
-is 0 then this option has no effect.
-.TP
-.BR \--widthtype " TYPE"
-Determine how width is calculated. Possible values for
-.I TYPE
-are
-.BR pixel,
-.BR percent,
-.BR request
-or
-.BR none.
+\fB\-\-distancefrom\fP \fI<edge>\fP
+Specifies which edge to calculate distance from, see
+.BR \-\-edge.
The default value is
-.BR percent.
+.BR top.
+ When
+.BR \-\-distance
+is 0 this option has no effect.
+.TP
+\fB\-\-widthtype\fB \fIrequest\fP\||\|\fIpixel\fP\||\|\fIpercent\fP\||\|\fInone\fP
+Determine how width is calculated.
+.RS
+.TP
+\fIrequest\fP
+Follow application icons' size, so trayer may shrink or expand dynamically.
+
+.TP
+\fIpixel\fP
+Set a fixed size, given with \fB\-\-width\fP option in pixels.
+
+.TP
+\fIpercent\fP
+Set a fixed size, given with \fB\-\-width\fP option in percentage of a length of
+screen edge.
+
.TP
-.BR \--width " NUM"
-Width of a panel. When
-.BR --widthtype=request
-this option has no effect. The default value is
+\fInone\fP
+.TP
+The default value is \fBpercent\fP.
+.RE
+.TP
+\fB\-\-width\fP \fI<size>\fP
+Width of a panel. When
+.BR \-\-widthtype=request
+this option has no effect. The default value is
.BR 100.
.TP
-.BR \--heighttype " TYPE"
-Determine how height is calculated. Possible values for
-.I TYPE
-are
-.BR pixel,
-.BR request
-or
-.BR none.
+\fB\-\-heighttype\fP \fIrequest\fP\||\|\fIpixel\fP\||\|\fIpercent\fP\||\|\fInone\fP
+Determine how height is calculated.
+.RS
+.TP
+\fIrequest\fP
+Follow application icons' size, so trayer may shrink or expand dynamically.
+
+.TP
+\fIpixel\fP
+Set a fixed size, given with \fB\-\-height\fP option in pixels.
-The default value is
-.BR pixel.
.TP
-.BR \--height " NUM"
-Height of a panel. When
-.BR --heigthtype=request
+\fIpercent\fP
+Set a fixed size, given with \fB\-\-height\fP option in percentage of a length of screen edge.
+
+.TP
+\fInone\fP
+.TP
+The default value is \fBpixel\fP.
+.RE
+.TP
+\fB\-\-height\fP \fI<size>\fP
+Height of trayer's window. When
+.BR \-\-heigthtype=request
this option has no effect. The default value is
.BR 26.
.TP
-.BR \--SetDockTpe " BOOL"
+\fB\-\-SetDockType\fP \fItrue\fP\||\|\fIfalse\fP
Identify panel window type as dock. The default value is
.BR true.
.TP
-.BR \--SetPartialStrut " BOOL"
-Reserve panel's space so that it will not be covered by maximazied windows. The
-default value is
+\fB\-\-SetPartialStrut\fP \fItrue\fP\||\|\fIfalse\fP
+Reserve panel space so that it will not be covered by maximized windows. The
+default value is
+.BR false.
+.TP
+\fB\-\-transparent\fP \fItrue\fP\||\|\fIfalse\fP
+Use transparency. The default value is
.BR false.
.TP
-.BR \--transparent " BOOL"
-Use transparency. Default value is
-.BR false.
-.TP
-.BR \--tint " NUM"
-Color used to "tint" background wallpaper with.
-.I NUM
-is 32bit width hexadecimal number.
-The default value is
+\fB\-\-tint\fP \fI<color>\fP
+Color used to "tint" transparent background. Color is given as a 24-bit C
+hexadecimal integer, for example: 0xff0000 is red, 0xff8800 is orange and
+0x00ff00 is green.
+The default value is
.BR 0xFFFFFFFF.
.TP
-.BR \--alpha " NUM"
-Percentage of transparency.
-.I NUM
-should be a value between 0 and 256. The default value is
+\fB\-\-alpha\fP \fI<value>\fP
+Percentage of transparency (0 \- nontransparent, 255 \- fully transparent).
+.I value
+should be a value between 0 and 255. The default value is
.BR 127.
.TP
-.BR \--expand " BOOL"
-Specifies if trayer can accomodate extra space or not <true|false>. The default
+\fB\-\-expand\fP \fItrue\fP\||\|\fIfalse\fP
+Specifies if trayer can accommodate extra space or not. The default
value is
.BR true.
.TP
-.BR \--padding " NUM"
+\fB \-\-padding\fP \fI<size>\fP
Number of extra pixel space between trayer's window frame and docked icons. The
default value is
.BR 0.
.TP
-.BR \--monitor " NUM|STRING"
-Define the monitor on which you like trayer to appear, number of zero to number
+.BR \-\-monitor\fP \fI<monitor>\fP
+Define the monitor on which you like trayer to appear. Number of zero to number
of monitors minus one, or the string "primary" are valid. The default value is
.BR 0.
.SH EXAMPLES
-.LP
+.LP
Place trayer to the top right edge of the screen and prevent other fullsize
windows to overlay it:
+
.RS
.nf
-\f8trayer trayer --edge top --align right --SetDockType true --SetPartialStrut true --expand true --transparent true\fP
+ trayer trayer --edge top --align right --SetDockType true \\
+ --SetPartialStrut true --expand true --transparent true
.fi
.RE
.SH BUGS
Report bugs to the issue tracker:
.I https://github.com/sargon/trayer-srg/issues
.SH CONTRIBUTORS
- Following people are or has been involved in development of trayer-srg:
+The following people are or have been involved in the development of
+trayer-srg:
.IP "Maciej Delmanowski <harnir@users.berlios.de>"
-.IP "Anatoly Asviyan <aanatoly@users.sf.net>
+.IP "Anatoly Asviyan <aanatoly@users.sf.net>"
fbpanel
.IP "Rafal Bisingier <ravbc@man.poznan.pl>"
conversion of configuration using ~/.fbpanel/* files to commandline options
@@ -172,7 +250,7 @@
.IP "Thomas Rydzynski"
added new option 'distance'
.IP "Keegan Carruthers-Smith <keegan.csmith@gmail.com>"
-fix align
+fix align
.IP "Yury Akudovich"
added new option distancefrom option
.IP "Jens Peter Secher <jps@debian.org>"
@@ -187,10 +265,14 @@
primary switch for monitor selection
.IP "Vladimir Murzin <murzin.v@gmail.com>"
fixing transparency startup problem
-.IP "Corey Richardson <corey@octayn.net>" Found some default value fuckup
-.IP "Constantine Verutin" React on changes in monitor setup.
-.IP "Robbie Harwood" Fixup build
-.IP "Omar Sandoval" Fixups
+.IP "Corey Richardson <corey@octayn.net>"
+Found some default value fuckup
+.IP "Constantine Verutin"
+React on changes in monitor setup.
+.IP "Robbie Harwood"
+Fixup build
+.IP "Omar Sandoval"
+Fixups
.SH AUTHOR
This man page is written by Daniel Ehlers.
|