diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/foot.1.scd | 2 | ||||
| -rw-r--r-- | doc/foot.5.scd | 55 |
2 files changed, 53 insertions, 4 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd index 8b5268b7..5b3c07cc 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -31,7 +31,7 @@ execute (instead of the shell). Default: _monospace_. *-g*,*--geometry*=_WIDTHxHEIGHT_ - Set initial window width and height. + Set initial window width and height. Default: *700x500*. *-t*,*--term*=_TERM_ Value to set the environment variable *TERM* to. Default: *foot*. diff --git a/doc/foot.5.scd b/doc/foot.5.scd index 41785366..edfecc27 100644 --- a/doc/foot.5.scd +++ b/doc/foot.5.scd @@ -41,9 +41,10 @@ in this order: _XxY_ (-padding). *shell* - Executable to launch. Typically a shell. Default: the user's - default shell (as specified in _/etc/passwd_). You can also pass - arguments. For example "/bin/bash --norc". + Executable to launch. Typically a shell. Default: _$SHELL_ if set, + otherwise the user's default shell (as specified in + _/etc/passwd_). You can also pass arguments. For example + "/bin/bash --norc". *login-shell* Start a login shell, by prepending a '-' to argv[0]. Default: _no_. @@ -63,6 +64,9 @@ in this order: # SECTION: cursor +This section controls the cursor style and color. Note that +applications can change these runtime. + *style* Configures the default cursor style, and is one of: _block_, _bar_ or _underline_. Default: _block_. @@ -76,6 +80,13 @@ in this order: # SECTION: colors +This section controls the 16 ANSI colors and the default foreground +and background colors. Note that applications can change these runtime. + +The colors are in RRGGBB format. That is, they do *not* have an alpha +component. You can configure the background transparency with the +_alpha_ option. + *foreground* Default RRGGBB foreground color. This is the color used when no ANSI color is being used. Default: _dcdccc_. @@ -98,6 +109,44 @@ in this order: Background translucency. A value in the range 0.0-1.0, where 0.0 means completely transparent, and 1.0 is opaque. Default: _1.0_. +# SECTION: csd + +This section controls the look of the _CSDs_ (Client Side +Decorations). Note that the default is to *not* use CSDs, but instead +to use _SSDs_ (Server Side Decorations) when the compositor supports +it. + +Note that unlike the colors defined in the _colors_ section, the color +values here are in AARRGGBB format. I.e. they contain an alpha +component. + +*preferred* + Which type of window decorations to prefer: *client* (CSD) or + *server* (SSD). Note that this is only a hint to the + compositor. Depending on the compositor's configuration and + capabilities, it may not have any effect. Default: _server_. + +*size* + Height, in pixels (subject to output scaling), of the + titlebar. Default: _26_. + +*color* + Titlebar AARRGGBB color. Default: use the default _foreground_ + color. + +*button-width* + Width, in pixels (subject to output scaling), of the + minimize/maximize/close buttons. Default: _26_. + +*button-minimize-color* + Minimize button's AARRGGBB color. Default: _ff1e90ff_. + +*button-maximize-color* + Maximize button's AARRGGBB color. Default: _ff30ff30_. + +*button-close-color* + Close button's AARRGGBB color. Default: _ffff3030_. + # FONT FORMAT The font is specified in FontConfig syntax. That is, a colon-separated |
