updated on Thu Jan 19 20:01:47 UTC 2012
[aur-mirror.git] / trayer-dwm / manpage.diff
blobc99fc71afd80235e848849cb531eda21309ae79f
1 Description: Debian manpage and path setup
2 Author: Jens Peter Secher <jps@debian.org>
3 Index: trayer/trayer.1
4 ===================================================================
5 --- /dev/null 1970-01-01 00:00:00.000000000 +0000
6 +++ trayer/trayer.1 2011-05-08 21:38:37.000000000 +0200
7 @@ -0,0 +1,197 @@
8 +.TH TRAYER 1 "Feb 14, 2005" "FVWM\-Crystal"
9 +.SH NAME
10 +trayer \- a lightweight GTK2\-based systray for UNIX desktop
11 +.SH SYNOPSIS
12 +.B trayer \-h
13 +.br
14 +.B trayer \-v
15 +.br
16 +.B trayer
17 +.\"
18 +.RB [\| \-\-edge
19 +.RI \| left \||\| right \||\| top \||\| bottom \||\| none \|]
20 +.\"
21 +.RB [\| \-\-align
22 +.RI \| left \||\| right \||\| center \|]
23 +.\"
24 +.RB [\| \-\-margin
25 +.RI \| <size> \|]
26 +.\"
27 +.RB [\| \-\-widthtype
28 +.RI \| request \||\| pixel \||\| percent
29 +.RI \|]
30 +.\"
31 +.RB [\| \-\-width
32 +.RI \| <size> \|]
33 +.\"
34 +.RB [\| \-\-heighttype
35 +.RI \| <pixel> \|]
36 +.\"
37 +.RB [\| \-\-height
38 +.RI \| <size> \|]
39 +.\"
40 +.RB [\| \-\-SetDockType
41 +.RI \| true \||\| false \|]
42 +.\"
43 +.RB [\| \-\-SetPartialStrut
44 +.RI \| true \||\| false \|]
45 +.\"
46 +.RB [\| \-\-transparent
47 +.RI \| true \||\| false \|]
48 +.\"
49 +.RB [\| \-\-alpha
50 +.RI \| <value> \|]
51 +.\"
52 +.RB [\| \-\-tint
53 +.RI \| <color> \|]
54 +.\"
55 +.RB [\| \-\-distance
56 +.RI \| <length> \|]
57 +.\"
58 +.RB [\| \-\-distancefrom
59 +.RI \| left \||\| right \||\| top \||\| bottom \||\| none \|]
60 +.\"
61 +.RB [\| \-\-expand
62 +.RI \| true \||\| false \|]
63 +.\"
64 +.RB [\| \-\-padding
65 +.RI \| <size> \|]
66 +.\"
67 +.SH DESCRIPTION
68 +.B trayer
69 +is a small program designed to provide system tray similar to these in
70 +.B GNOME
72 +.B KDE
73 +desktop environments for window managers which does not
74 +support that function. It is similar to other applications such as
75 +.B peksystray
76 +and \fBdocker\fP.
77 +.PP
78 +System tray is a place, where many applications put their icons, so they are
79 +always visible. Such icons may present status of an application and allow user
80 +to control the program.
81 +.PP
82 +\fBtrayer\fP's code was extracted from \fBfbpanel\fP application, you can find more
83 +about it on its homepage: http://fbpanel.sourceforge.net/.
84 +.SH OPTIONS
85 +This programs follow the usual GNU command line syntax, with long
86 +options starting with two dashes (`-').
87 +A summary of options is included below.
88 +.TP
89 +.B \-\-help
90 +.TP
91 +.B \-h
92 +Show summary of options and exit.
94 +.TP
95 +.B \-\-version
96 +.TP
97 +.B \-v
98 +Show version of program and exit.
100 +.TP
101 +\fB\-\-edge\fP \fIleft\fP\||\|\fIright\fP\||\|\fItop\fP\||\|\fIbottom\fP\||\|\fInone\fP
102 +Specifies a screen edge to use.
104 +.TP
105 +\fB\-\-align\fP \fIleft\fP\||\|\fIcenter\fP\||\|\fIright\fP
106 +Specifies an align of the icons.
108 +.TP
109 +\fB\-\-margin\fP \fI<size>\fP
110 +Specifies length of margin (in pixels)
112 +.TP
113 +\fB\-\-widthtype\fB \fIrequest\fP\||\|\fIpixel\fP\||\|\fIpercent\fP
114 +Specifies method of calculating trayer's window width:
115 +.RS
116 +.TP
117 +\fIrequest\fP
118 +Follow application icons' size, so trayer may shrink or expand dynamically.
120 +.TP
121 +\fIpixel\fP
122 +Set a fixed size, given with \fB\-\-width\fP option in pixels.
124 +.TP
125 +\fIpercent\fP
126 +Set a fixed size, given with \fB\-\-width\fP option in percentage of a length of screen edge.
127 +.RE
129 +.TP
130 +\fB\-\-width\fP \fI<size>\fP
131 +Width of trayer's window. Ignored when \fB\-\-widthtype\fP is set to \fIrequest\fP.
133 +.TP
134 +\fB\-\-heighttype\fP \fIrequest\fP\||\|\fIpixel\fP\||\|\fIpercent\fP
135 +Specifies method of calculating trayer's window height:
136 +.RS
137 +.TP
138 +\fIrequest\fP
139 +Follow application icons' size, so trayer may shrink or expand dynamically.
141 +.TP
142 +\fIpixel\fP
143 +Set a fixed size, given with \fB\-\-height\fP option in pixels.
145 +.TP
146 +\fIpercent\fP
147 +Set a fixed size, given with \fB\-\-height\fP option in percentage of a length of screen edge.
148 +.RE
150 +.TP
151 +\fB\-\-height\fP \fI<size>\fP
152 +Height of trayer's window. Ignored when \fB\-\-heighttype\fP is set to \fIrequest\fP.
154 +.TP
155 +\fB\-\-SetDockType\fP \fItrue\fP\||\|\fIfalse\fP
156 +Identify panel window type as dock.
158 +.TP
159 +\fB\-\-SetPartialStrut\fP \fItrue\fP\||\|\fIfalse\fP
160 +Reserve panel space so that it will not be covered by maximized windows.
162 +.TP
163 +\fB\-\-transparent\fP \fItrue\fP\||\|\fIfalse\fP
164 +Use transparency.
166 +.TP
167 +\fB\-\-alpha\fP \fI<value>\fP
168 +Percentage of transparency (0 \- nontransparent, 255 \- fully transparent)
170 +.TP
171 +\fB\-\-tint\fP \fI<color>\fP
172 +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.
174 +.TP
175 +\fB\-\-distance\fP \fI<length>\fP
176 +Specifies distance between trayer's window and screen edge (in pixels)
178 +.TP
179 +\fB\-\-distancefrom\fP \fI<edge>\fP
180 +Specifies which edge to calculate distance from, see above.
182 +.TP
183 +\fB\-\-expand\fP \fItrue\fP\||\|\fIfalse\fP
184 +Specifies whether trayer may accommodate extra space when there is too much
185 +icons.
187 +.TP
188 +\fB\-\-padding\fP \fI<size>\fP
189 +Extra space between icons and trayer window's border.
191 +.SH SEE ALSO
192 +.BR fbpanel (1)
193 +.SH AUTHORS
194 +Anatoly Asviyan <aanatoly@users.sf.net> \- fbpanel
195 +.br
196 +Rafal Bisingier <ravbc@man.poznan.pl>
197 +.br
198 +Maciej Delmanowski <harnir@users.berlios.de>
199 +.br
200 +Grzegorz Nieweglowski <hoppke@dobremiasto.net>
201 +.br
202 +Thomas Rydzynski
203 +.PP
204 +This manual page was written by Tomasz Melcer <liori@interia.pl>.