From 0ac042c1ce65cf65ef965f8fc6be80f8a44a9d4b Mon Sep 17 00:00:00 2001 From: Jim Ramsay Date: Wed, 18 Feb 2009 10:53:06 -0500 Subject: Moved fbrun(1) to asciidoc format --- doc/Makefile.am | 6 +- doc/asciidoc/Makefile | 2 +- doc/asciidoc/fbrun.txt | 94 +++++++++++++++ doc/fbrun.1 | 70 ------------ doc/fbrun.1.in | 304 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 402 insertions(+), 74 deletions(-) create mode 100644 doc/asciidoc/fbrun.txt delete mode 100644 doc/fbrun.1 create mode 100644 doc/fbrun.1.in diff --git a/doc/Makefile.am b/doc/Makefile.am index 8a5e61d..da18c58 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -2,12 +2,12 @@ # Makefile.am for fluxbox/doc SUBDIRS = ru -CLEANFILES = fluxbox.1 fluxbox-apps.5 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 +CLEANFILES = fluxbox.1 fbrun.1 fluxbox-apps.5 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 MAINTAINERCLEANFILES = Makefile.in man_MANS = fbsetroot.1 fbrun.1 fbsetbg.1 startfluxbox.1 \ fluxbox.1 fluxbox-apps.5 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 -EXTRA_DIST=fbsetroot.1 fbrun.1 fbsetbg.1 startfluxbox.1 CODESTYLE \ - fluxbox.1.in fluxbox-apps.5.in fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in +EXTRA_DIST=fbsetroot.1 fbsetbg.1 startfluxbox.1 CODESTYLE \ + fluxbox.1.in fbrun.1.in fluxbox-apps.5.in fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in distclean-local: rm -f *\~ diff --git a/doc/asciidoc/Makefile b/doc/asciidoc/Makefile index d69157a..70db7ef 100644 --- a/doc/asciidoc/Makefile +++ b/doc/asciidoc/Makefile @@ -2,7 +2,7 @@ # create manpages from the asciidoc files # -SRC1 = fluxbox.txt fluxbox-remote.txt +SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in) diff --git a/doc/asciidoc/fbrun.txt b/doc/asciidoc/fbrun.txt new file mode 100644 index 0000000..12342f7 --- /dev/null +++ b/doc/asciidoc/fbrun.txt @@ -0,0 +1,94 @@ +fbrun(1) +========== +Bastian Kleineidam +v1.1.2, 18 February 2009 +:man source: fbrun.txt +:man version: {revision} +:man manual: Fluxbox Manual + +NAME +---- +fbrun - display run dialog window + +SYNOPSIS +-------- +*fbrun* ['options'] + +DESCRIPTION +----------- +*fbrun(1)* is basically equivalent to the ``Run...'' 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). + +Pressing ``Enter'' will close the window and execute the command in your present +*$SHELL*. Pressing ``Esc'' will close the window and does not execute anything. + +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. + +OPTIONS +------- +*-title* 'title':: + Set title + +*-text* 'text':: + Text input + +*-w* 'width':: + Window width in pixels + +*-h* 'height':: + Window height in pixels + +*-display* 'display':: + Display name, defaults to *$DISPLAY* + +*-pos* 'x' 'y':: + Window position in pixels + +*-nearmouse*:: + Position the window under the mouse cursor + +*-fg* 'color':: + Foreground text color. The default is *black* + +*-bg* 'color':: + Background color. The default is *white* + +*-font* 'name':: + Text font name + +*-na*:: + Disable font antialias + +*-hf* 'filename':: + History file to load. The default is *~/.fluxbox/fbrun_history*. + +*-help*:: + Show this help + +EXAMPLE +------- +.... +fbrun -fg black -bg white -text xterm -title "run xterm" +.... + +AUTHORS +------- +- This manpage was originally written by Bastian Kleineidam for the Debian distribution of fluxbox (but may be used by + others). + +- It was then converted to asciidoc format by Jim Ramsay + for fluxbox-1.1.2 + +- The main author of fluxbox is Henrik Kinnunen . + +SEE ALSO +-------- +fluxbox(1) diff --git a/doc/fbrun.1 b/doc/fbrun.1 deleted file mode 100644 index a6555eb..0000000 --- a/doc/fbrun.1 +++ /dev/null @@ -1,70 +0,0 @@ -.\" -.\" Man page for fbrun -.\" -.\" Copyright (c) 2004 by Bastian Kleineidam -.\" -.TH FBRUN 1 "16 December 2003" -.SH NAME -fbrun \- display run dialog window -.SH SYNOPSIS -\fBfbrun\fP [\fIoptions\fP]... -.SH DESCRIPTION -\fBfbrun\fP is basically equivalent to the "Run..." 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). - -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. -.SH OPTIONS -.TP -\fB-font\fP \fIname\fP -Text font name -.TP -\fB-title\fP \fIname\fP -Set title -.TP -\fB-text\fP \fItext\fP -Text input -.TP -\fB-w\fP \fIwidth\fP -Window width in pixels -.TP -\fB-h\fP \fIheight\fP -Window height in pixels -.TP -\fB-display\fP \fIname\fP -Display name -.TP -\fB-pos\fP \fIx\fP \fIy\fP -Window position in pixels -.TP -\fB-nearmouse\fP -Position the window under the mouse cursor -.TP -\fB-fg\fP \fIname\fP -Foreground text color -.TP -\fB-bg\fP \fIname\fP -Background color -.TP -\fB-na\fP -Disable antialias -.TP -\fB-hf\fP \fIfilename\fP -History file to load (default ~/.fluxbox/fbrun_history -.TP -\fB-help\fP -Show this help -.SH EXAMPLE - \fBfbrun -fg black -bg white -text xterm -title "run xterm"\fP -.SH AUTHOR -This manpage was originally written by Bastian Kleineidam - for the Debian distribution of fluxbox -(but may be used by others). - -The main author of fluxbox is Henrik Kinnunen . 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 @@ +.\" Title: fbrun +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.74.0 +.\" Date: 02/18/2009 +.\" Manual: Fluxbox Manual +.\" Source: fbrun.txt 1.1.2 +.\" Language: English +.\" +.TH "FBRUN" "1" "02/18/2009" "fbrun\&.txt 1\&.1\&.2" "Fluxbox Manual" +.\" ----------------------------------------------------------------- +.\" * (re)Define some macros +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" toupper - uppercase a string (locale-aware) +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de toupper +.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ +\\$* +.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH-xref - format a cross-reference to an SH section +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de SH-xref +.ie n \{\ +.\} +.toupper \\$* +.el \{\ +\\$* +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH - level-one heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SH +.\" put an extra blank line of space above the head in non-TTY output +.if t \{\ +.sp 1 +.\} +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[an-margin]u +.ti 0 +.HTML-TAG ".NH \\n[an-level]" +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +\." make the size of the head bigger +.ps +3 +.ft B +.ne (2v + 1u) +.ie n \{\ +.\" if n (TTY output), use uppercase +.toupper \\$* +.\} +.el \{\ +.nr an-break-flag 0 +.\" if not n (not TTY), use normal case (not uppercase) +\\$1 +.in \\n[an-margin]u +.ti 0 +.\" if not n (not TTY), put a border/line under subheading +.sp -.6 +\l'\n(.lu' +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SS - level-two heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SS +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[IN]u +.ti \\n[SN]u +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.ps \\n[PS-SS]u +\." make the size of the head bigger +.ps +2 +.ft B +.ne (2v + 1u) +.if \\n[.$] \&\\$* +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BB/BE - put background/screen (filled box) around block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BB +.if t \{\ +.sp -.5 +.br +.in +2n +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EB +.if t \{\ +.if "\\$2"adjust-for-leading-newline" \{\ +.sp -1 +.\} +.br +.di +.in +.ll +.gcolor +.nr BW \\n(.lu-\\n(.i +.nr BH \\n(dn+.5v +.ne \\n(BHu+.5v +.ie "\\$2"adjust-for-leading-newline" \{\ +\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.el \{\ +\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.in 0 +.sp -.5v +.nf +.BX +.in +.sp .5v +.fi +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ +.br +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EM +.if t \{\ +.br +.di +.ll +.gcolor +.nr BH \\n(dn +.ne \\n(BHu +\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] +.in 0 +.nf +.BX +.in +.fi +.\} +.. +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +fbrun \- display run dialog window +.SH "Synopsis" +.sp +\fBfbrun\fR [\fIoptions\fR] +.SH "DESCRIPTION" +.sp +\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)\&. +.sp +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\&. +.sp +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\&. +.SH "OPTIONS" +.PP +\fB\-title\fR \fItitle\fR +.RS 4 +Set title +.RE +.PP +\fB\-text\fR \fItext\fR +.RS 4 +Text input +.RE +.PP +\fB\-w\fR \fIwidth\fR +.RS 4 +Window width in pixels +.RE +.PP +\fB\-h\fR \fIheight\fR +.RS 4 +Window height in pixels +.RE +.PP +\fB\-display\fR \fIdisplay\fR +.RS 4 +Display name, defaults to +\fB$DISPLAY\fR +.RE +.PP +\fB\-pos\fR \fIx\fR \fIy\fR +.RS 4 +Window position in pixels +.RE +.PP +\fB\-nearmouse\fR +.RS 4 +Position the window under the mouse cursor +.RE +.PP +\fB\-fg\fR \fIcolor\fR +.RS 4 +Foreground text color\&. The default is +\fBblack\fR +.RE +.PP +\fB\-bg\fR \fIcolor\fR +.RS 4 +Background color\&. The default is +\fBwhite\fR +.RE +.PP +\fB\-font\fR \fIname\fR +.RS 4 +Text font name +.RE +.PP +\fB\-na\fR +.RS 4 +Disable font antialias +.RE +.PP +\fB\-hf\fR \fIfilename\fR +.RS 4 +History file to load\&. The default is +\fB~/\&.fluxbox/fbrun_history\fR\&. +.RE +.PP +\fB\-help\fR +.RS 4 +Show this help +.RE +.SH "EXAMPLE" +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +fbrun \-fg black \-bg white \-text xterm \-title "run xterm" +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.SH "AUTHORS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +This manpage was originally written by Bastian Kleineidam for the Debian distribution of fluxbox (but may be used by others)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +It was then converted to asciidoc format by Jim Ramsay for fluxbox\-1\&.1\&.2 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The main author of fluxbox is Henrik Kinnunen \&. +.RE +.SH "SEE ALSO" +.sp +fluxbox(1) -- cgit v0.11.2