aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-09-08 17:17:29 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-09-08 17:41:00 +0000
commiteb6737ca2593f457368ae16e920911cdd70a2e33 (patch)
treef8dbf85542613c15d50439255d99db4e3d90ef25 /doc
parentchangelog: move deprecation section up first, change most ‘footrc’ -> ‘foot.ini’ (diff)
Add -W,--window-size-chars, and foot.ini:initial-window-size-chars
* Add -W,--window-size-chars command line option * Add initial-window-size-chars foot.ini option * Add -w,--window-size-pixels command line option * Add initial-window-size-pixels foot.ini option * Deprecate -g,--geometry command line option in favor of -w,--window-size-pixels * Deprecate geometry option in foot.ini in favor of initial-window-size-pixels
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd8
-rw-r--r--doc/foot.ini.5.scd18
2 files changed, 21 insertions, 5 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index 19e1b0ee..c8fbddc7 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -45,8 +45,14 @@ the foot command line
Default: _monospace_.
+*-w*,*--window-size-pixels*=_WIDTHxHEIGHT_
+ Set initial window width and height, in pixels. Default: _700x500_.
+
+*-W*,*--window-size-chars*=_WIDTHxHEIGHT_
+ Set initial window width and height, in characters. Default: _not set_.
+
*-g*,*--geometry*=_WIDTHxHEIGHT_
- Set initial window width and height. Default: *700x500*.
+ Deprecated. Alias for *-w*,*--window-size-pixels*.
*-t*,*--term*=_TERM_
Value to set the environment variable *TERM* to. Default: _foot_.
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 81e3f945..25a40e45 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -35,18 +35,28 @@ in this order:
Default: _monospace_.
-*geometry*
- Initial window width and height in pixels (subject to output
- scaling), on the form _WIDTHxHEIGHT_. Default: _700x500_.
-
*pad*
Padding between border and glyphs, in pixels (subject to output
scaling), on the form _XxY_. Default: _2x2_.
+*initial-window-size-pixels*
+ Initial window width and height in _pixels_ (subject to output
+ scaling), on the form _WIDTHxHEIGHT_. The height _includes_ the
+ titlebar when using CSDs. Mutually exclusive to
+ *initial-window-size-chars*. Default: _700x500_.
+
+*initial-window-size-chars*
+ Initial window width and height in _characters_, on the form
+ _WIDTHxHEIGHT_. Mutually exclusive to
+ *initial-window-size-pixels*. Default: _not set_.
+
*initial-window-mode*
Initial window mode for each newly spawned window: *windowed*,
*maximized* or *fullscreen*. Default: _windowed_.
+*geometry*
+ Deprecated. Alias for *initial-window-size-pixels*.
+
*shell*
Executable to launch. Typically a shell. Default: _$SHELL_ if set,
otherwise the user's default shell (as specified in