From e1018645da345b6c37d39922dbd1ffc41caa8fe9 Mon Sep 17 00:00:00 2001 From: Jim Ramsay Date: Wed, 18 Feb 2009 15:31:41 -0500 Subject: Converted startfluxbox(1) to asciidoc format --- doc/Makefile.am | 4 +- doc/asciidoc/Makefile | 2 +- doc/asciidoc/startfluxbox.txt | 45 +++++++++ doc/startfluxbox.1 | 59 ------------ doc/startfluxbox.1.in | 210 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 258 insertions(+), 62 deletions(-) create mode 100644 doc/asciidoc/startfluxbox.txt delete mode 100644 doc/startfluxbox.1 create mode 100644 doc/startfluxbox.1.in diff --git a/doc/Makefile.am b/doc/Makefile.am index e7309d8..969e277 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -2,13 +2,13 @@ # Makefile.am for fluxbox/doc SUBDIRS = ru -CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \ +CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 startfluxbox.1 fluxbox-apps.5 \ fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 MAINTAINERCLEANFILES = Makefile.in man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \ fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 \ startfluxbox.1 -EXTRA_DIST=startfluxbox.1 CODESTYLE \ +EXTRA_DIST=startfluxbox.1.in CODESTYLE \ fluxbox.1.in fbrun.1.in fbsetbg.1.in fbsetroot.1.in fluxbox-apps.5.in \ fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in distclean-local: diff --git a/doc/asciidoc/Makefile b/doc/asciidoc/Makefile index bb48c1e..5561a4a 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 fbrun.txt fbsetbg.txt fbsetroot.txt +SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt fbsetroot.txt startfluxbox.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/startfluxbox.txt b/doc/asciidoc/startfluxbox.txt new file mode 100644 index 0000000..5a43ca1 --- /dev/null +++ b/doc/asciidoc/startfluxbox.txt @@ -0,0 +1,45 @@ +startfluxbox(1) +=============== +Jim Ramsay +v1.1.2, 18 February 2009 +:man source: startfluxbox.txt +:man version: {revision} +:man manual: Fluxbox Manual + +NAME +---- +startfluxbox - start a fluxbox session + +SYNOPSIS +-------- +*startfluxbox* + +DESCRIPTION +----------- +*startfluxbox* is a script which runs the file *\~/.fluxbox/startup* If it +doesn't exist it will be generated. + +*startfluxbox* should be started from your *\~/.xinitrc* if you use startx, or +*\~/.xsession* if you run a display manager, like xdm. + +FILES +----- +*~/.fluxbox/startup*:: + This file contains all commands that should be executed before fluxbox is + started. The initial file contains helpful comments for beginners. It also + starts fluxbox. + +ONLINE DOCUMENTATION +-------------------- +More extensive documentation for *startfluxbox(1)* can be found at::: +http://www.xs4all.nl/~hanb/software/fluxbox/startfluxbox.html + +AUTHORS +------- +The author of *startfluxbox(1)* is Han Boetes + +This manpage was updated to asciidoc format by Jim Ramsay + +SEE ALSO +-------- +fluxbox(1) diff --git a/doc/startfluxbox.1 b/doc/startfluxbox.1 deleted file mode 100644 index 5697bbe..0000000 --- a/doc/startfluxbox.1 +++ /dev/null @@ -1,59 +0,0 @@ -.\" $Id$ -.\" -.\" Copyright (c) 2004, Han Boetes -.\" -.\" Permission to use, copy, modify, and distribute this documentation for -.\" any purpose with or without fee is hereby granted, provided that the -.\" above copyright notice and this permission notice appear in all copies. -.\" -.\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL -.\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED -.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE -.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL -.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR -.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER -.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR -.\" PERFORMANCE OF THIS DOCUMENTATION -.\" -.Dd Aug 10, 2004 -.Dt STARTFLUXBOX 1 -.Os -.Sh NAME -.Nm startfluxbox -.Nd "start a fluxbox session" -.Sh SYNOPSIS -.Nm startfluxbox -.Sh DESCRIPTION -.Nm -is a script which runs the file -.Bl -tag -width "~/.fluxbox/startup" -compact -.It Pa ~/.fluxbox/startup -.El -If it doesn't exist it will be generated. -.Pp -.Nm -should be started from your -.Bl -tag -width "~/.xinitrc" -compact -.It Pa ~/.xinitrc -if you use startx, or -.El -.Bl -tag -width "~/.xsession" -compact -.It Pa ~/.xsession -if you run a display manager, like xdm. -.Pp -.El -.Sh FILES -.Bl -tag -width "~/.fluxbox/startup" -compact -.It Pa ~/.fluxbox/startup -.El -This file contains all commands that should be executed before fluxbox -is started. The initial file contains helpful comments for beginners. -.Sh ONLINE DOCUMENTATION: -More extensive documentation for -.Nm -can be found at: -http://www.xs4all.nl/~hanb/software/fluxbox/startfluxbox.html -.Sh AUTHOR -The author of -.Nm -is Han Boetes diff --git a/doc/startfluxbox.1.in b/doc/startfluxbox.1.in new file mode 100644 index 0000000..8ae2564 --- /dev/null +++ b/doc/startfluxbox.1.in @@ -0,0 +1,210 @@ +.\" Title: startfluxbox +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.74.0 +.\" Date: 02/18/2009 +.\" Manual: Fluxbox Manual +.\" Source: startfluxbox.txt 1.1.2 +.\" Language: English +.\" +.TH "STARTFLUXBOX" "1" "02/18/2009" "startfluxbox\&.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" +startfluxbox \- start a fluxbox session +.SH "Synopsis" +.sp +\fBstartfluxbox\fR +.SH "DESCRIPTION" +.sp +\fBstartfluxbox\fR is a script which runs the file \fB~/\&.fluxbox/startup\fR If it doesn\'t exist it will be generated\&. +.sp +\fBstartfluxbox\fR should be started from your \fB~/\&.xinitrc\fR if you use startx, or \fB~/\&.xsession\fR if you run a display manager, like xdm\&. +.SH "FILES" +.PP +\fB~/\&.fluxbox/startup\fR +.RS 4 +This file contains all commands that should be executed before fluxbox is started\&. The initial file contains helpful comments for beginners\&. It also starts fluxbox\&. +.RE +.SH "ONLINE DOCUMENTATION" +.PP +More extensive documentation for \fBstartfluxbox(1)\fR can be found at: +.RS 4 + +\m[blue]\fBhttp://www\&.xs4all\&.nl/~hanb/software/fluxbox/startfluxbox\&.html\fR\m[] +.RE +.SH "AUTHORS" +.sp +The author of \fBstartfluxbox(1)\fR is Han Boetes <\m[blue]\fBhan@fluxbox\&.org\fR\m[]\&\s-2\u[1]\d\s+2> +.sp +This manpage was updated to asciidoc format by Jim Ramsay <\m[blue]\fBi\&.am@jimramsay\&.com\fR\m[]\&\s-2\u[2]\d\s+2> +.SH "SEE ALSO" +.sp +fluxbox(1) +.SH "Notes" +.IP " 1." 4 +han@fluxbox.org +.RS 4 +\%mailto:han@fluxbox.org +.RE +.IP " 2." 4 +i.am@jimramsay.com +.RS 4 +\%mailto:i.am@jimramsay.com +.RE -- cgit v0.11.2