From 9855d18ba775c944ba4cae16ba5b39c97e5954c3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Mon, 12 Aug 2019 20:00:09 +0200
Subject: [PATCH] doc: add foot.5 (configuration)

---
 doc/foot.1.scd  |  9 ++++++
 doc/foot.5.scd  | 81 +++++++++++++++++++++++++++++++++++++++++++++++++
 doc/meson.build |  2 +-
 3 files changed, 91 insertions(+), 1 deletion(-)
 create mode 100644 doc/foot.5.scd

diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index 9b02571f..d1bbfd61 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -27,3 +27,12 @@ list of font name and font options.
 _Examples_:
 - Dina:weight=bold:slant=italic
 - Arial:size=12
+
+
+# CONFIGURATION
+
+See *foot*(5)
+
+# SEE ALSO
+
+*foot*(5)
diff --git a/doc/foot.5.scd b/doc/foot.5.scd
new file mode 100644
index 00000000..ee1fb88e
--- /dev/null
+++ b/doc/foot.5.scd
@@ -0,0 +1,81 @@
+foot(5)
+
+# NAME
+foot - configuration file
+
+# DESCRIPTION
+
+*foot* uses the standard _unix configuration format_, with section based
+key/value pairs. The default section is unnamed (i.e. not prefixed
+with a _[section]_).
+
+foot will search for a configuration file in the following locations,
+in this order:
+
+- _XDG_CONFIG_HOME/footrc_
+- _~/.config/footrc_
+
+# SECTION: default
+
+*font*
+	Font and style to use, in fontconfig format. See *FONT
+	FORMAT*. Default: _monospace_.
+
+*shell*
+	Executable to launch. Typically a shell. Default: the user's
+	default shell (as specified in _/etc/passwd_).
+
+*term*
+	Value to set the environment variable *TERM* to. Default: _foot_.
+
+*scrollback*
+	Number of scrollback lines. Default: _1000_.
+
+*workers*
+	Number of threads to use for rendering. Default: the number of
+	available logical CPUs (including SMT). Note that this is not
+	always the best value. In some cases, the number of physical
+	_cores_ is better.
+
+
+# SECTION: cursor
+
+*style*
+	Configures the default cursor style, and is One of: _block_, _bar_
+	or _underline_. Default: _block_.
+
+*color*
+	Two RRGGBB values specifying the foreground (text) and background
+	(cursor) colors for the cursor. Default: inversed foreground and
+	background colors. Note that this value only applies to the block
+	cursor. The other cursor styles are always rendered with the
+	foreground color.
+
+# SECTION: colors
+
+*foreground*
+	Default RRGGBB foreground color. This is the color used when no
+	ANSI color is being used. Default: _dcdccc_.
+
+*background*
+	Default RRGGBB background color. This is the color used when no
+	ANSI color is being used. Default: _111111_.
+
+*regular0*, *regular1* *..* *regular7*
+	The eight basic ANSI colors. Default: _000000_, _cc9393_,
+	_7f9f7f_, _d0bf8f_, _6ca0a3_, _dc8cc3_, _93e0e3_ and _dcdccc_ (a
+	variant of the _zenburn_ theme).
+
+*bright0*, *bright1* *..* *bright7*
+	The eight bright ANSI colors. Default: _000000_, _dca3a3_,
+	_bfebbf_, _f0dfaf_, _8cd0d3_, _dc8cc3_, _93e0e3_ and _ffffff_ (a
+	variant of the _zenburn_ theme).
+
+# FONT FORMAT
+
+The font is specified in FontConfig syntax. That is, a colon-separated
+list of font name and font options.
+
+_Examples_:
+- Dina:weight=bold:slant=italic
+- Arial:size=12
diff --git a/doc/meson.build b/doc/meson.build
index b61adbc1..01738d43 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -1,7 +1,7 @@
 scdoc = dependency('scdoc', native: true)
 scdoc_prog = find_program(scdoc.get_pkgconfig_variable('scdoc'), native: true)
 
-foreach man_src : ['foot.1.scd']
+foreach man_src : ['foot.1.scd', 'foot.5.scd']
   parts = man_src.split('.')
   name = parts[-3]
   section = parts[-2]