doc/ncmpc.1: migrate to Sphinx
authorMax Kellermann <max@musicpd.org>
Sun, 25 Feb 2018 20:34:51 +0000 (21:34 +0100)
committerMax Kellermann <max@musicpd.org>
Sun, 25 Feb 2018 20:41:53 +0000 (21:41 +0100)
NEWS
doc/conf.py [new file with mode: 0644]
doc/index.rst [new file with mode: 0644]
doc/meson.build
doc/ncmpc.1 [deleted file]
meson.build

diff --git a/NEWS b/NEWS
index 858f489..d1eab79 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,5 +1,6 @@
 ncmpc 0.30 - not yet released
 * fix crash after pressing ^W in search screen
 ncmpc 0.30 - not yet released
 * fix crash after pressing ^W in search screen
+* build manual with Sphinx
 
 ncmpc 0.29 - (2017-11-05)
 * fix crash after losing MPD connection
 
 ncmpc 0.29 - (2017-11-05)
 * fix crash after losing MPD connection
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644 (file)
index 0000000..068cae5
--- /dev/null
@@ -0,0 +1,319 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'ncmpc'
+copyright = 'Copyright (C) 2004-2018 The Music Player Daemon Project'
+author = 'Max Kellermann'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.30'
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#
+# today = ''
+#
+# Else, today_fmt is used as the format for a strftime call.
+#
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+#html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#
+# html_title = 'ncmpc v2.0'
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#
+# html_logo = None
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+# html_extra_path = []
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#
+# html_last_updated_fmt = None
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+#
+# html_domain_indices = True
+
+# If false, no index is generated.
+#
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ncmpcdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+     # The paper size ('letterpaper' or 'a4paper').
+     #
+     # 'papersize': 'letterpaper',
+
+     # The font size ('10pt', '11pt' or '12pt').
+     #
+     # 'pointsize': '10pt',
+
+     # Additional stuff for the LaTeX preamble.
+     #
+     # 'preamble': '',
+
+     # Latex figure (float) alignment
+     #
+     # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'ncmpc.tex', 'ncmpc Documentation',
+     'Max Kellermann', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+#
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#
+# latex_appendices = []
+
+# It false, will not define \strong, \code,    itleref, \crossref ... but only
+# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
+# packages.
+#
+# latex_keep_old_macro_names = True
+
+# If false, no module index is generated.
+#
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'ncmpc', 'ncmpc Documentation',
+     [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'ncmpc', 'ncmpc Documentation',
+     author, 'ncmpc', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+#
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#
+# texinfo_no_detailmenu = False
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644 (file)
index 0000000..b24e597
--- /dev/null
@@ -0,0 +1,354 @@
+ncmpc
+=====
+
+
+Description
+-----------
+
+ncmpc is a command-line client for the `Music Player Daemon
+<http://www.musicpd.org/>`__ (MPD).
+
+By default, ncmpc connects to the local MPD instance.  A different MPD
+instance can be selected using the command line options
+:option:`--host` and :option:`--port`, or by setting the environment
+variables :envvar:`MPD_HOST` and :envvar:`MPD_PORT`::
+
+ ncmpc --host=musicserver --port=44000
+
+You can connect to a "local" socket by setting the host to a file path
+(e.g. ":file:`/run/mpd/socket`").  Abstract sockets can be used with a ":file:`@`"
+prefix (e.g. ":file:`@mpd`").
+
+To use a password with MPD, set :envvar:`MPD_HOST` to
+:samp:`password@host` or use the command line option
+:option:`--password`.  Values from the command line override values
+from the environment.
+
+
+Synopsis
+--------
+
+ ncmpc [options]
+
+
+Options
+-------
+
+.. option:: -?, --help
+
+ Display help.
+
+.. option:: -V, --version
+
+ Display version information and build-time configuration.
+
+.. option:: -c, --colors
+
+ Enable colors.
+
+.. option:: -C, --no-colors
+
+ Disable colors.
+
+.. option:: -m, --mouse
+
+ Enable mouse.
+
+.. option:: --host=HOST
+
+ The MPD host to connect to.
+
+.. option:: --port=PORT, -p PORT
+
+ The port to connect to.
+
+.. option:: -P, --password=PASSWORD
+
+ Use password when connecting.
+
+.. option:: -f, --config=FILE
+
+ Read configuration from file.
+
+.. option:: -k, --key-file=FILE
+
+ Read key bindings from file.
+
+
+Configuration
+-------------
+
+When ncmpc starts it tries to read the user's configuration file,
+:file:`~/.ncmpc/config`.  If no user configuration file is found then
+ncmpc tries to load the global settings from
+:file:`$SYSCONFDIR/ncmpc/config` (the actual path is displayed in the
+output of the :option:`--version` option).  An example configuration
+file (:file:`config.sample`) is shipped with ncmpc.
+
+
+Connection
+^^^^^^^^^^
+
+:command:`host = HOST` - The MPD host to connect to.
+
+:command:`port = PORT` - The port to connect to.
+
+:command:`password = PASSWORD` - Use password when connecting.
+
+:command:`timeout = TIMEOUT` - Attempt to reconnect to mpd if a
+response to a command is not received within TIMEOUT
+seconds. Specifying a value in the configuration file overrides the
+":envvar:`MPD_TIMEOUT`" environment variable.  If no timeout is
+specified in the configuration file or in the environment, the default
+is 5 seconds.
+
+
+Interface
+^^^^^^^^^
+
+:command:`enable-mouse = yes|no` - Enable mouse support (if enabled at compile time).
+
+:command:`screen-list = SCREEN1 SCREEN2...` - A list of screens to
+cycle through when using the previous/next screen commands.  Valid
+choices, if enabled at compile time, are playlist, browse, artist,
+help, search, song, keydef, lyrics, outputs, and chat.
+
+:command:`search-mode = MODE` - Default search mode for the search
+screen. MODE must be one of title, artist, album, filename, and
+artist+title, or an interger index (0 for title, 1 for artist etc.).
+
+:command:`auto-center = yes|no` - Enable/disable auto center
+mode. When auto center mode is enabled ncmpc centers the current track
+in the playlist window.
+
+:command:`scroll-offset = NUM` - Keep at least NUM lines above and
+below the cursor on list windows, if possible.
+
+:command:`find-show-last = yes|no` - Show the most recent query instead of a blank line for a find.
+
+:command:`find-wrap = yes|no` - Wrapped find mode.
+
+:command:`wrap-around = yes|no` - Wrapped cursor movement.
+
+:command:`bell-on-wrap = yes|no` - Ring bell when find wraps around.
+
+:command:`audible-bell = yes|no` - Sound audible bell on alerts.
+
+:command:`visible-bell = yes|no` - Visible bell on alerts.
+
+:command:`crossfade-time = CROSSFADE TIME` - Default crossfade time in
+seconds.
+
+:command:`seek-time = NUM` - Seek forward/backward by NUM seconds.
+
+:command:`lyrics-timeout = NUM` - Quits downloading lyrics of a song
+after the timeout of NUM seconds is reached, if NUM is greater than
+zero.
+
+:command:`jump-prefix-only = yes|no` - When using the jump command,
+search for the prefix of an entry.  That means typing "m" will start
+to the first entry which begins with "m".
+
+:command:`lyrics-autosave = yes|no` - Automatically save lyrics after
+receiving them.
+
+:command:`lyrics-show-plugin = yes|no` - Show the name of the plugin
+used to receive lyrics on the lyrics screen.
+
+:command:`text-editor = EDITOR` - The text editor used for editing
+lyrics.
+
+:command:`text-editor-ask = yes|no` - Ask before starting an editor.
+
+:command:`chat-prefix = PREFIX` - Prefix messages send with the chat
+screen with PREFIX.  By default they are prefixed with the current
+user name enclosed by "<" and ">" and a space (i.e. "<name> ").
+
+:command:`second-column = yes|no` - Display song length in a second
+column.
+
+
+Display
+^^^^^^^
+
+:command:`welcome-screen-list = yes|no` - Show a list of the screens
+in the top line on startup.
+
+:command:`wide-cursor = yes|no` - Make the cursor as wide as the
+screen.
+
+:command:`hardware-cursor = yes|no` - Use the terminal's hardware
+cursor instead of inverse colors.
+
+:command:`hide-cursor = NUM` - Hide the playlist cursor after NUM
+seconds of inactivity.
+
+:command:`scroll = yes|no` - Scroll the title if it is too long for
+the screen.
+
+:command:`scroll-sep = STRING` - the separator to show at the end of
+the scrolling title.
+
+:command:`list-format = SONG FORMAT` - The format used to display
+songs in the main window.
+
+:command:`search-format = SONG FORMAT` - The format used to display
+songs in the search window. Default is to use list-format.
+
+:command:`status-format = SONG FORMAT` - The format used to display
+songs on the status line.
+
+:command:`status-message-time = TIME` - The time, in seconds, for
+which status messages will be displayed.
+
+:command:`display-time = yes|no` - Display the time in the status bar
+when idle.
+
+:command:`timedisplay-type = elapsed/remaining` - Sets whether to
+display remaining or elapsed time in the status window.  Default is
+elapsed.
+
+:command:`visible-bitrate = yes|no` - Show the bitrate in the status
+bar when playing a stream.  :command:`
+
+:command:`set-xterm-title = yes|no` - Change the XTerm title (ncmpc
+will not restore the title).
+
+:command:`xterm-title-format = SONG FORMAT` - The format used to for
+the xterm title when ncmpc is playing.
+
+
+Colors
+^^^^^^
+
+:command:`enable-colors = yes|no` - Enable/disable colors.
+
+:command:`color background = COLOR` - Set the background color. If the
+background color is assigned to the keyword ":samp:`none`", ncmpc will
+not change the background color.  Standard colors are: black, red,
+green, yellow, blue, magenta, cyan and white.  Terminal specific
+colors can also be given as integers.
+
+:command:`color title = COLOR[,ATTRIBUTE]...` - Set the text color and
+attributes for the title row.  Text colors are the same as for the
+background. Valid attributes are: standout, underline, reverse, blink,
+dim, and bold.
+
+:command:`color title-bold = COLOR[,ATTRIBUTE]...` - Set the text
+color for the title row (the bold part).
+
+:command:`color line = COLOR` - Set the color of the line on the
+second row.
+
+:command:`color line-flags = COLOR[,ATTRIBUTE]...` - Set the text
+color used to indicate mpd flags on the second row.
+
+:command:`color list = COLOR[,ATTRIBUTE]...` - Set the text color in
+the main area of ncmpc.
+
+:command:`color list-bold = COLOR[,ATTRIBUTE]...` - Set the bold text
+color in the main area of ncmpc.
+
+:command:`color browser-directory = COLOR[,ATTRIBUTE]...` - Set the
+text color used to display directories in the browser window.
+
+:command:`color browser-playlist = COLOR[,ATTRIBUTE]...` - Set the
+text color used to display playlists in the browser window.
+
+:command:`color progressbar = COLOR[,ATTRIBUTE]...` - Set the color of
+the progress indicator.
+
+:command:`color status-state = COLOR[,ATTRIBUTE]...` - Set the text
+color used to display mpd status in the status window.
+
+:command:`color status-song = COLOR[,ATTRIBUTE]...` - Set the text
+color used to display song names in the status window.
+
+:command:`color status-time = COLOR[,ATTRIBUTE]...` - Set the text
+color used to display time the status window.
+
+:command:`color alert = COLOR[,ATTRIBUTE]...` - Set the text color
+used to display alerts in the status window.
+
+:command:`colordef COLOR = R, G, B` - Redefine any of the base
+colors. The RGB values must be integer values between 0 and 1000.
+*Note*: Only some terminals allow redefinitions of colors!
+
+
+
+Keys
+----
+
+When ncmpc starts it tries to read user-defined key bindings from the
+:file:`~/.ncmpc/keys` file.  If no user-defined key bindings are found
+then ncmpc tries to load the global key bindings from
+:file:`$SYSCONFDIR/ncmpc/keys` (the actual path is displayed on the
+help screen).
+
+You can view ncmpc's key bindings by pressing '1' (help) when ncmpc is
+running.  To edit key bindings press 'K' and use the key editor in
+ncmpc.
+
+
+Song Format
+-----------
+
+Format of song display for status and the list window.  The metadata
+delimiters are: %artist%, %albumartist%, %composer%, %performer%,
+%title%, %album%, %shortalbum%, %track%, %disc, %genre%, %name%,
+%time%, %date%, %file%, %shortfile%.
+
+The [] operators are used to group output such that if none of the
+metadata delimiters between '[' and ']' are matched, then none of the
+characters between '[' and ']' are output; literal text is always
+output. '&' and '|' are logical operators for AND and OR. '#' is used
+to escape characters.
+
+Some useful examples for format are::
+
+ "%file%"
+
+and::
+
+ "[[%artist% - ]%title%]|%file%"
+
+Another one is::
+
+ "[%artist%|(artist n/a)] - [%title%|(title n/a)]"
+
+
+Chat Protocol
+-------------
+
+If ncmpc has been compiled with "chat" support, it uses the
+client-to-client protocol available in MPD 0.17 or higher to
+communicate with other clients.  In order to receive messages it
+subscribes to the channel with the name "chat", and displays any
+message sent there as-is.  When the user enters a message, it is first
+with the prefix specified by the :command:`chat-prefix` option (or the
+default prefix), and then sent to the "chat" channel for others to
+read.
+
+
+Bugs
+----
+
+Report bugs on https://github.com/MusicPlayerDaemon/ncmpc/issues
+
+
+Note
+---
+
+Since MPD uses UTF-8, ncmpc needs to convert characters to the charset
+used by the local system.  If you get character conversion errors when
+your running ncmpc you probably need to set up your locale.  This is
+done by setting any of the :envvar:`LC_CTYPE`, :envvar:`LANG` or
+:envvar:`LC_ALL` environment variables (:envvar:`LC_CTYPE` only
+affects character handling).
+
+
+See also
+--------
+
+:manpage:`mpd(1)`, :manpage:`mpc(1)`, :manpage:`locale(5)`,
+:manpage:`locale(7)`
index 5760d26..af98a28 100644 (file)
@@ -1,3 +1,26 @@
+sphinx = find_program('sphinx-build', required:false)
+if sphinx.found()
+  custom_target(
+    'HTML documentation',
+    output: 'html',
+    input: ['index.rst', 'conf.py'],
+    command: [sphinx, '-q', '-b', 'html', '-d', '@OUTDIR@/doctrees', meson.current_source_dir(), '@OUTPUT@'],
+    build_by_default: true,
+    install: true,
+    install_dir: join_paths(get_option('datadir'), 'doc', meson.project_name()),
+  )
+
+  custom_target(
+    'Manpage documentation',
+    output: 'man',
+    input: ['index.rst', 'conf.py'],
+    command: [sphinx, '-q', '-b', 'man', '-d', '@OUTDIR@/doctrees', meson.current_source_dir(), '@OUTPUT@/man1'],
+    build_by_default: true,
+    install: true,
+    install_dir: get_option('datadir'),
+  )
+endif
+
 if get_option('documentation')
   doxygen = find_program('doxygen', required: false)
 
 if get_option('documentation')
   doxygen = find_program('doxygen', required: false)
 
diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
deleted file mode 100644 (file)
index 50141d9..0000000
+++ /dev/null
@@ -1,280 +0,0 @@
-.TH "ncmpc" "1" "June 2005" "" ""
-.SH "NAME"
-ncmpc \- curses Music Player Daemon (MPD) client.
-.SH "SYNOPSIS"
-.B ncmpc
-[options]
-.SH "DESCRIPTION"
-ncmpc is a client for MPD, the Music Player Daemon.
-
-By default, ncmpc connects to the local MPD instance.  A different MPD
-instance can be selected using the command line options \-\-host and
-\-\-port, or by setting the environment variables MPD_HOST and MPD_PORT.
-
-$ ncmpc \-\-host=musicserver \-\-port=44000
-
-You can connect to a "local" socket by setting the host to a file path
-(e.g. "/run/mpd/socket").  Abstract sockets can be used with a "@"
-prefix (e.g. "@mpd").
-
-To use a password with mpd, set MPD_HOST to password@host 
-or use the command line option \-\-password. Values from 
-the command line override values from the environment.
-
-Read more about MPD on http://www.musicpd.org
-
-.SH "OPTIONS"
-.TP 
-.B \-?, \-\-help
-Display help.
-.TP 
-.B \-V, \-\-version
-Display version information and build-time configuration.
-.TP 
-.B \-c, \-\-colors
-Enable colors.
-.TP 
-.B \-C, \-\-no\-colors
-Disable colors.
-.TP
-.B \-m, \-\-mouse
-Enable mouse.
-.TP
-.B \-M, \-\-no\-mouse
-Disable mouse.
-.TP 
-.B \-h, \-\-host=HOSTNAME
-Specify MPD host.
-.TP 
-.B \-p, \-\-port=PORT
-Connect to server on PORT.
-.TP 
-.B \-P, \-\-password=PASSWORD
-Use password when connecting.
-.TP 
-.B \-f, \-\-config=FILE
-Read configuration from file.
-.TP 
-.B \-k, \-\-key\-file=FILE
-Read key bindings from FILE.
-.TP
-Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
-.SH "CONFIGURATION"
-When ncmpc starts it tries to read the user's configuration file, ~/.ncmpc/config. If no user configuration file is found then ncmpc tries to load the global settings from $SYSCONFDIR/ncmpc/config (the actual path is displayed in the output of the --version option). An example configuration file (config.sample) should be provided with ncmpc.
-
-
-
-.SS Connection
-.TP
-.B host = HOST
-Connect to mpd running on the specified host.
-.TP
-.B port = PORT
-Connect to mpd on the specified port.
-.TP
-.B password = PASSWORD
-Connect to mpd using the specified password.
-.TP
-.B timeout = TIMEOUT
-Attempt to reconnect to mpd if a response to a command is not received within
-TIMEOUT seconds. Specifying a value in the configuration file overrides the
-"MPD_TIMEOUT" environment variable. If no timeout is specified in the
-configuration file or in the environment, the default is 5 seconds.
-.SS Interface
-.TP
-.B enable\-mouse = yes|no
-Enable mouse support (if enabled at compile time).
-.TP
-.B screen\-list = SCREEN1 SCREEN2...
-A list of screens to cycle through when using the previous/next screen commands. Valid choices, if enabled at compile time, are playlist, browse, artist, help, search, song, keydef, lyrics, outputs, and chat.
-.TP
-.B search\-mode = MODE
-Default search mode for the search screen. MODE must be one of title, artist, album, filename, and artist+title, or an interger index (0 for title, 1 for artist etc.).
-.TP 
-.B auto\-center = yes|no
-Enable/disable auto center mode. When auto center mode is enabled 
-ncmpc centers the current track in the playlist window.
-.TP
-.B scroll-offset = NUM
-Keep at least NUM lines above and below the cursor on list windows, if possible.
-.TP
-.B find\-show\-last = yes|no
-Show the most recent query instead of a blank line for a find.
-.TP 
-.B find\-wrap = yes|no
-Wrapped find mode.
-.TP 
-.B wrap\-around = yes|no
-Wrapped cursor movement.
-.TP
-.B bell\-on\-wrap = yes|no
-Ring bell when find wraps around.
-.TP 
-.B audible\-bell = yes|no
-Sound audible bell on alerts.
-.TP 
-.B visible\-bell = yes|no
-Visible bell on alerts.
-.TP
-.B crossfade\-time = CROSSFADE TIME
-Default crossfade time in seconds.
-.TP
-.B seek\-time = NUM
-Seek forward/backward by NUM seconds.
-.TP 
-.B lyrics\-timeout = NUM
-Quits downloading lyrics of a song after the timeout of NUM seconds is reached, if NUM is greater than zero.
-.TP
-.B jump\-prefix\-only = yes|no
-When using the jump command, search for the prefix of an entry. That means typing "m" will start to the first entry which begins with "m".
-.TP
-.B lyrics\-autosave = yes|no
-Automatically save lyrics after receiving them.
-.TP
-.B lyrics\-show\-plugin = yes|no
-Show the name of the plugin used to receive lyrics on the lyrics screen.
-.TP
-.B text\-editor = EDITOR
-The text editor used for editing lyrics.
-.TP
-.B text\-editor\-ask = yes|no
-Ask before starting an editor.
-.TP
-.B chat\-prefix = PREFIX
-Prefix messages send with the chat screen with PREFIX. By default they are prefixed with the current user name enclosed by \fB<\fR and \fB>\fR and a space (i.e. "<name> ").
-.TP
-.B second-column = yes|no
-Display song length in a second column.
-.SS Display
-.TP
-.B welcome\-screen\-list = yes|no
-Show a list of the screens in the top line on startup.
-.TP 
-.B wide\-cursor = yes|no
-Make the cursor as wide as the screen.
-.TP
-.B hardware\-cursor = yes|no
-Use the terminal's hardware cursor instead of inverse colors.
-.TP 
-.B hide\-cursor = NUM
-Hide the playlist cursor after NUM seconds of inactivity.
-.TP
-.B scroll = yes|no
-Scroll the title if it is too long for the screen.
-.TP
-.B scroll\-sep = STRING
-the separator to show at the end of the scrolling title.
-.TP 
-.B list\-format = SONG FORMAT
-The format used to display songs in the main window.
-.TP 
-.B search\-format = SONG FORMAT
-The format used to display songs in the search window. Default is to use list\-format.
-.TP
-.B status\-format = SONG FORMAT
-The format used to display songs on the status line.
-.TP
-.B status\-message\-time = TIME
-The time, in seconds, for which status messages will be displayed.
-.TP
-.B display\-time = yes|no
-Display the time in the status bar when idle.
-.TP 
-.B timedisplay-type = elapsed/remaining
-Sets whether to display remaining or elapsed time in the status window. Default is elapsed.
-.TP 
-.B visible\-bitrate = yes|no
-Show the bitrate in the status bar when playing a stream.
-.B 
-.TP 
-.B set\-xterm\-title = yes|no
-Change the XTerm title (ncmpc will not restore the title).
-.TP 
-.B xterm\-title\-format = SONG FORMAT
-The format used to for the xterm title when ncmpc is playing.
-.SS Colors
-.TP 
-.B enable\-colors = yes|no
-Enable/disable colors.
-.TP 
-.B color background = COLOR
-Set the background color. If the background color is assigned to the keyword \fBnone\fR, ncmpc will not change the background color. Standard colors are: black, red, green, yellow, blue, magenta, cyan and white. Terminal specific colors can also be given as integers.
-.TP 
-.B color title = COLOR[,ATTRIBUTE]...
-Set the text color and attributes for the title row. Text colors are the same as for the background. Valid attributes are: standout, underline, reverse, blink, dim, and bold.
-.TP 
-.B color title\-bold = COLOR[,ATTRIBUTE]...
-Set the text color for the title row (the bold part).
-.TP 
-.B color line = COLOR
-Set the color of the line on the second row.
-.TP 
-.B color line\-flags = COLOR[,ATTRIBUTE]...
-Set the text color used to indicate mpd flags on the second row.
-.TP 
-.B color list = COLOR[,ATTRIBUTE]...
-Set the text color in the main area of ncmpc.
-.TP 
-.B color list\-bold = COLOR[,ATTRIBUTE]...
-Set the bold text color in the main area of ncmpc.
-.TP 
-.B color browser-directory = COLOR[,ATTRIBUTE]...
-Set the text color used to display directories in the browser window.
-.TP 
-.B color browser-playlist = COLOR[,ATTRIBUTE]...
-Set the text color used to display playlists in the browser window.
-.TP 
-.B color progressbar = COLOR[,ATTRIBUTE]...
-Set the color of the progress indicator.
-.TP 
-.B color status\-state = COLOR[,ATTRIBUTE]...
-Set the text color used to display mpd status in the status window.
-.TP 
-.B color status\-song = COLOR[,ATTRIBUTE]...
-Set the text color used to display song names in the status window.
-.TP 
-.B color status\-time = COLOR[,ATTRIBUTE]...
-Set the text color used to display time the status window. 
-.TP 
-.B color alert = COLOR[,ATTRIBUTE]...
-Set the text color used to display alerts in the status window.
-.TP 
-.B colordef COLOR = R, G, B
-Redefine any of the base colors. The RGB values must be integer values between 0 and 1000. 
-\fBNote\fR: Only some terminals allow redefinitions of colors! 
-
-.SH "KEYS"
-When ncmpc starts it tries to read user-defined key bindings from the ~/.ncmpc/keys file. If no user-defined key bindings are found then ncmpc tries to load the global key bindings from $SYSCONFDIR/ncmpc/keys (the actual path is displayed on the help screen). 
-
-You can view ncmpc's key bindings by pressing '1' (help) when 
-ncmpc is running. To edit key bindings press 'K' and use the key editor in ncmpc.
-.SH "SONG FORMAT"
-Format of song display for status and the list window.
-The metadata delimiters are: %artist%, %albumartist%, %composer%,
-%performer%, %title%, %album%, %shortalbum%, %track%, %disc,
-%genre%, %name%, %time%, %date%, %file%, %shortfile%.
-
-The [] operators are used to group output such that if none of the metadata delimiters between '[' and ']' are matched, then none of the characters between '[' and ']' are output; literal text is always output. '&' and '|' are logical operators for AND and OR. '#' is used to escape characters.
-
-Some useful examples for format are:
-
-   "%file%" 
-
-and 
-
-   "[[%artist% \- ]%title%]|%file%"
-
-Another one is:
-
-   "[%artist%|(artist n/a)] - [%title%|(title n/a)]"
-
-.SH "CHAT PROTOCOL"
-If ncmpc has been compiled with "chat" support, it uses the client-to-client protocol available in MPD 0.17 or higher to communicate with other clients. In order to receive messages it subscribes to the channel with the name "chat", and displays any message sent there as-is. When the user enters a message, it is first with the prefix specified by the \fBchat-prefix\fR option (or the default prefix), and then sent to the "chat" channel for others to read.
-.SH "BUGS"
-Report bugs on https://github.com/MusicPlayerDaemon/ncmpc/issues
-.SH "NOTE"
-Since MPD uses UTF\-8, ncmpc needs to convert characters to the 
-charset used by the local system. If you get character conversion errors when your running ncmpc you probably need to set up your locale. This is done by setting any of the LC_CTYPE, LANG or LC_ALL environment variables (LC_CTYPE only affects character handling).
-
-.SH "SEE ALSO"
-mpc(1), mpd(1), locale(5), locale(7)
index 6810211..8950d76 100644 (file)
@@ -372,8 +372,6 @@ ncmpc = executable('ncmpc',
 
 configure_file(output: 'config.h', configuration: conf)
 
 
 configure_file(output: 'config.h', configuration: conf)
 
-install_man('doc/ncmpc.1')
-
 docdir = join_paths(get_option('datadir'), 'doc', meson.project_name())
 install_data('AUTHORS', 'COPYING', 'NEWS', 'README.rst',
   'doc/config.sample',
 docdir = join_paths(get_option('datadir'), 'doc', meson.project_name())
 install_data('AUTHORS', 'COPYING', 'NEWS', 'README.rst',
   'doc/config.sample',