Escape html tags in man page

This commit is contained in:
project-repo 2023-12-27 20:41:52 +01:00
commit 15f9eaa6f7

View file

@ -28,8 +28,8 @@ on modes.
*abort*
Return to default mode
*background <r> <g> <b>*
Set RGB of background - <[r|g|b]> are floating point numbers
*background <r\> <g\> <b\>*
Set RGB of background - <[r|g|b]\> are floating point numbers
between 0 and 1.
There is no support for background images.
@ -38,8 +38,8 @@ on modes.
background 1.0 0.0 0.0
```
*bind <key> <command>*
Bind <key> to execute <command> if pressed in root mode
*bind <key\> <command\>*
Bind <key\> to execute <command\> if pressed in root mode
```
bind <key> <command>
@ -51,17 +51,17 @@ definekey root <key> <command>
Close current window - This may be useful for windows of
applications which do not offer any method of closing them.
*configure_message [font <font description>|[f|b]g_color <r> <g> b> <a>|display_time <n>|anchor <position>]*
*configure_message [font <font description\>|[f|b]g_color <r\> <g\> <b\> <a\>|display_time <n\>|anchor <position\>]*
Configure message characteristics -
- font <font description> sets the font of the message.
Here, <font description> is either
- font <font description\> sets the font of the message.
Here, <font description\> is either
- an X core font description or
- a FreeType font description via pango
- fg_color <r> <g> <b> <a> sets the RGBA of the foreground
- bg_color <r> <g> <b> <a> sets the RGBA of the background
- display_time <n> sets the display time in seconds
- anchor <position> sets the position of the message.
<position> may be one of {top,bottom}\_{left,center,right} or center.
- fg_color <r\> <g\> <b\> <a\> sets the RGBA of the foreground
- bg_color <r\> <g\> <b\> <a\> sets the RGBA of the background
- display_time <n\> sets the display time in seconds
- anchor <position\> sets the position of the message.
<position\> may be one of {top,bottom}\_{left,center,right} or center.
```
# Set font
@ -86,20 +86,20 @@ configure_message display_time 4
This simply hides the cursor. Pointing and clicking is
still possible.
*custom_event <message>*
*custom_event <message\>*
Send a custom event to the IPC socket
This sends an event of type "custom_event" to all programs
listening to the IPC socket along with the string <message>.
listening to the IPC socket along with the string <message\>.
See *cagebreak-socket(7)* for more details.
*definekey <mode> <key> <command>*
Bind <key> to execute <command> if pressed in <mode> -
*definekey <mode\> <key\> <command\>*
Bind <key\> to execute <command\> if pressed in <mode\> -
*definekey* is a more general version of *bind*.
*definemode <mode>*
Define new mode <mode> - After a call to *definemode*,
<mode> can be used with *definekey* to create a custom key mapping.
*definemode <mode\>*
Define new mode <mode\> - After a call to *definemode*,
<mode\> can be used with *definekey* to create a custom key mapping.
```
# define new mode and create a mapping for it
@ -110,8 +110,8 @@ definekey foo C-t abort
*dump*
Triggers the *dump* event, see *cagebreak-socket(7)* for details
*escape <key>*
Set <key> to switch to root mode to execute one command
*escape <key\>*
Set <key\> to switch to root mode to execute one command
```
escape <key>
@ -131,8 +131,8 @@ definekey top <key> mode root
*exchangeup*
Exchange current window with window in the tile to the top
*exec <command>*
Execute <command> using *sh -c*
*exec <command\>*
Execute <command\> using *sh -c*
*focus*
Focus next tile
@ -155,10 +155,10 @@ definekey top <key> mode root
*hsplit*
Split current tile horizontally
*input <identifier> <setting> <value>*
Set <setting> to <value> for device <identifier> -
<identifier> can be "\*" (wildcard), of the form
"type:<device_type>" or the identifier of the device as printed
*input <identifier\> <setting\> <value\>*
Set <setting\> to <value\> for device <identifier\> -
<identifier\> can be "\*" (wildcard), of the form
"type:<device_type\>" or the identifier of the device as printed
for example by *cagebreak -s*. The supported input types are
- touchpad
- pointer
@ -175,7 +175,7 @@ definekey top <key> mode root
*accel_profile adaptive|flat*
Set pointer acceleration profile for specified input device
*calibration_matrix <6 space-separated floating point values>*
*calibration_matrix <6 space-separated floating point values\>*
Set calibration matrix
*click_method none|button_areas|clickfinger*
@ -208,26 +208,26 @@ definekey top <key> mode root
Enable or disable natural (inverted) scrolling for specified
input device
*pointer_accel [<-1|1>]*
*pointer_accel [<-1|1\>]*
Change the pointer acceleration for specified input device
*scroll_button disable|<event-code-or-name>*
*scroll_button disable|<event-code-or-name\>*
Set button used for scroll_method on_button_down - The button
can be given as an event name or code, which can be obtained from
*libinput debug-events*. If set to _disable_, it disables the
scroll_method on_button_down.
*scroll_factor <floating point value>*
*scroll_factor <floating point value\>*
Change the scroll factor for the specified input device - Scroll
speed will be scaled by the given value, which must be non-negative.
*scroll_method none|two_finger|edge|on_button_down*
Change scroll method for specified input device
*repeat_delay <n>*
*repeat_delay <n\>*
Repeat delay in ms for keyboards only
*repeat_rate <n>*
*repeat_rate <n\>*
Repeat rate in 1/s for keyboards only
*tap enabled|disabled*
@ -239,11 +239,11 @@ definekey top <key> mode root
middle click. _lmr_ treats 1 finger as left click, 2 fingers as
middle click, and 3 fingers as right click.
message <text>
message <text\>
Display a line of arbitrary text.
*mode <mode>*
Enter mode "<mode>" - Returns to default mode, after a command is
*mode <mode\>*
Enter mode "<mode\>" - Returns to default mode, after a command is
executed.
*movetonextscreen*
@ -254,12 +254,12 @@ message <text>
Move currently focused window to previous screen
See *output* for differences between screen and output.
*movetoscreen <n>*
Move currently focused window to <n>-th screen
*movetoscreen <n\>*
Move currently focused window to <n\>-th screen
See *output* for differences between screen and output.
*movetoworkspace <n>*
Move currently focused window to <n>-th workspace
*movetoworkspace <n\>*
Move currently focused window to <n\>-th workspace
See *output* for differences between screen and output.
*next*
@ -272,32 +272,32 @@ message <text>
*only*
Remove all splits and make current window fill the entire screen
*output <name> [[pos <xpos> <ypos> res <width>x<height> rate <rate> [scale <scale>]] | enable | disable | [permanent|peripheral] | prio <n> | rotate <n>]*
Configure output "<name>" -
- <xpos> and <ypos> are the position of the
*output <name\> [[pos <xpos\> <ypos\> res <width\>x<height\> rate <rate\> [scale <scale\>]] | enable | disable | [permanent|peripheral] | prio <n\> | rotate <n\>]*
Configure output "<name\>" -
- <xpos\> and <ypos\> are the position of the
monitor in pixels. The top-left monitor should have the coordinates 0 0.
- <width> and <height> specify the resolution in pixels.
- <rate> sets the refresh rate of the monitor (often this is 50 or 60).
- <scale> sets the output scale (default is 1.0)
- enable and disable enable or disable <name>. Note that if
<output> is the only enabled output, *output <output> disable* has
- <width\> and <height\> specify the resolution in pixels.
- <rate\> sets the refresh rate of the monitor (often this is 50 or 60).
- <scale\> sets the output scale (default is 1.0)
- enable and disable enable or disable <name\>. Note that if
<output\> is the only enabled output, *output <output\> disable* has
no effect.
- permanent sets <name> to persist even on disconnect. When
- permanent sets <name\> to persist even on disconnect. When
the physical monitor is disconnected, the output is
maintained and operates identically to the attached monitor. On reconnect,
the monitor operates as though it was never disconnected. Setting the
output role to peripheral when the monitor is disconnected,
destroys the output, as if the monitor were disconnected.
- peripheral sets the role of <name> to peripheral, meaning that on
- peripheral sets the role of <name\> to peripheral, meaning that on
disconnecting the respective monitor, all views will be moved to another
available output. The default role is peripheral.
- prio <n> is used to set the priority of an output. If
- prio <n\> is used to set the priority of an output. If
nothing else is set, outputs are added as they request to be added
and have a numerical priority of -1. Using prio <n> it is possible
to set priorities for outputs, where <n> >= 1. The larger <n> is,
and have a numerical priority of -1. Using prio <n\> it is possible
to set priorities for outputs, where <n\> >= 1. The larger <n\> is,
the higher the priority is, that is to say, the earlier the output
will appear in the list of outputs.
- rotate <n> is used to rotate the output by `<n> mod 4 x 90` degrees
- rotate <n\> is used to rotate the output by `<n> mod 4 x 90` degrees
counter-clockwise.
```
@ -343,19 +343,19 @@ output DP-1 rotate 3
*resizeup*
Resize current tile towards the top
*screen <n>*
Change to <n>-th screen
*screen <n\>*
Change to <n\>-th screen
See *output* for differences between screen and output.
*show_info*
Display information about the current setup - In particular, print the identifiers
of the available inputs and outputs.
*setmode <mode>*
Set default mode to <mode>
*setmode <mode\>*
Set default mode to <mode\>
*switchvt <n>*
Switch to tty <n>
*switchvt <n\>*
Switch to tty <n\>
*time*
Display time
@ -363,11 +363,11 @@ output DP-1 rotate 3
*vsplit*
Split current tile vertically
*workspace <n>*
Change to <n>-th workspace
*workspace <n\>*
Change to <n\>-th workspace
*workspaces <n>*
Set number of workspaces to <n> - <n> is a single integer larger than 1
*workspaces <n\>*
Set number of workspaces to <n\> - <n\> is a single integer larger than 1
and less than 30.
# MODES
@ -396,7 +396,7 @@ Keys are specified by their names as displayed for example by *xev*.
Modifiers can be specified using the following syntax:
<mod>-<key>
<mod\>-<key\>
The supported modifiers are: