diff options
Diffstat (limited to 'doc/fbrun.1.in')
-rw-r--r-- | doc/fbrun.1.in | 304 |
1 files changed, 304 insertions, 0 deletions
diff --git a/doc/fbrun.1.in b/doc/fbrun.1.in new file mode 100644 index 0000000..09a6107 --- /dev/null +++ b/doc/fbrun.1.in | |||
@@ -0,0 +1,304 @@ | |||
1 | .\" Title: fbrun | ||
2 | .\" Author: [see the "AUTHORS" section] | ||
3 | .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> | ||
4 | .\" Date: 02/18/2009 | ||
5 | .\" Manual: Fluxbox Manual | ||
6 | .\" Source: fbrun.txt 1.1.2 | ||
7 | .\" Language: English | ||
8 | .\" | ||
9 | .TH "FBRUN" "1" "02/18/2009" "fbrun\&.txt 1\&.1\&.2" "Fluxbox Manual" | ||
10 | .\" ----------------------------------------------------------------- | ||
11 | .\" * (re)Define some macros | ||
12 | .\" ----------------------------------------------------------------- | ||
13 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
14 | .\" toupper - uppercase a string (locale-aware) | ||
15 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
16 | .de toupper | ||
17 | .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ | ||
18 | \\$* | ||
19 | .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz | ||
20 | .. | ||
21 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
22 | .\" SH-xref - format a cross-reference to an SH section | ||
23 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
24 | .de SH-xref | ||
25 | .ie n \{\ | ||
26 | .\} | ||
27 | .toupper \\$* | ||
28 | .el \{\ | ||
29 | \\$* | ||
30 | .\} | ||
31 | .. | ||
32 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
33 | .\" SH - level-one heading that works better for non-TTY output | ||
34 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
35 | .de1 SH | ||
36 | .\" put an extra blank line of space above the head in non-TTY output | ||
37 | .if t \{\ | ||
38 | .sp 1 | ||
39 | .\} | ||
40 | .sp \\n[PD]u | ||
41 | .nr an-level 1 | ||
42 | .set-an-margin | ||
43 | .nr an-prevailing-indent \\n[IN] | ||
44 | .fi | ||
45 | .in \\n[an-margin]u | ||
46 | .ti 0 | ||
47 | .HTML-TAG ".NH \\n[an-level]" | ||
48 | .it 1 an-trap | ||
49 | .nr an-no-space-flag 1 | ||
50 | .nr an-break-flag 1 | ||
51 | \." make the size of the head bigger | ||
52 | .ps +3 | ||
53 | .ft B | ||
54 | .ne (2v + 1u) | ||
55 | .ie n \{\ | ||
56 | .\" if n (TTY output), use uppercase | ||
57 | .toupper \\$* | ||
58 | .\} | ||
59 | .el \{\ | ||
60 | .nr an-break-flag 0 | ||
61 | .\" if not n (not TTY), use normal case (not uppercase) | ||
62 | \\$1 | ||
63 | .in \\n[an-margin]u | ||
64 | .ti 0 | ||
65 | .\" if not n (not TTY), put a border/line under subheading | ||
66 | .sp -.6 | ||
67 | \l'\n(.lu' | ||
68 | .\} | ||
69 | .. | ||
70 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
71 | .\" SS - level-two heading that works better for non-TTY output | ||
72 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
73 | .de1 SS | ||
74 | .sp \\n[PD]u | ||
75 | .nr an-level 1 | ||
76 | .set-an-margin | ||
77 | .nr an-prevailing-indent \\n[IN] | ||
78 | .fi | ||
79 | .in \\n[IN]u | ||
80 | .ti \\n[SN]u | ||
81 | .it 1 an-trap | ||
82 | .nr an-no-space-flag 1 | ||
83 | .nr an-break-flag 1 | ||
84 | .ps \\n[PS-SS]u | ||
85 | \." make the size of the head bigger | ||
86 | .ps +2 | ||
87 | .ft B | ||
88 | .ne (2v + 1u) | ||
89 | .if \\n[.$] \&\\$* | ||
90 | .. | ||
91 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
92 | .\" BB/BE - put background/screen (filled box) around block of text | ||
93 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
94 | .de BB | ||
95 | .if t \{\ | ||
96 | .sp -.5 | ||
97 | .br | ||
98 | .in +2n | ||
99 | .ll -2n | ||
100 | .gcolor red | ||
101 | .di BX | ||
102 | .\} | ||
103 | .. | ||
104 | .de EB | ||
105 | .if t \{\ | ||
106 | .if "\\$2"adjust-for-leading-newline" \{\ | ||
107 | .sp -1 | ||
108 | .\} | ||
109 | .br | ||
110 | .di | ||
111 | .in | ||
112 | .ll | ||
113 | .gcolor | ||
114 | .nr BW \\n(.lu-\\n(.i | ||
115 | .nr BH \\n(dn+.5v | ||
116 | .ne \\n(BHu+.5v | ||
117 | .ie "\\$2"adjust-for-leading-newline" \{\ | ||
118 | \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] | ||
119 | .\} | ||
120 | .el \{\ | ||
121 | \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] | ||
122 | .\} | ||
123 | .in 0 | ||
124 | .sp -.5v | ||
125 | .nf | ||
126 | .BX | ||
127 | .in | ||
128 | .sp .5v | ||
129 | .fi | ||
130 | .\} | ||
131 | .. | ||
132 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
133 | .\" BM/EM - put colored marker in margin next to block of text | ||
134 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
135 | .de BM | ||
136 | .if t \{\ | ||
137 | .br | ||
138 | .ll -2n | ||
139 | .gcolor red | ||
140 | .di BX | ||
141 | .\} | ||
142 | .. | ||
143 | .de EM | ||
144 | .if t \{\ | ||
145 | .br | ||
146 | .di | ||
147 | .ll | ||
148 | .gcolor | ||
149 | .nr BH \\n(dn | ||
150 | .ne \\n(BHu | ||
151 | \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] | ||
152 | .in 0 | ||
153 | .nf | ||
154 | .BX | ||
155 | .in | ||
156 | .fi | ||
157 | .\} | ||
158 | .. | ||
159 | .\" ----------------------------------------------------------------- | ||
160 | .\" * set default formatting | ||
161 | .\" ----------------------------------------------------------------- | ||
162 | .\" disable hyphenation | ||
163 | .nh | ||
164 | .\" disable justification (adjust text to left margin only) | ||
165 | .ad l | ||
166 | .\" ----------------------------------------------------------------- | ||
167 | .\" * MAIN CONTENT STARTS HERE * | ||
168 | .\" ----------------------------------------------------------------- | ||
169 | .SH "Name" | ||
170 | fbrun \- display run dialog window | ||
171 | .SH "Synopsis" | ||
172 | .sp | ||
173 | \fBfbrun\fR [\fIoptions\fR] | ||
174 | .SH "DESCRIPTION" | ||
175 | .sp | ||
176 | \fBfbrun(1)\fR is basically equivalent to the \(lqRun\&...\(rq dialog in other desktop environments\&. This means that it is an easy way to start a program that isn\'t contained in the menu (or needs a special set of parameters for this particular invocation)\&. | ||
177 | .sp | ||
178 | Pressing \(lqEnter\(rq will close the window and execute the command in your present \fB$SHELL\fR\&. Pressing \(lqEsc\(rq will close the window and does not execute anything\&. | ||
179 | .sp | ||
180 | Another way fbrun can be useful is to be called from the menu with a preloaded command line that you can edit and then execute\&. An example might be sshing to a very long host name with lots of options of which one changes all the time\&. In this case, you could add an entry for fbrun to your menu that contains all the options and the host name\&. When you use said entry, you could edit the line as necessary and execute it\&. | ||
181 | .SH "OPTIONS" | ||
182 | .PP | ||
183 | \fB\-title\fR \fItitle\fR | ||
184 | .RS 4 | ||
185 | Set title | ||
186 | .RE | ||
187 | .PP | ||
188 | \fB\-text\fR \fItext\fR | ||
189 | .RS 4 | ||
190 | Text input | ||
191 | .RE | ||
192 | .PP | ||
193 | \fB\-w\fR \fIwidth\fR | ||
194 | .RS 4 | ||
195 | Window width in pixels | ||
196 | .RE | ||
197 | .PP | ||
198 | \fB\-h\fR \fIheight\fR | ||
199 | .RS 4 | ||
200 | Window height in pixels | ||
201 | .RE | ||
202 | .PP | ||
203 | \fB\-display\fR \fIdisplay\fR | ||
204 | .RS 4 | ||
205 | Display name, defaults to | ||
206 | \fB$DISPLAY\fR | ||
207 | .RE | ||
208 | .PP | ||
209 | \fB\-pos\fR \fIx\fR \fIy\fR | ||
210 | .RS 4 | ||
211 | Window position in pixels | ||
212 | .RE | ||
213 | .PP | ||
214 | \fB\-nearmouse\fR | ||
215 | .RS 4 | ||
216 | Position the window under the mouse cursor | ||
217 | .RE | ||
218 | .PP | ||
219 | \fB\-fg\fR \fIcolor\fR | ||
220 | .RS 4 | ||
221 | Foreground text color\&. The default is | ||
222 | \fBblack\fR | ||
223 | .RE | ||
224 | .PP | ||
225 | \fB\-bg\fR \fIcolor\fR | ||
226 | .RS 4 | ||
227 | Background color\&. The default is | ||
228 | \fBwhite\fR | ||
229 | .RE | ||
230 | .PP | ||
231 | \fB\-font\fR \fIname\fR | ||
232 | .RS 4 | ||
233 | Text font name | ||
234 | .RE | ||
235 | .PP | ||
236 | \fB\-na\fR | ||
237 | .RS 4 | ||
238 | Disable font antialias | ||
239 | .RE | ||
240 | .PP | ||
241 | \fB\-hf\fR \fIfilename\fR | ||
242 | .RS 4 | ||
243 | History file to load\&. The default is | ||
244 | \fB~/\&.fluxbox/fbrun_history\fR\&. | ||
245 | .RE | ||
246 | .PP | ||
247 | \fB\-help\fR | ||
248 | .RS 4 | ||
249 | Show this help | ||
250 | .RE | ||
251 | .SH "EXAMPLE" | ||
252 | .sp | ||
253 | .if n \{\ | ||
254 | .RS 4 | ||
255 | .\} | ||
256 | .fam C | ||
257 | .ps -1 | ||
258 | .nf | ||
259 | .BB lightgray | ||
260 | fbrun \-fg black \-bg white \-text xterm \-title "run xterm" | ||
261 | .EB lightgray | ||
262 | .fi | ||
263 | .fam | ||
264 | .ps +1 | ||
265 | .if n \{\ | ||
266 | .RE | ||
267 | .\} | ||
268 | .SH "AUTHORS" | ||
269 | .sp | ||
270 | .RS 4 | ||
271 | .ie n \{\ | ||
272 | \h'-04'\(bu\h'+03'\c | ||
273 | .\} | ||
274 | .el \{\ | ||
275 | .sp -1 | ||
276 | .IP \(bu 2.3 | ||
277 | .\} | ||
278 | This manpage was originally written by Bastian Kleineidam <calvin at debian\&.org> for the Debian distribution of fluxbox (but may be used by others)\&. | ||
279 | .RE | ||
280 | .sp | ||
281 | .RS 4 | ||
282 | .ie n \{\ | ||
283 | \h'-04'\(bu\h'+03'\c | ||
284 | .\} | ||
285 | .el \{\ | ||
286 | .sp -1 | ||
287 | .IP \(bu 2.3 | ||
288 | .\} | ||
289 | It was then converted to asciidoc format by Jim Ramsay <i\&.am at jimramsay\&.com> for fluxbox\-1\&.1\&.2 | ||
290 | .RE | ||
291 | .sp | ||
292 | .RS 4 | ||
293 | .ie n \{\ | ||
294 | \h'-04'\(bu\h'+03'\c | ||
295 | .\} | ||
296 | .el \{\ | ||
297 | .sp -1 | ||
298 | .IP \(bu 2.3 | ||
299 | .\} | ||
300 | The main author of fluxbox is Henrik Kinnunen <fluxgen at fluxbox\&.org>\&. | ||
301 | .RE | ||
302 | .SH "SEE ALSO" | ||
303 | .sp | ||
304 | fluxbox(1) | ||