diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 4 | ||||
-rw-r--r-- | doc/asciidoc/Makefile | 2 | ||||
-rw-r--r-- | doc/asciidoc/startfluxbox.txt | 45 | ||||
-rw-r--r-- | doc/startfluxbox.1 | 59 | ||||
-rw-r--r-- | doc/startfluxbox.1.in | 210 |
5 files changed, 258 insertions, 62 deletions
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 @@ | |||
2 | # Makefile.am for fluxbox/doc | 2 | # Makefile.am for fluxbox/doc |
3 | 3 | ||
4 | SUBDIRS = ru | 4 | SUBDIRS = ru |
5 | CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \ | 5 | CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 startfluxbox.1 fluxbox-apps.5 \ |
6 | fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 | 6 | fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 |
7 | MAINTAINERCLEANFILES = Makefile.in | 7 | MAINTAINERCLEANFILES = Makefile.in |
8 | man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \ | 8 | man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \ |
9 | fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 \ | 9 | fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 \ |
10 | startfluxbox.1 | 10 | startfluxbox.1 |
11 | EXTRA_DIST=startfluxbox.1 CODESTYLE \ | 11 | EXTRA_DIST=startfluxbox.1.in CODESTYLE \ |
12 | fluxbox.1.in fbrun.1.in fbsetbg.1.in fbsetroot.1.in fluxbox-apps.5.in \ | 12 | fluxbox.1.in fbrun.1.in fbsetbg.1.in fbsetroot.1.in fluxbox-apps.5.in \ |
13 | fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in | 13 | fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in |
14 | distclean-local: | 14 | 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 @@ | |||
2 | # create manpages from the asciidoc files | 2 | # create manpages from the asciidoc files |
3 | # | 3 | # |
4 | 4 | ||
5 | SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt fbsetroot.txt | 5 | SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt fbsetroot.txt startfluxbox.txt |
6 | SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt | 6 | SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt |
7 | 7 | ||
8 | MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in) | 8 | 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 @@ | |||
1 | startfluxbox(1) | ||
2 | =============== | ||
3 | Jim Ramsay <i.am@jimramsay.com> | ||
4 | v1.1.2, 18 February 2009 | ||
5 | :man source: startfluxbox.txt | ||
6 | :man version: {revision} | ||
7 | :man manual: Fluxbox Manual | ||
8 | |||
9 | NAME | ||
10 | ---- | ||
11 | startfluxbox - start a fluxbox session | ||
12 | |||
13 | SYNOPSIS | ||
14 | -------- | ||
15 | *startfluxbox* | ||
16 | |||
17 | DESCRIPTION | ||
18 | ----------- | ||
19 | *startfluxbox* is a script which runs the file *\~/.fluxbox/startup* If it | ||
20 | doesn't exist it will be generated. | ||
21 | |||
22 | *startfluxbox* should be started from your *\~/.xinitrc* if you use startx, or | ||
23 | *\~/.xsession* if you run a display manager, like xdm. | ||
24 | |||
25 | FILES | ||
26 | ----- | ||
27 | *~/.fluxbox/startup*:: | ||
28 | This file contains all commands that should be executed before fluxbox is | ||
29 | started. The initial file contains helpful comments for beginners. It also | ||
30 | starts fluxbox. | ||
31 | |||
32 | ONLINE DOCUMENTATION | ||
33 | -------------------- | ||
34 | More extensive documentation for *startfluxbox(1)* can be found at::: | ||
35 | http://www.xs4all.nl/~hanb/software/fluxbox/startfluxbox.html | ||
36 | |||
37 | AUTHORS | ||
38 | ------- | ||
39 | The author of *startfluxbox(1)* is Han Boetes <han@fluxbox.org> | ||
40 | |||
41 | This manpage was updated to asciidoc format by Jim Ramsay <i.am@jimramsay.com> | ||
42 | |||
43 | SEE ALSO | ||
44 | -------- | ||
45 | 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 @@ | |||
1 | .\" $Id$ | ||
2 | .\" | ||
3 | .\" Copyright (c) 2004, Han Boetes <han@fluxbox.org> | ||
4 | .\" | ||
5 | .\" Permission to use, copy, modify, and distribute this documentation for | ||
6 | .\" any purpose with or without fee is hereby granted, provided that the | ||
7 | .\" above copyright notice and this permission notice appear in all copies. | ||
8 | .\" | ||
9 | .\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL | ||
10 | .\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED | ||
11 | .\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE | ||
12 | .\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL | ||
13 | .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR | ||
14 | .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER | ||
15 | .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR | ||
16 | .\" PERFORMANCE OF THIS DOCUMENTATION | ||
17 | .\" | ||
18 | .Dd Aug 10, 2004 | ||
19 | .Dt STARTFLUXBOX 1 | ||
20 | .Os | ||
21 | .Sh NAME | ||
22 | .Nm startfluxbox | ||
23 | .Nd "start a fluxbox session" | ||
24 | .Sh SYNOPSIS | ||
25 | .Nm startfluxbox | ||
26 | .Sh DESCRIPTION | ||
27 | .Nm | ||
28 | is a script which runs the file | ||
29 | .Bl -tag -width "~/.fluxbox/startup" -compact | ||
30 | .It Pa ~/.fluxbox/startup | ||
31 | .El | ||
32 | If it doesn't exist it will be generated. | ||
33 | .Pp | ||
34 | .Nm | ||
35 | should be started from your | ||
36 | .Bl -tag -width "~/.xinitrc" -compact | ||
37 | .It Pa ~/.xinitrc | ||
38 | if you use startx, or | ||
39 | .El | ||
40 | .Bl -tag -width "~/.xsession" -compact | ||
41 | .It Pa ~/.xsession | ||
42 | if you run a display manager, like xdm. | ||
43 | .Pp | ||
44 | .El | ||
45 | .Sh FILES | ||
46 | .Bl -tag -width "~/.fluxbox/startup" -compact | ||
47 | .It Pa ~/.fluxbox/startup | ||
48 | .El | ||
49 | This file contains all commands that should be executed before fluxbox | ||
50 | is started. The initial file contains helpful comments for beginners. | ||
51 | .Sh ONLINE DOCUMENTATION: | ||
52 | More extensive documentation for | ||
53 | .Nm | ||
54 | can be found at: | ||
55 | http://www.xs4all.nl/~hanb/software/fluxbox/startfluxbox.html | ||
56 | .Sh AUTHOR | ||
57 | The author of | ||
58 | .Nm | ||
59 | is Han Boetes <han@fluxbox.org> | ||
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 @@ | |||
1 | .\" Title: startfluxbox | ||
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: startfluxbox.txt 1.1.2 | ||
7 | .\" Language: English | ||
8 | .\" | ||
9 | .TH "STARTFLUXBOX" "1" "02/18/2009" "startfluxbox\&.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 | startfluxbox \- start a fluxbox session | ||
171 | .SH "Synopsis" | ||
172 | .sp | ||
173 | \fBstartfluxbox\fR | ||
174 | .SH "DESCRIPTION" | ||
175 | .sp | ||
176 | \fBstartfluxbox\fR is a script which runs the file \fB~/\&.fluxbox/startup\fR If it doesn\'t exist it will be generated\&. | ||
177 | .sp | ||
178 | \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\&. | ||
179 | .SH "FILES" | ||
180 | .PP | ||
181 | \fB~/\&.fluxbox/startup\fR | ||
182 | .RS 4 | ||
183 | 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\&. | ||
184 | .RE | ||
185 | .SH "ONLINE DOCUMENTATION" | ||
186 | .PP | ||
187 | More extensive documentation for \fBstartfluxbox(1)\fR can be found at: | ||
188 | .RS 4 | ||
189 | |||
190 | \m[blue]\fBhttp://www\&.xs4all\&.nl/~hanb/software/fluxbox/startfluxbox\&.html\fR\m[] | ||
191 | .RE | ||
192 | .SH "AUTHORS" | ||
193 | .sp | ||
194 | The author of \fBstartfluxbox(1)\fR is Han Boetes <\m[blue]\fBhan@fluxbox\&.org\fR\m[]\&\s-2\u[1]\d\s+2> | ||
195 | .sp | ||
196 | 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> | ||
197 | .SH "SEE ALSO" | ||
198 | .sp | ||
199 | fluxbox(1) | ||
200 | .SH "Notes" | ||
201 | .IP " 1." 4 | ||
202 | han@fluxbox.org | ||
203 | .RS 4 | ||
204 | \%mailto:han@fluxbox.org | ||
205 | .RE | ||
206 | .IP " 2." 4 | ||
207 | i.am@jimramsay.com | ||
208 | .RS 4 | ||
209 | \%mailto:i.am@jimramsay.com | ||
210 | .RE | ||