Description: Merge the man page with the old debian/hashcash.1 file Author: Stefan Kangas Tomasz Melcer 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 \| \|] +.\" +.RB [\| \-\-widthtype +.RI \| request \||\| pixel \||\| percent +.RI \|] +.\" +.RB [\| \-\-width +.RI \| \|] +.\" +.RB [\| \-\-heighttype +.RI \| \|] +.\" +.RB [\| \-\-height +.RI \| \|] +.\" +.RB [\| \-\-SetDockType +.RI \| true \||\| false \|] +.\" +.RB [\| \-\-SetPartialStrut +.RI \| true \||\| false \|] +.\" +.RB [\| \-\-transparent +.RI \| true \||\| false \|] +.\" +.RB [\| \-\-alpha +.RI \| \|] +.\" +.RB [\| \-\-tint +.RI \| \|] +.\" +.RB [\| \-\-distance +.RI \| \|] +.\" +.RB [\| \-\-distancefrom +.RI \| left \||\| right \||\| top \||\| bottom \||\| none \|] +.\" +.RB [\| \-\-expand +.RI \| true \||\| false \|] +.\" +.RB [\| \-\-padding +.RI \| \|] +.\" .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\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\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\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\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\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\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\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\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\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 . 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\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\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 " -.IP "Anatoly Asviyan +.IP "Anatoly Asviyan " fbpanel .IP "Rafal Bisingier " conversion of configuration using ~/.fbpanel/* files to commandline options @@ -172,7 +250,7 @@ .IP "Thomas Rydzynski" added new option 'distance' .IP "Keegan Carruthers-Smith " -fix align +fix align .IP "Yury Akudovich" added new option distancefrom option .IP "Jens Peter Secher " @@ -187,10 +265,14 @@ primary switch for monitor selection .IP "Vladimir Murzin " fixing transparency startup problem -.IP "Corey Richardson " 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 " +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.