Bump version, update NEWS

Closes #3

CMakeLists.txt

@@ -1,20 +1,11 @@
-project (nncmpp C)
-cmake_minimum_required (VERSION 2.8.5)
+cmake_minimum_required (VERSION 3.0)
+project (nncmpp VERSION 1.0.0 LANGUAGES C)
 
 # Moar warnings
 if ("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR CMAKE_COMPILER_IS_GNUCC)
-	set (wdisabled "-Wno-unused-function -Wno-implicit-fallthrough")
+	set (wdisabled "-Wno-unused-function")
 	set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99 -Wall -Wextra ${wdisabled}")
-endif ("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR CMAKE_COMPILER_IS_GNUCC)
-
-# Version
-set (project_VERSION_MAJOR "0")
-set (project_VERSION_MINOR "1")
-set (project_VERSION_PATCH "0")
-
-set (project_VERSION "${project_VERSION_MAJOR}")
-set (project_VERSION "${project_VERSION}.${project_VERSION_MINOR}")
-set (project_VERSION "${project_VERSION}.${project_VERSION_PATCH}")
+endif ()
 
 # For custom modules
 set (CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/liberty/cmake)
@@ -35,7 +26,7 @@ if (USE_SYSTEM_TERMO)
 	if (NOT Termo_FOUND)
 		message (FATAL_ERROR "System termo library not found")
 	endif (NOT Termo_FOUND)
-else (USE_SYSTEM_TERMO)
+else ()
 	add_subdirectory (termo EXCLUDE_FROM_ALL)
 	# We don't have many good choices when we don't want to install it and want
 	# to support older versions of CMake; this is a relatively clean approach
@@ -45,17 +36,23 @@ else (USE_SYSTEM_TERMO)
 	get_directory_property (Termo_INCLUDE_DIRS
 		DIRECTORY termo INCLUDE_DIRECTORIES)
 	set (Termo_LIBRARIES termo-static)
-endif (USE_SYSTEM_TERMO)
+endif ()
 
-include_directories (${UNISTRING_INCLUDE_DIRS}
-	${NCURSESW_INCLUDE_DIRS} ${Termo_INCLUDE_DIRS} ${curl_INCLUDE_DIRS})
+include_directories (${Unistring_INCLUDE_DIRS}
+	${Ncursesw_INCLUDE_DIRS} ${Termo_INCLUDE_DIRS} ${curl_INCLUDE_DIRS})
 link_directories (${curl_LIBRARY_DIRS})
 
 # Configuration
 include (CheckFunctionExists)
-set (CMAKE_REQUIRED_LIBRARIES ${NCURSESW_LIBRARIES})
+set (CMAKE_REQUIRED_LIBRARIES ${Ncursesw_LIBRARIES})
 CHECK_FUNCTION_EXISTS ("resizeterm" HAVE_RESIZETERM)
 
+if ("${CMAKE_SYSTEM_NAME}" MATCHES "BSD")
+	# Need this for SIGWINCH in FreeBSD and OpenBSD respectively;
+	# our POSIX version macros make it undefined
+	add_definitions (-D__BSD_VISIBLE=1 -D_BSD_SOURCE=1)
+endif ()
+
 # Generate a configuration file
 configure_file (${PROJECT_SOURCE_DIR}/config.h.in
 	${PROJECT_BINARY_DIR}/config.h)
@@ -63,30 +60,33 @@ include_directories (${PROJECT_SOURCE_DIR} ${PROJECT_BINARY_DIR})
 
 # Build the main executable and link it
 add_executable (${PROJECT_NAME} ${PROJECT_NAME}.c)
-target_link_libraries (${PROJECT_NAME} ${UNISTRING_LIBRARIES}
-	${NCURSESW_LIBRARIES} termo-static ${curl_LIBRARIES})
+target_link_libraries (${PROJECT_NAME} ${Unistring_LIBRARIES}
+	${Ncursesw_LIBRARIES} termo-static ${curl_LIBRARIES})
 add_threads (${PROJECT_NAME})
 
 # Installation
 include (GNUInstallDirs)
 install (TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR})
 install (FILES LICENSE DESTINATION ${CMAKE_INSTALL_DOCDIR})
+install (DIRECTORY contrib DESTINATION ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME})
 
-# Generate documentation from program help
-find_program (HELP2MAN_EXECUTABLE help2man)
-if (NOT HELP2MAN_EXECUTABLE)
-	message (FATAL_ERROR "help2man not found")
-endif (NOT HELP2MAN_EXECUTABLE)
+# Generate documentation from text markup
+find_program (ASCIIDOCTOR_EXECUTABLE asciidoctor)
+if (NOT ASCIIDOCTOR_EXECUTABLE)
+	message (FATAL_ERROR "asciidoctor not found")
+endif ()
 
 foreach (page ${PROJECT_NAME})
 	set (page_output "${PROJECT_BINARY_DIR}/${page}.1")
 	list (APPEND project_MAN_PAGES "${page_output}")
 	add_custom_command (OUTPUT ${page_output}
-		COMMAND ${HELP2MAN_EXECUTABLE} -N
-			"${PROJECT_BINARY_DIR}/${page}" -o ${page_output}
-		DEPENDS ${page}
+		COMMAND ${ASCIIDOCTOR_EXECUTABLE} -b manpage
+			-a release-version=${PROJECT_VERSION}
+			"${PROJECT_SOURCE_DIR}/${page}.adoc"
+			-o "${page_output}"
+		DEPENDS ${page}.adoc
 		COMMENT "Generating man page for ${page}" VERBATIM)
-endforeach (page)
+endforeach ()
 
 add_custom_target (docs ALL DEPENDS ${project_MAN_PAGES})
 
@@ -94,23 +94,20 @@ foreach (page ${project_MAN_PAGES})
 	string (REGEX MATCH "\\.([0-9])$" manpage_suffix "${page}")
 	install (FILES "${page}"
 		DESTINATION "${CMAKE_INSTALL_MANDIR}/man${CMAKE_MATCH_1}")
-endforeach (page)
+endforeach ()
 
 # CPack
 set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "MPD client")
-set (CPACK_PACKAGE_VENDOR "Premysl Janouch")
-set (CPACK_PACKAGE_CONTACT "Přemysl Janouch <p@janouch.name>")
+set (CPACK_PACKAGE_VENDOR "Premysl Eric Janouch")
+set (CPACK_PACKAGE_CONTACT "Přemysl Eric Janouch <p@janouch.name>")
 set (CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE")
-set (CPACK_PACKAGE_VERSION_MAJOR ${project_VERSION_MAJOR})
-set (CPACK_PACKAGE_VERSION_MINOR ${project_VERSION_MINOR})
-set (CPACK_PACKAGE_VERSION_PATCH ${project_VERSION_PATCH})
 set (CPACK_GENERATOR "TGZ;ZIP")
 set (CPACK_PACKAGE_FILE_NAME
-	"${PROJECT_NAME}-${project_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
-set (CPACK_PACKAGE_INSTALL_DIRECTORY "${PROJECT_NAME}-${project_VERSION}")
+	"${PROJECT_NAME}-${PROJECT_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
+set (CPACK_PACKAGE_INSTALL_DIRECTORY "${PROJECT_NAME}-${PROJECT_VERSION}")
 set (CPACK_SOURCE_GENERATOR "TGZ;ZIP")
 set (CPACK_SOURCE_IGNORE_FILES "/\\\\.git;/build;/CMakeLists.txt.user")
-set (CPACK_SOURCE_PACKAGE_FILE_NAME "${PROJECT_NAME}-${project_VERSION}")
+set (CPACK_SOURCE_PACKAGE_FILE_NAME "${PROJECT_NAME}-${PROJECT_VERSION}")
 
 set (CPACK_SET_DESTDIR TRUE)
 include (CPack)

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016 - 2018, Přemysl Janouch <p@janouch.name>
+Copyright (c) 2016 - 2020, Přemysl Eric Janouch <p@janouch.name>
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted.

NEWS

@@ -0,0 +1,26 @@
+1.0.0 (2020-11-05)
+
+ * Coming with a real manual page instead of a help2man-generated stub
+
+ * Added a mode to poll MPD for the elapsed time, enabled by default,
+   fixing two cases of improper tracking
+
+ * Started showing song duration in the library
+
+ * Added C-PgUp/PgDown and C-Left/Right bindings to iterate tabs
+
+ * Added VIM-like C-y and C-e bindings for scrolling
+
+ * Added Windows Explorer-like M-Up binding to go up a directory
+
+ * Worked around a cURL bug crashing the application
+
+ * Fixed handling of direct SHOUTcast streams
+
+ * Miscellaneous little fixes
+
+
+0.9.0 (2018-11-02)
+
+ * Initial release
+

README.adoc

@@ -11,9 +11,9 @@ names, and should be pronounced as "nincompoop".
 
 Features
 --------
-Currently it's still under development but it's already useful enough for me
-to use it exclusively.  Note that since I only use the filesystem browsing mode,
-that's also the only thing I care to implement for the time being.
+Most things are there.  Enough for me to use it exclusively.  Note that since I
+only use the filesystem browsing mode, that's also the only thing I care to
+implement for the time being.
 
 image::nncmpp.png[align="center"]
 
@@ -22,9 +22,14 @@ Packages
 Regular releases are sporadic.  git master should be stable enough.  You can get
 a package with the latest development version from Archlinux's AUR.
 
-Building and Running
---------------------
-Build dependencies: CMake, pkg-config, help2man, liberty (included),
+Documentation
+-------------
+See the link:nncmpp.adoc[man page] for information about usage.
+The rest of this README will concern itself with externalities.
+
+Building
+--------
+Build dependencies: CMake, pkg-config, asciidoctor, liberty (included),
                     termo (included) +
 Runtime dependencies: ncursesw, libunistring, cURL
 
@@ -43,39 +48,6 @@ Or you can try telling CMake to make a package for you.  For Debian it is:
  $ cpack -G DEB
  # dpkg -i nncmpp-*.deb
 
-Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with
-`fakeroot` or file ownership will end up wrong.
-
-Having the program installed, create a configuration file and run it.
-
-Configuration
--------------
-Create _~/.config/nncmpp/nncmpp.conf_ with contents like the following:
-
-....
-settings = {
-	address    = "localhost:6600"
-	password   = "<your password>"
-	root       = "~/Music"
-}
-colors = {
-	normal     = ""
-	highlight  = "bold"
-	elapsed    = "reverse"
-	remains    = "ul"
-	tab_bar    = "reverse"
-	tab_active = "ul"
-	even       = ""
-	odd        = ""
-	selection  = "reverse"
-	scrollbar  = ""
-}
-streams = {
-	"dnbradio.com" = "http://www.dnbradio.com/hi.m3u"
-	"BassDrive.com" = "http://bassdrive.com/v2/streams/BassDrive.pls"
-}
-....
-
 Terminal caveats
 ----------------
 This application aspires to be as close to a GUI as possible.  It expects you

config.h.in

@@ -2,7 +2,7 @@
 #define CONFIG_H
 
 #define PROGRAM_NAME "${CMAKE_PROJECT_NAME}"
-#define PROGRAM_VERSION "${project_VERSION}"
+#define PROGRAM_VERSION "${PROJECT_VERSION}"
 
 #cmakedefine HAVE_RESIZETERM
 

contrib/dark-theme-16.conf

@@ -0,0 +1,51 @@
+# Contributed by vifino
+
+# Best enjoyed with the following softer terminal color theme:
+#! special
+#*.foreground:   #d5d5d5
+#*.background:   #1d2021
+#*.cursorColor:  #d5d5d5
+#! black
+#*.color0:       #101010
+#*.color8:       #6f6f6f
+#! red
+#*.color1:       #ff6878
+#*.color9:       #ff778b
+#! green
+#*.color2:       #b4fb73
+#*.color10:      #d0ffa0
+#! yellow
+#*.color3:       #fff090
+#*.color11:      #fffeb0
+#! blue
+#*.color4:       #6095ff
+#*.color12:      #80c0ff
+#! magenta
+#*.color5:       #ff90fe
+#*.color13:      #f0a9ff
+#! cyan
+#*.color6:       #45e1f8
+#*.color14:      #90e9ff
+#! white
+#*.color7:       #f1f1f1
+#*.color15:      #ffffff
+
+colors = {
+	normal = "1 0"
+	highlight = "12 0 bold"
+	elapsed = "4 4"
+	remains = "4 8"
+
+	tab_bar = "8 0"
+	tab_active = "6 8 bold"
+	even = "11 0"
+	odd = "11 0"
+	scrollbar = "8 0"
+
+	selection = "0 4"
+	multiselect = "0 3"
+	directory = "15 0"
+
+	incoming = "2"
+	outgoing = "4"
+}

contrib/light-theme-256.conf

@@ -0,0 +1,19 @@
+colors = {
+	normal = "237 255"
+	highlight = "16 255 bold"
+	elapsed = "231 250"
+	remains = "250 231"
+
+	tab_bar = "252 16"
+	tab_active = "231 237 bold"
+	even = "16 231"
+	odd = "16 231"
+	scrollbar = "250 231"
+
+	selection = "231 202"
+	multiselect = "231 88"
+	directory = "16 231 bold"
+
+	incoming = "28"
+	outgoing = "19"
+}

line-editor.c

@@ -0,0 +1,288 @@
+/*
+ * line-editor.c: a line editor component for the TUI part of liberty
+ *
+ * Copyright (c) 2017 - 2018, Přemysl Eric Janouch <p@janouch.name>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+ * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
+ * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ */
+
+// This is here just for IDE code model reasons
+#ifndef HAVE_LIBERTY
+#include "liberty/liberty.c"
+#include "liberty/liberty-tui.c"
+#endif
+
+static void
+row_buffer_append_c (struct row_buffer *self, ucs4_t c, chtype attrs)
+{
+	struct row_char current = { .attrs = attrs, .c = c };
+	struct row_char invalid = { .attrs = attrs, .c = '?', .width = 1 };
+
+	current.width = uc_width (current.c, locale_charset ());
+	if (current.width < 0 || !app_is_character_in_locale (current.c))
+		current = invalid;
+
+	ARRAY_RESERVE (self->chars, 1);
+	self->chars[self->chars_len++] = current;
+	self->total_width += current.width;
+}
+
+// --- Line editor -------------------------------------------------------------
+
+enum line_editor_action
+{
+	LINE_EDITOR_B_CHAR,                 ///< Go back a character
+	LINE_EDITOR_F_CHAR,                 ///< Go forward a character
+	LINE_EDITOR_B_WORD,                 ///< Go back a word
+	LINE_EDITOR_F_WORD,                 ///< Go forward a word
+	LINE_EDITOR_HOME,                   ///< Go to start of line
+	LINE_EDITOR_END,                    ///< Go to end of line
+
+	LINE_EDITOR_B_DELETE,               ///< Delete last character
+	LINE_EDITOR_F_DELETE,               ///< Delete next character
+	LINE_EDITOR_B_KILL_WORD,            ///< Delete last word
+	LINE_EDITOR_B_KILL_LINE,            ///< Delete everything up to BOL
+	LINE_EDITOR_F_KILL_LINE,            ///< Delete everything up to EOL
+};
+
+struct line_editor
+{
+	int point;                          ///< Caret index into line data
+	ucs4_t *line;                       ///< Line data, 0-terminated
+	int *w;                             ///< Codepoint widths, 0-terminated
+	size_t len;                         ///< Editor length
+	size_t alloc;                       ///< Editor allocated
+	char prompt;                        ///< Prompt character
+
+	void (*on_changed) (void);          ///< Callback on text change
+	void (*on_end) (bool);              ///< Callback on abort
+};
+
+static void
+line_editor_free (struct line_editor *self)
+{
+	free (self->line);
+	free (self->w);
+}
+
+/// Notify whomever invoked the editor that it's been either confirmed or
+/// cancelled and clean up editor state
+static void
+line_editor_abort (struct line_editor *self, bool status)
+{
+	self->on_end (status);
+	self->on_changed = NULL;
+
+	free (self->line);
+	self->line = NULL;
+	free (self->w);
+	self->w = NULL;
+	self->alloc = 0;
+	self->len = 0;
+	self->point = 0;
+	self->prompt = 0;
+}
+
+/// Start the line editor; remember to fill in "change" and "end" callbacks
+static void
+line_editor_start (struct line_editor *self, char prompt)
+{
+	self->alloc = 16;
+	self->line = xcalloc (sizeof *self->line, self->alloc);
+	self->w = xcalloc (sizeof *self->w, self->alloc);
+	self->len = 0;
+	self->point = 0;
+	self->prompt = prompt;
+}
+
+static void
+line_editor_changed (struct line_editor *self)
+{
+	self->line[self->len] = 0;
+	self->w[self->len] = 0;
+
+	if (self->on_changed)
+		self->on_changed ();
+}
+
+static void
+line_editor_move (struct line_editor *self, int to, int from, int len)
+{
+	memmove (self->line + to, self->line + from,
+		sizeof *self->line * len);
+	memmove (self->w + to, self->w + from,
+		sizeof *self->w * len);
+}
+
+static void
+line_editor_insert (struct line_editor *self, ucs4_t codepoint)
+{
+	while (self->alloc - self->len < 2 /* inserted + sentinel */)
+	{
+		self->alloc <<= 1;
+		self->line = xreallocarray
+			(self->line, sizeof *self->line, self->alloc);
+		self->w = xreallocarray
+			(self->w, sizeof *self->w, self->alloc);
+	}
+
+	line_editor_move (self, self->point + 1, self->point,
+		self->len - self->point);
+	self->line[self->point] = codepoint;
+	self->w[self->point] = app_is_character_in_locale (codepoint)
+		? uc_width (codepoint, locale_charset ())
+		: 1 /* the replacement question mark */;
+
+	self->point++;
+	self->len++;
+	line_editor_changed (self);
+}
+
+static bool
+line_editor_action (struct line_editor *self, enum line_editor_action action)
+{
+	switch (action)
+	{
+	default:
+		return soft_assert (!"unknown line editor action");
+
+	case LINE_EDITOR_B_CHAR:
+		if (self->point < 1)
+			return false;
+		do self->point--;
+		while (self->point > 0
+			&& !self->w[self->point]);
+		return true;
+	case LINE_EDITOR_F_CHAR:
+		if (self->point + 1 > (int) self->len)
+			return false;
+		do self->point++;
+		while (self->point < (int) self->len
+			&& !self->w[self->point]);
+		return true;
+	case LINE_EDITOR_B_WORD:
+	{
+		if (self->point < 1)
+			return false;
+		int i = self->point;
+		while (i && self->line[--i] == ' ');
+		while (i-- && self->line[i] != ' ');
+		self->point = ++i;
+		return true;
+	}
+	case LINE_EDITOR_F_WORD:
+	{
+		if (self->point + 1 > (int) self->len)
+			return false;
+		int i = self->point;
+		while (i < (int) self->len && self->line[i] != ' ') i++;
+		while (i < (int) self->len && self->line[i] == ' ') i++;
+		self->point = i;
+		return true;
+	}
+	case LINE_EDITOR_HOME:
+		self->point = 0;
+		return true;
+	case LINE_EDITOR_END:
+		self->point = self->len;
+		return true;
+
+	case LINE_EDITOR_B_DELETE:
+	{
+		if (self->point < 1)
+			return false;
+		int len = 1;
+		while (self->point - len > 0
+			&& !self->w[self->point - len])
+			len++;
+		line_editor_move (self, self->point - len, self->point,
+			self->len - self->point);
+		self->len -= len;
+		self->point -= len;
+		line_editor_changed (self);
+		return true;
+	}
+	case LINE_EDITOR_F_DELETE:
+	{
+		if (self->point + 1 > (int) self->len)
+			return false;
+		int len = 1;
+		while (self->point + len < (int) self->len
+			&& !self->w[self->point + len])
+			len++;
+		self->len -= len;
+		line_editor_move (self, self->point, self->point + len,
+			self->len - self->point);
+		line_editor_changed (self);
+		return true;
+	}
+	case LINE_EDITOR_B_KILL_WORD:
+	{
+		if (self->point < 1)
+			return false;
+
+		int i = self->point;
+		while (i && self->line[--i] == ' ');
+		while (i-- && self->line[i] != ' ');
+		i++;
+
+		line_editor_move (self, i, self->point, (self->len - self->point));
+		self->len -= self->point - i;
+		self->point = i;
+		line_editor_changed (self);
+		return true;
+	}
+	case LINE_EDITOR_B_KILL_LINE:
+		self->len -= self->point;
+		line_editor_move (self, 0, self->point, self->len);
+		self->point = 0;
+		line_editor_changed (self);
+		return true;
+	case LINE_EDITOR_F_KILL_LINE:
+		self->len = self->point;
+		line_editor_changed (self);
+		return true;
+	}
+}
+
+static int
+line_editor_write (const struct line_editor *self, struct row_buffer *row,
+	int width, chtype attrs)
+{
+	if (self->prompt)
+	{
+		hard_assert (self->prompt < 127);
+		row_buffer_append_c (row, self->prompt, attrs);
+		width--;
+	}
+
+	int following = 0;
+	for (size_t i = self->point; i < self->len; i++)
+		following += self->w[i];
+
+	int preceding = 0;
+	size_t start = self->point;
+	while (start && preceding < width / 2)
+		preceding += self->w[--start];
+
+	// There can be one extra space at the end of the line but this way we
+	// don't need to care about non-spacing marks following full-width chars
+	while (start && width - preceding - following > 2 /* widest char */)
+		preceding += self->w[--start];
+
+	// XXX: we should also show < > indicators for overflow but it'd probably
+	//   considerably complicate this algorithm
+	for (; start < self->len; start++)
+		row_buffer_append_c (row, self->line[start], attrs);
+	return !!self->prompt + preceding;
+}

nncmpp.adoc

@@ -0,0 +1,87 @@
+nncmpp(1)
+=========
+:doctype: manpage
+:manmanual: nncmpp Manual
+:mansource: nncmpp {release-version}
+
+Name
+----
+nncmpp - terminal-based MPD client
+
+Synopsis
+--------
+*nncmpp* [_OPTION_]...
+
+Description
+-----------
+*nncmpp* is a terminal-based GUI-like MPD client.  On start up it will welcome
+you with an overview of all key bindings and the actions they're assigned to.
+Individual tabs can be switched to either using the mouse or by pressing *M-1*
+through *M-9*, corresponding to the order they appear in.
+
+Options
+-------
+*-d*, *--debug*::
+	Adds a "Debug" tab showing all MPD communication and other information
+	that help debug various issues.
+
+*-h*, *--help*::
+	Display a help message and exit.
+
+*-V*, *--version*::
+	Output version information and exit.
+
+Configuration
+-------------
+Unless you run MPD on a remote machine, on an unusual port, or protected by
+a password, the client doesn't need a configuration file to work.  It is,
+however, likely that you'll want to customize the looks or add some streams.
+You can start off with the following snippet:
+
+....
+settings = {
+	address    = "localhost:6600"
+	password   = "<your password>"
+	root       = "~/Music"
+}
+colors = {
+	normal      = ""
+	highlight   = "bold"
+	elapsed     = "reverse"
+	remains     = "ul"
+	tab_bar     = "reverse"
+	tab_active  = "ul"
+	even        = ""
+	odd         = ""
+	selection   = "reverse"
+	multiselect = "-1 6"
+	scrollbar   = ""
+}
+streams = {
+	"dnbradio.com" = "http://www.dnbradio.com/hi.m3u"
+	"BassDrive.com" = "http://bassdrive.com/v2/streams/BassDrive.pls"
+}
+....
+
+Terminal attributes are accepted in a format similar to that of *git-config*(1),
+only named colours aren't supported.  The distribution contains example colour
+schemes in the _contrib_ directory.
+
+// TODO: it seems like liberty should contain an includable snippet about
+//   the format, which could form a part of nncmpp.conf(5).
+
+Files
+-----
+*nncmpp* follows the XDG Base Directory Specification.
+
+_~/.config/nncmpp/nncmpp.conf_::
+	The configuration file.
+
+Reporting bugs
+--------------
+Use https://git.janouch.name/p/nncmpp to report bugs, request features,
+or submit pull requests.
+
+See also
+--------
+*mpd*(1)