[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[RP] [PATCH] improve new manpage layout
From: |
Bernhard R. Link |
Subject: |
[RP] [PATCH] improve new manpage layout |
Date: |
Tue, 25 Mar 2014 12:56:39 +0100 |
User-agent: |
Mutt/1.5.23 (2014-03-12) |
Make everything to be typed in that way Ic, use Br* to denote
alternates, remove some spaces from variable names to make clearer
they are only one word.
---
doc/ratpoison.mdoc.1 | 80 ++++++++++++++++++++++++++--------------------------
1 file changed, 40 insertions(+), 40 deletions(-)
diff --git a/doc/ratpoison.mdoc.1 b/doc/ratpoison.mdoc.1
index e44b29a..9236d5e 100644
--- a/doc/ratpoison.mdoc.1
+++ b/doc/ratpoison.mdoc.1
@@ -140,25 +140,25 @@ whenever
is called.
Possible events are:
.Bl -tag -width Ds
-.It Ar deletewindow
+.It Ic deletewindow
Run after a window is withdrawn.
-.It Ar newwindow
+.It Ic newwindow
Run after a new window is mapped.
-.It Ar key
+.It Ic key
Run whenever a top level key is pressed (by default
.Ic C\-t ) .
-.It Ar quit
+.It Ic quit
Run before exiting
.Nm .
-.It Ar restart
+.It Ic restart
Run before restarting
.Nm .
-.It Ar switchframe
+.It Ic switchframe
Run after a frame actually switched, but before the window in it is
focused.
-.It Ar switchgroup
+.It Ic switchgroup
Run after selecting a new group.
-.It Ar switchwin
+.It Ic switchwin
Run after a new window is selected.
(With dedication, it may already be inactive again, if it was put into
another frame)
@@ -170,7 +170,7 @@ as new way to call
.Ar command .
.It Ic bind Ar key command
alias for
-.Qq Ic definekey Li root Ar key command
+.Qq Ic definekey root Ar key command
.It Ic banish
.Pq Ic C\-t b
Banish the rat cursor to the lower right corner of the screen.
@@ -250,7 +250,7 @@ I.e. instead of
better use the new
.Ic set Cm resizeunit
and so on...
-.It Ic dedicate Op Li 0 | 1
+.It Ic dedicate Brq Ic 0 | 1
Consider the current frame dedicated/chaste
.Pq Ql 1
or promiscuous
@@ -295,22 +295,22 @@ Update the default escape key to
.Ar key .
.Pp
Strictly speaking it updates the
-.Ic readkey Li root
+.Ic readkey root
command in the keymap
-.Li top
+.Ic top
to
.Ar key ,
the
.Ic other
binding
in
-.Li root
+.Ic root
to
.Ar key ,
and
.Ic meta
binding in
-.Li root
+.Ic root
to
.Ar key
without modifiers or
@@ -319,11 +319,11 @@ if
.Ar key
has no modifiers.
(If
-.Ic set Ar topkmap
+.Ic set topkmap
was called with an argument other than
-.Ar top
+.Ic top
that will be used instead of
-.Ar top . )
+.Ic top . )
.It Ic exchangedown Pq Ic C\-t C\-Down
Exchange the window in the current frame with the window in the frame
below the current frame.
@@ -437,7 +437,7 @@ Most window commands only see windows in the effective
group.
.It Ic gprev
Select the prior group.
Most window commands only see windows in the effective group.
-.It Ic gravity Op Li nw | w | sw | n | c | s | ne | e | se
+.It Ic gravity Brq Ic nw | w | sw | n | c | s | ne | e | se
Change how in its frame the current window is aligned.
.It Ic grename
Rename current group.
@@ -452,7 +452,7 @@ If the optional parameter
is given, list all keybindings in this keymap, otherwise list all key
bindings in keymap
.Li root .
-.It Ic hsplit Oo Ar l Ns Li / Ns Ar p | Oo Li \- Oc Ns Ar pixels Oc Pq Ic C\-t
S
+.It Ic hsplit Oo Ar l Ns Ic "\&/" Ns Ar p | Oo Ic "\&\-\&" Oc Ns Ar pixels Oc
Pq Ic C\-t S
Split the current frame into left frame and a right frame.
If no parameter is given, split in halves.
If two numbers separated by a slash
@@ -547,11 +547,11 @@ This keymap can be used to add new key-command mappings
to it with
.Ic definekey
and can be called with
.Ic readkey .
-.It Ic newwm Ar new window manager
+.It Ic newwm Ar new-window-manager
Quit
.Nm
and execute
-.Ar new window manager
+.Ar new-window-manager
instead.
.It Ic next Pq Ic C\-t Return | C\-t n | C\-t space
Switch to the next window in the current group.
@@ -605,7 +605,7 @@ relative to the current position.
Simulate a rat click with
.Ar button
(button 1=left button if none given).
-.It Ic rathold Li ( up | down ) Op Ar button
+.It Ic rathold Li Bro up | down Brc Op Ar button
Simulate pressing|releasing rat button
.Ar button
(1=left button if none given).
@@ -624,7 +624,7 @@ configuration: by pressing
which is the only key in the keymap
top ,
the command
-.Qq Ic readkey Ar root
+.Qq Ic readkey root
is executed.
The next key then executes the command in keymap
.Li root
@@ -712,7 +712,7 @@ Output the list of all screens.
The screens are separated by commas. Each screen is shown as 6 values:
its number, its x-coordinate, its y-coordinate, its width, its height
and if it is currently selected (1=true, 0=false).
-.It Ic select Li \- | Ar name | number Pq Ic C\-t \&'
+.It Ic select Bro Ic \- | Ar name | number Brc Pq Ic C\-t \&'
If a number is given, switch to the window with number
.Ar number .
If a name is given, switch to the window in the current group with
@@ -772,11 +772,11 @@ command.
Switch to the screen
.Ar screennumber .
(If you have multiple physical ones.)
-.It Ic startup_message Li on | off
+.It Ic startup_message Brq Ic on | off
Select whether
.Nm
will show a startup message or not.
-.It Ic swap Oo Ar dest-frame Oo Ar src-frame Oc Oc Pq Ic C\-t x
+.It Ic swap Ar dest-frame Oo Ar src-frame Oc Pq Ic C\-t x
Exchange the window in
.Ar src\-frame
(or the current frame if there is no second argument) with the window
@@ -832,7 +832,7 @@ Spawn a shell executing
after showing a message with the command.
.It Ic version Pq Ic C\-t v
Output version and compile time information.
-.It Ic vsplit Oo Ar l Ns Li / Ns Ar p | "pixels from top" | "\-pixels from
bottom" Oc Pq Ic C\-t s
+.It Ic vsplit Oo Ar l Ns Li Ic / Ns Ar p | "pixels-from-top" | Ic "\&\-\&" Ns
Ar "pixels-from-bottom" Oc Pq Ic C\-t s
Split the current frame into upper frame and a lower frame.
If no parameter is given, split in halves.
If two numbers separated by a slash
@@ -848,13 +848,13 @@ times the
th
part of the prior height.
Otherwise the lower one is
-.Ar "pixels from bottom"
+.Ar "pixels-from-bottom"
wide or the upper one
-.Ar "pixels from top"
+.Ar "pixels-from-top"
high, depending whether there is a
.Dq Li \-
in front of the number or not.
-.It Ic warp Op Li on | off
+.It Ic warp Brq Ic on | off
Select if focusing a window moves the rat cursor to the place it had been last
time this window was focused, or not.
.It Ic windows Oo Ar format Oc Pq Ic C\-t w
@@ -962,7 +962,7 @@ can undo with the
command.
.Pp
Default is 20.
-.It Cm wingravity Li nw | w | sw | n | c | s | ne | e | se
+.It Cm wingravity Brq Ic nw | w | sw | n | c | s | ne | e | se
Set the default gravity new normal windows will get.
Possible values are the same as in the
.Ic gravity
@@ -971,7 +971,7 @@ points or numbers 1 to 9.
.Pp
Default is
.Li nw .
-.It Cm maxsizegravity Li nw | w | sw | n | c | s | ne | e | se
+.It Cm maxsizegravity Brq Ic nw | w | sw | n | c | s | ne | e | se
Set the default gravity new self-maximized windows will get.
Possible values are the same as in the
.Ic gravity
@@ -980,7 +980,7 @@ points or numbers 1 to 9.
.Pp
Default is
.Li c .
-.It Cm transgravity Li nw | w | sw | n | c | s | ne | e | se
+.It Cm transgravity Brq Ic nw | w | sw | n | c | s | ne | e | se
Set the default gravity new transient windows will get.
Possible values are the same as in the
.Ic gravity
@@ -989,7 +989,7 @@ points or numbers 1 to 9.
.Pp
Default is
.Li c .
-.It Cm bargravity Li nw | w | sw | n | c | s | ne | e | se
+.It Cm bargravity Brq Ic nw | w | sw | n | c | s | ne | e | se
Select the location where message and prompt bars appear.
.Pp
Default is
@@ -1022,7 +1022,7 @@ Determine the width of the input window.
.Pp
Default is
.Li 200 .
-.It Cm barinpadding Li 0 | 1
+.It Cm barinpadding Brq Ic 0 | 1
If there is padding, determines whether the bar appears at the edge of
the screen
.Pq Li 1
@@ -1040,7 +1040,7 @@ grabs directly.
.Pp
The default value is
.Li top .
-.It Cm waitcursor Li 0 | 1
+.It Cm waitcursor Brq Ic 0 | 1
Determine whether to change the rat cursor when waiting for a key
.Pq Li 1
or not
@@ -1059,7 +1059,7 @@ command.
.Pp
Default is
.Li %n%s%t .
-.It Cm winname Li title | name | class
+.It Cm winname Brq Ic title | name | class
Choose what is considered the "name" of the window by
.Nm :
.Pp
@@ -1108,7 +1108,7 @@ and vertical padding to
.Pp
Default is
.Li 4 0 .
-.It Cm winliststyle Li row | column
+.It Cm winliststyle Brq Ic row | column
Determines whether windows are shown in rows or in columns.
.Pp
Default is column.
@@ -1127,14 +1127,14 @@ Specify maximum number of values kept in input history.
.Pp
Default is
.Li 20 .
-.It Cm historycompaction Li 0 | 1
+.It Cm historycompaction Brq Ic 0 | 1
Decide if new input lines added to history delete
older equal lines from history.
.Pp
Default is
.Li 1
(on).
-.It Cm historyexpansion Li 0 | 1
+.It Cm historyexpansion Brq Ic 0 | 1
Decide if history expansion using ! is available.
(Can only be activated when compiled with readline's libhistory.)
.Pp
--
1.9.0
Bernhard R. Link
--
F8AC 04D5 0B9B 064B 3383 C3DA AFFC 96D1 151D FFDC
- [RP] [PATCH] improve new manpage layout,
Bernhard R. Link <=