aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMathias Gumz <akira at fluxbox dot org>2011-03-18 15:31:49 (GMT)
committerMathias Gumz <akira at fluxbox dot org>2011-03-18 15:31:49 (GMT)
commit7658d2c56d24a18d61a9ac2c14ef1ff0fd55d3bf (patch)
treec6e08a983c472292dbbe3285f0fdcdba9157f69b /doc
parent253f13d46ed96dd9a4ed8619820d14098d547fc8 (diff)
downloadfluxbox-7658d2c56d24a18d61a9ac2c14ef1ff0fd55d3bf.zip
fluxbox-7658d2c56d24a18d61a9ac2c14ef1ff0fd55d3bf.tar.bz2
fix some escaping problems in the man pages
Diffstat (limited to 'doc')
-rw-r--r--doc/asciidoc/fluxbox.txt37
-rw-r--r--doc/asciidoc/startfluxbox.txt8
2 files changed, 23 insertions, 22 deletions
diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt
index 4553e48..4a76096 100644
--- a/doc/asciidoc/fluxbox.txt
+++ b/doc/asciidoc/fluxbox.txt
@@ -74,7 +74,7 @@ OPTIONS
74 Starting fluxbox with this option will designate a file in which you 74 Starting fluxbox with this option will designate a file in which you
75 want to log events to. 75 want to log events to.
76*-rc* 'rcfile':: 76*-rc* 'rcfile'::
77 Use a different config file other than the default *\~/.fluxbox/init*. 77 Use a different config file other than the default *~/.fluxbox/init*.
78*-v*, *-version*:: 78*-v*, *-version*::
79 The version of fluxbox installed. 79 The version of fluxbox installed.
80*-screen* all|'scr','scr'...:: 80*-screen* all|'scr','scr'...::
@@ -94,7 +94,7 @@ variables that can be set when starting fluxbox. To actually call fluxbox and
94begin using it, you should place ``exec startfluxbox'' in your *\~/.xinitrc* as 94begin using it, you should place ``exec startfluxbox'' in your *\~/.xinitrc* as
95the last executed command. This is assuming that the location of *fluxbox(1)* 95the last executed command. This is assuming that the location of *fluxbox(1)*
96and *startfluxbox(1)* are in your shell's $PATH. Also note that you may need to 96and *startfluxbox(1)* are in your shell's $PATH. Also note that you may need to
97create the *\~/.xinitrc* file or your setup may use *\~/.xsession* instead, 97create the *\~/.xinitrc* file or your setup may use *~/.xsession* instead,
98depending on your X setup. Some X login managers like *gdm(1)* or *kdm(1)* may 98depending on your X setup. Some X login managers like *gdm(1)* or *kdm(1)* may
99simply provide a ``Fluxbox'' session for you without having to alter any 99simply provide a ``Fluxbox'' session for you without having to alter any
100settings. 100settings.
@@ -105,7 +105,7 @@ file location, this is where you can provide a system-wide menu file for your
105users. 105users.
106 106
107On exit or restart, fluxbox will save user defaults in the file 107On exit or restart, fluxbox will save user defaults in the file
108*\~/.fluxbox/init*. Resources in this file can also be edited by hand, see the 108*~/.fluxbox/init*. Resources in this file can also be edited by hand, see the
109*RESOURCES* section for more details. *fluxbox(1)* also has many tools to edit 109*RESOURCES* section for more details. *fluxbox(1)* also has many tools to edit
110these; look through the main menu once fluxbox has started to find different 110these; look through the main menu once fluxbox has started to find different
111ways of managing your session. 111ways of managing your session.
@@ -250,7 +250,7 @@ Keyboard bindings:
250 250
251- *ALT+Tab* / *ALT+Shift+Tab*: Cycle through windows 251- *ALT+Tab* / *ALT+Shift+Tab*: Cycle through windows
252- *WIN+Tab* / *WIN+Shift+Tab*: Cycle through tabs 252- *WIN+Tab* / *WIN+Shift+Tab*: Cycle through tabs
253- *Win+1* -> *Win+9*: Select the 1st -> 9th tab in the current window 253- *WIN+1* - *WIN+9*: Select the 1st -> 9th tab in the current window
254- *ALT+F1*: Run *xterm(1)* to open a new terminal 254- *ALT+F1*: Run *xterm(1)* to open a new terminal
255- *ALT+F2*: Run *fbrun(1)* for a small ``run program'' dialog 255- *ALT+F2*: Run *fbrun(1)* for a small ``run program'' dialog
256- *ALT+F4*: Close the current window 256- *ALT+F4*: Close the current window
@@ -262,12 +262,12 @@ Keyboard bindings:
262- *CTRL+ALT+Del*: Exit fluxbox (log out) 262- *CTRL+ALT+Del*: Exit fluxbox (log out)
263- *CTRL+ALT+Left* / *CTRL+ALT+Right*: Go to the previous/next workspace 263- *CTRL+ALT+Left* / *CTRL+ALT+Right*: Go to the previous/next workspace
264- *WIN+Left* / *WIN+Right*: Send the current window to the previous/next 264- *WIN+Left* / *WIN+Right*: Send the current window to the previous/next
265 workspace, but remain on this workspace 265 workspace, but remain on this workspace
266- *CTRL+WIN+Left* / *CTRL+WIN+Right*: Take the current window to the previous/next 266- *CTRL+WIN+Left* / *CTRL+WIN+Right*: Take the current window to the previous/next
267 workspace, and switch to that workspace 267 workspace, and switch to that workspace
268- *CTRL+F1* -> *CTRL+F12*: Switch to the 1st -> 12th workspace 268- *CTRL+F1* - *CTRL+F12*: Switch to the 1st -> 12th workspace
269- *WIN+F1* -> *WIN+F12*: Send the current window to a specific workspace 269- *WIN+F1* - *WIN+F12*: Send the current window to a specific workspace
270- *CTRL+WIN+F1* -> *CTRL+WIN+F12*: Take the current window to a specific workspace 270- *CTRL+WIN+F1* - *CTRL+WIN+F12*: Take the current window to a specific workspace
271 271
272MENUS 272MENUS
273----- 273-----
@@ -310,7 +310,7 @@ item with the items detailed below:
310 310
311*User Styles*::: 311*User Styles*:::
312 This is where your custom styles are listed. It will list any styles from 312 This is where your custom styles are listed. It will list any styles from
313 *\~/.fluxbox/styles/*, which may be styles you grab from the Internet, or 313 *~/.fluxbox/styles/*, which may be styles you grab from the Internet, or
314 your own custom styles, provided you follow the standards described in 314 your own custom styles, provided you follow the standards described in
315 *fluxbox-style(5)*. 315 *fluxbox-style(5)*.
316 316
@@ -741,7 +741,7 @@ The default installation of fluxbox provides some of these style files. See
741Style Overlay 741Style Overlay
742~~~~~~~~~~~~~ 742~~~~~~~~~~~~~
743In addition to the style file, the overlay file, whose location is specified by 743In addition to the style file, the overlay file, whose location is specified by
744*session.screen0.styleOverlay* (default: *\~/.fluxbox/overlay*) can be used to 744*session.screen0.styleOverlay* (default: *~/.fluxbox/overlay*) can be used to
745set style resources that override all styles. For more information about which 745set style resources that override all styles. For more information about which
746parts of fluxbox can be controlled by the overlay file, see *fluxbox-style(5)*. 746parts of fluxbox can be controlled by the overlay file, see *fluxbox-style(5)*.
747 747
@@ -755,7 +755,7 @@ own; instead they are framed in the slit, and they are always visible in the
755current workspace. 755current workspace.
756 756
757Most dockable applications use the -w option to run in the slit. For example, 757Most dockable applications use the -w option to run in the slit. For example,
758you could put in your *\~/.fluxbox/startup*: 758you could put in your *~/.fluxbox/startup*:
759 759
760.............. 760..............
761bbmail -w & 761bbmail -w &
@@ -803,21 +803,22 @@ All changes take effect immediately. Here are the settings:
803 slit. You are able to hide apps from the slit by unselecting them in the 803 slit. You are able to hide apps from the slit by unselecting them in the
804 list showing. This will not kill the app. You can make them re-appear by 804 list showing. This will not kill the app. You can make them re-appear by
805 selecting them in the list. The "Save SlitList" option saves the new order 805 selecting them in the list. The "Save SlitList" option saves the new order
806 to you slitlist located in *\~/.fluxbox/slitlist*. See the next section for 806 to you slitlist located in *~/.fluxbox/slitlist*. See the next section for
807 details. 807 details.
808 808
809Slitlist File 809Slitlist File
810~~~~~~~~~~~~~ 810~~~~~~~~~~~~~
811fluxbox's slitlist file is available for those that use dockapps in the slit. 811fluxbox's slitlist file is available for those that use dockapps in the slit.
812This file helps fluxbox keep track of the *order* of the dockapps when in the 812This file helps fluxbox keep track of the *order* of the dockapps when in the
813slit. The file is generally located at *\~/.fluxbox/slitlist*. 813slit. The file is generally located at *~/.fluxbox/slitlist*.
814 814
815A simple procedure for getting the slit sequences the way you like it is: 815A simple procedure for getting the slit sequences the way you like it is:
8161. Run fluxbox with no pre-loaded dockapps 8161. Run fluxbox with no pre-loaded dockapps
8172. Run dockapps individually in the order you want them 8172. Run dockapps individually in the order you want them
8183. Add dockapps to your *startfluxbox(1)* script 8183. Add dockapps to your *startfluxbox(1)* script
819 819
820This sequence will be saved by default to *\~/.fluxbox/slitlist* and will be 820
821This sequence will be saved by default to *~/.fluxbox/slitlist* and will be
821remembered for future instances of fluxbox. 822remembered for future instances of fluxbox.
822 823
823Users are free to manually edit the slitlist file. It is a simple list of window 824Users are free to manually edit the slitlist file. It is a simple list of window
@@ -852,7 +853,7 @@ method is described in *fluxbox-apps(5)*.
852 853
853RESOURCES 854RESOURCES
854--------- 855---------
855Usually the *\~/.fluxbox/init* resource file is created and maintained by 856Usually the *~/.fluxbox/init* resource file is created and maintained by
856fluxbox itself. You can use the *Configure Menu*, mentioned above, to set most 857fluxbox itself. You can use the *Configure Menu*, mentioned above, to set most
857of these options. However, we'll cover all of the resource options that are 858of these options. However, we'll cover all of the resource options that are
858available to the user. If you edit this file while fluxbox is running, you must 859available to the user. If you edit this file while fluxbox is running, you must
@@ -1185,7 +1186,7 @@ Default right: *Shade Minimize Maximize Close*
1185 1186
1186All of the 'location' resources following require a pathname to their specific 1187All of the 'location' resources following require a pathname to their specific
1187files. This is where you can specify different files. Most of the defaults will 1188files. This is where you can specify different files. Most of the defaults will
1188be located in the user's *\~/.fluxbox* directory. 1189be located in the user's *~/.fluxbox* directory.
1189 1190
1190*session.appsFile*: 'location':: 1191*session.appsFile*: 'location'::
1191 Location of persistent application settings, or the `apps' file. See the 1192 Location of persistent application settings, or the `apps' file. See the
@@ -1218,7 +1219,7 @@ be located in the user's *\~/.fluxbox* directory.
1218 1219
1219*session.screen0.windowMenu*: 'location'::: 1220*session.screen0.windowMenu*: 'location':::
1220This optionally specifies the location of a user-defined window menu. If left 1221This optionally specifies the location of a user-defined window menu. If left
1221blank, it will use *\~/.fluxbox/windowmenu*. 1222blank, it will use *~/.fluxbox/windowmenu*.
1222+ 1223+
1223Default: *blank* 1224Default: *blank*
1224 1225
diff --git a/doc/asciidoc/startfluxbox.txt b/doc/asciidoc/startfluxbox.txt
index c61ef6a..789af08 100644
--- a/doc/asciidoc/startfluxbox.txt
+++ b/doc/asciidoc/startfluxbox.txt
@@ -16,22 +16,22 @@ SYNOPSIS
16 16
17DESCRIPTION 17DESCRIPTION
18----------- 18-----------
19*startfluxbox* is a script which runs the file *\~/.fluxbox/startup* If it 19*startfluxbox* is a script which runs the file *~/.fluxbox/startup* If it
20doesn't exist it will be generated. 20doesn't exist it will be generated.
21 21
22*startfluxbox* should be started from your *\~/.xinitrc* if you use startx, or 22*startfluxbox* should be started from your *\~/.xinitrc* if you use startx, or
23*\~/.xsession* if you run a display manager, like xdm. 23 *~/.xsession* if you run a display manager, like xdm.
24 24
25FILES 25FILES
26----- 26-----
27*\~/.fluxbox/startup*:: 27*~/.fluxbox/startup*::
28 This file contains all commands that should be executed before fluxbox is 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 29 started. The initial file contains helpful comments for beginners. It also
30 starts fluxbox. 30 starts fluxbox.
31 31
32EXAMPLES 32EXAMPLES
33-------- 33--------
34The default *\~/.fluxbox/startup* is as follows: 34The default *~/.fluxbox/startup* is as follows:
35.... 35....
36#!/bin/sh 36#!/bin/sh
37# 37#