Config: reformat all descriptions to fill 80 columns

2017-03-26 10:13:32 +02:00
parent ad869df626
commit cd78e1c79e
1 changed files with 121 additions and 145 deletions
--- a/doc/config
+++ b/doc/config
@@ -1,24 +1,21 @@
-##############################################################
-## This is the example configuration file. Copy it to       ##
-## $HOME/.ncmpcpp/config or $XDG_CONFIG_HOME/ncmpcpp/config ##
-## and set up your preferences.                             ##
-##############################################################
+##############################################################################
+## This is the example configuration file. Copy it to $HOME/.ncmpcpp/config ##
+## or $XDG_CONFIG_HOME/ncmpcpp/config and set up your preferences.          ##
+##############################################################################
 #
 ##### directories ######
 ##
-## Directory for storing ncmpcpp related files.
-## Changing it is useful if you want to store
-## everything somewhere else and provide command
-## line setting for alternative location to config
-## file which defines that while launching ncmpcpp.
+## Directory for storing ncmpcpp related files.  Changing it is useful if you
+## want to store everything somewhere else and provide command line setting for
+## alternative location to config file which defines that while launching
+## ncmpcpp.
 ##
 #
 #ncmpcpp_directory = ~/.ncmpcpp
 #
 ##
-## Directory for storing downloaded lyrics. It
-## defaults to ~/.lyrics since other MPD clients
-## (eg. ncmpc) also use that location.
+## Directory for storing downloaded lyrics. It defaults to ~/.lyrics since other
+## MPD clients (eg. ncmpc) also use that location.
 ##
 #
 #lyrics_directory = ~/.lyrics
@@ -39,11 +36,10 @@
 #
 ##### music visualizer #####
 ##
-## Note: In order to make music visualizer work you'll
-## need to use mpd fifo output, whose format parameter
-## has to be set to 44100:16:1 for mono visualization
-## or 44100:16:2 for stereo visualization. Example
-## configuration (it has to be put into mpd.conf):
+## Note: In order to make music visualizer work you'll need to use mpd fifo
+## output, whose format parameter has to be set to 44100:16:1 for mono
+## visualization or 44100:16:2 for stereo visualization. Example configuration
+## (it has to be put into mpd.conf):
 ##
 ## audio_output {
 ##        type            "fifo"
@@ -56,11 +52,9 @@
 #visualizer_fifo_path = /tmp/mpd.fifo
 #
 ##
-## Note: Below parameter is needed for ncmpcpp
-## to determine which output provides data for
-## visualizer and thus allow syncing between
-## visualization and sound as currently there
-## are some problems with it.
+## Note: Below parameter is needed for ncmpcpp to determine which output
+## provides data for visualizer and thus allow syncing between visualization and
+## sound as currently there are some problems with it.
 ##
 #
 #visualizer_output_name = Visualizer feed
@@ -71,18 +65,17 @@
 #visualizer_in_stereo = yes
 #
 ##
-## Note: Below parameter defines how often ncmpcpp
-## has to "synchronize" visualizer and audio outputs.
-## 30 seconds is optimal value, but if you experience
-## synchronization problems, set it to lower value.
-## Keep in mind that sane values start with >=10.
+## Note: Below parameter defines how often ncmpcpp has to "synchronize"
+## visualizer and audio outputs.  30 seconds is optimal value, but if you
+## experience synchronization problems, set it to lower value.  Keep in mind
+## that sane values start with >=10.
 ##
 #
 #visualizer_sync_interval = 30
 #
 ##
-## Note: To enable spectrum frequency visualization
-## you need to compile ncmpcpp with fftw3 support.
+## Note: To enable spectrum frequency visualization you need to compile ncmpcpp
+## with fftw3 support.
 ##
 #
 ## Available values: spectrum, wave, wave_filled, ellipse.
@@ -99,25 +92,22 @@
 #
 ##### system encoding #####
 ##
-## ncmpcpp should detect your charset encoding
-## but if it failed to do so, you can specify
-## charset encoding you are using here.
+## ncmpcpp should detect your charset encoding but if it failed to do so, you
+## can specify charset encoding you are using here.
 ##
-## Note: You can see whether your ncmpcpp build
-## supports charset detection by checking output
-## of `ncmpcpp --version`.
+## Note: You can see whether your ncmpcpp build supports charset detection by
+## checking output of `ncmpcpp --version`.
 ##
-## Note: Since MPD uses UTF-8 by default, setting
-## this option makes sense only if your encoding
-## is different.
+## Note: Since MPD uses UTF-8 by default, setting this option makes sense only
+## if your encoding is different.
 ##
 #
 #system_encoding = ""
 #
 ##### delays #####
 #
-## Time of inactivity (in seconds) after playlist
-## highlighting will be disabled (0 = always on).
+## Time of inactivity (in seconds) after playlist highlighting will be disabled
+## (0 = always on).
 ##
 #playlist_disable_highlight_delay = 5
 #
@@ -147,21 +137,20 @@
 ## %P - priority
 ## $R - begin right alignment
 ##
-## If you want to make sure that a part of the format is displayed
-## only when certain tags are present, you can archieve it by
-## grouping them with brackets, e.g. '{%a - %t}' will be evaluated
-## to 'ARTIST - TITLE' if both tags are present or '' otherwise.
-## It is also possible to define a list of alternatives by providing
-## several groups and separating them with '|', e.g. '{%t}|{%f}'
-## will be evaluated to 'TITLE' or 'FILENAME' if the former is not
-## present.
+## If you want to make sure that a part of the format is displayed only when
+## certain tags are present, you can archieve it by grouping them with brackets,
+## e.g. '{%a - %t}' will be evaluated to 'ARTIST - TITLE' if both tags are
+## present or '' otherwise.  It is also possible to define a list of
+## alternatives by providing several groups and separating them with '|',
+## e.g. '{%t}|{%f}' will be evaluated to 'TITLE' or 'FILENAME' if the former is
+## not present.
 ##
-## Note: If you want to set limit on maximal length of a tag, just
-## put the appropriate number between % and character that defines
-## tag type, e.g. to make album take max. 20 terminal cells, use '%20b'.
+## Note: If you want to set limit on maximal length of a tag, just put the
+## appropriate number between % and character that defines tag type, e.g. to
+## make album take max. 20 terminal cells, use '%20b'.
 ##
-## In addition, formats support markers used for text attributes.
-## They are followed by character '$'. After that you can put:
+## In addition, formats support markers used for text attributes.  They are
+## followed by character '$'. After that you can put:
 ##
 ## - 0 - default window color (discards all other colors)
 ## - 1 - black
@@ -178,18 +167,17 @@
 ## - r - reverse colors
 ## - a - use alternative character set
 ##
-## If you don't want to use a non-color attribute anymore, just put it
-## again, but this time insert character '/' between '$' and attribute
-## character, e.g. {$b%t$/b}|{$r%f$/r} will display bolded title tag
-## or filename with reversed colors.
+## If you don't want to use a non-color attribute anymore, just put it again,
+## but this time insert character '/' between '$' and attribute character,
+## e.g. {$b%t$/b}|{$r%f$/r} will display bolded title tag or filename with
+## reversed colors.
 ##
-## If you want to use 256 colors and/or background colors in formats
-## (the naming scheme is described below in section about color
-## definitions), it can be done with the syntax $(COLOR), e.g. to set
-## the artist tag to one of the non-standard colors and make it have
-## yellow background, you need to write $(197_yellow)%a$(end). Note
-## that for standard colors this is interchangable with attributes
-## listed above.
+## If you want to use 256 colors and/or background colors in formats (the naming
+## scheme is described below in section about color definitions), it can be done
+## with the syntax $(COLOR), e.g. to set the artist tag to one of the
+## non-standard colors and make it have yellow background, you need to write
+## $(197_yellow)%a$(end). Note that for standard colors this is interchangable
+## with attributes listed above.
 ##
 ## Note: colors can be nested.
 ##
@@ -222,11 +210,10 @@
 ##
 #song_window_title_format = {%a - }{%t}|{%f}
 ##
-## Note: Below variables are used for sorting songs in browser.
-## The sort mode determines how songs are sorted, and can be used
-## in combination with a sort format to specify a custom sorting format.
-## Available values for browser_sort_mode are "name", "mtime", "format"
-## and "noop".
+## Note: Below variables are used for sorting songs in browser.  The sort mode
+## determines how songs are sorted, and can be used in combination with a sort
+## format to specify a custom sorting format.  Available values for
+## browser_sort_mode are "name", "mtime", "format" and "noop".
 ##
 #
 #browser_sort_mode = name
@@ -241,14 +228,13 @@
 ##
 ## (width of the column)[color of the column]{displayed tag}
 ##
-## Note: Width is by default in %, if you want a column to
-## have fixed size, add 'f' after the value, e.g. (10)[white]{a}
-## will be the column that take 10% of screen (so the real width
-## will depend on actual screen size), whereas (10f)[white]{a}
-## will take 10 terminal cells, no matter how wide the screen is.
+## Note: Width is by default in %, if you want a column to have fixed size, add
+## 'f' after the value, e.g. (10)[white]{a} will be the column that take 10% of
+## screen (so the real width will depend on actual screen size), whereas
+## (10f)[white]{a} will take 10 terminal cells, no matter how wide the screen
+## is.
 ##
-## - color is optional (if you want the default one,
-##   leave the field empty).
+## - color is optional (if you want the default one, leave the field empty).
 ##
 ## Note: You can give a column additional attributes by putting appropriate
 ## character after displayed tag character. Available attributes are:
@@ -258,16 +244,15 @@
 ##
 ## You can also:
 ##
-## - give a column custom name by putting it after attributes,
-##   separated with character ':', e.g. {lr:Length} gives you
-##   right aligned column of lengths named "Length".
+## - give a column custom name by putting it after attributes, separated with
+##   character ':', e.g. {lr:Length} gives you right aligned column of lengths
+##   named "Length".
 ##
-## - define sequence of tags, that have to be displayed in case
-##   predecessor is empty in a way similar to the one in classic
-##   song format, i.e. using '|' character, e.g. {a|c|p:Owner}
-##   creates column named "Owner" that tries to display artist
-##   tag and then composer and performer if previous ones are
-##   not available.
+## - define sequence of tags, that have to be displayed in case predecessor is
+##   empty in a way similar to the one in classic song format, i.e. using '|'
+##   character, e.g. {a|c|p:Owner} creates column named "Owner" that tries to
+##   display artist tag and then composer and performer if previous ones are not
+##   available.
 ##
 #
 #song_columns_list_format = (20)[]{a} (6f)[green]{NE} (50)[white]{t|f:Title} (20)[cyan]{b} (7f)[magenta]{l}
@@ -275,16 +260,15 @@
 ##### various settings #####
 #
 ##
-## Note: Custom command that will be executed each
-## time song changes. Useful for notifications etc.
+## Note: Custom command that will be executed each time song changes. Useful for
+## notifications etc.
 ##
 #execute_on_song_change = ""
 #
 ##
-## Note: Custom command that will be executed each
-## time player state changes. The environment variable
-## MPD_PLAYER_STATE is set to the current state (either
-## unknown, play, pause, or stop) for its duration.
+## Note: Custom command that will be executed each time player state
+## changes. The environment variable MPD_PLAYER_STATE is set to the current
+## state (either unknown, play, pause, or stop) for its duration.
 ##
 #
 #execute_on_player_state_change = ""
@@ -323,8 +307,8 @@
 #centered_cursor = no
 #
 ##
-## Note: You can specify third character which will
-## be used to build 'empty' part of progressbar.
+## Note: You can specify third character which will be used to build 'empty'
+## part of progressbar.
 ##
 #progressbar_look = =>
 #
@@ -373,10 +357,9 @@
 #allow_for_physical_item_deletion = no
 #
 ##
-## Note: If you set this variable, ncmpcpp will try to
-## get info from last.fm in language you set and if it
-## fails, it will fall back to english. Otherwise it will
-## use english the first time.
+## Note: If you set this variable, ncmpcpp will try to get info from last.fm in
+## language you set and if it fails, it will fall back to english. Otherwise it
+## will use english the first time.
 ##
 ## Note: Language has to be expressed as an ISO 639 alpha-2 code.
 ##
@@ -392,30 +375,27 @@
 ## - "previous" - switch between the current and previous screen.
 ## - "screen1,...,screenN" - switch between given sequence of screens.
 ##
-## Screens available for use: help, playlist, browser,
-## search_engine, media_library, playlist_editor, tag_editor,
-## outputs, visualizer, clock, lyrics, last_fm.
+## Screens available for use: help, playlist, browser, search_engine,
+## media_library, playlist_editor, tag_editor, outputs, visualizer, clock,
+## lyrics, last_fm.
 ##
 #screen_switcher_mode = playlist, browser
 #
 ##
-## Note: You can define startup screen
-## by choosing screen from the list above.
+## Note: You can define startup screen by choosing screen from the list above.
 ##
 #startup_screen = playlist
 #
 ##
-## Note: You can define startup slave screen
-## by choosing screen from the list above or
-## an empty value for no slave screen.
+## Note: You can define startup slave screen by choosing screen from the list
+## above or an empty value for no slave screen.
 ##
 #startup_slave_screen = ""
 #
 #startup_slave_screen_focus = no
 #
 ##
-## Default width of locked screen (in %).
-## Acceptable values are from 20 to 80.
+## Default width of locked screen (in %).  Acceptable values are from 20 to 80.
 ##
 #
 #locked_screen_width_part = 50
@@ -439,9 +419,8 @@
 #regular_expressions = perl
 #
 ##
-## Note: If below is enabled, ncmpcpp will ignore leading
-## "The" word while sorting items in browser, tags in
-## media library, etc.
+## Note: If below is enabled, ncmpcpp will ignore leading "The" word while
+## sorting items in browser, tags in media library, etc.
 ##
 #ignore_leading_the = no
 #
@@ -462,15 +441,17 @@
 #enable_window_title = yes
 #
 ##
-## Note: You can choose default search mode for search
-## engine. Available modes are:
+## Note: You can choose default search mode for search engine. Available modes
+## are:
 ##
 ## - 1 - use mpd built-in searching (no regexes, pattern matching)
-## - 2 - use ncmpcpp searching (pattern matching with support for regexes,
-##       but if your mpd is on a remote machine, downloading big database
-##       to process it can take a while
-## - 3 - match only exact values (this mode uses mpd function for searching
-##       in database and local one for searching in current playlist)
+##
+## - 2 - use ncmpcpp searching (pattern matching with support for regexes, but
+##       if your mpd is on a remote machine, downloading big database to process
+##       it can take a while
+##
+## - 3 - match only exact values (this mode uses mpd function for searching in
+##       database and local one for searching in current playlist)
 ##
 #
 #search_engine_default_search_mode = 1
@@ -483,38 +464,33 @@
 #
 ##### colors definitions #####
 ##
-## It is possible to set a background color by setting a color
-## value "<foreground>_<background>", e.g. red_black will set
-## foregound color to red and background color to black.
+## It is possible to set a background color by setting a color value
+## "<foreground>_<background>", e.g. red_black will set foregound color to red
+## and background color to black.
 ##
-## In addition, for terminals that support 256 colors it
-## is possible to set one of them by using a number in range
-## [1, 256] instead of color name, e.g. numerical value
-## corresponding to red_black is 2_1. To find out if the
-## terminal supports 256 colors, run ncmpcpp and check out
-## the bottom of the help screen for list of available colors
-## and their numerical values.
+## In addition, for terminals that support 256 colors it is possible to set one
+## of them by using a number in range [1, 256] instead of color name,
+## e.g. numerical value corresponding to red_black is 2_1. To find out if the
+## terminal supports 256 colors, run ncmpcpp and check out the bottom of the
+## help screen for list of available colors and their numerical values.
 ##
-## What is more, there are two special values for the background
-## color: "transparent" and "current". The first one explicitly sets
-## the background to be transparent, while the second one allows you
-## to preserve current background color and change only the foreground
-## one. It's used implicitly when background color is not specified.
+## What is more, there are two special values for the background color:
+## "transparent" and "current". The first one explicitly sets the background to
+## be transparent, while the second one allows you to preserve current
+## background color and change only the foreground one. It's used implicitly
+## when background color is not specified.
 ##
-## Moreover, it is possible to attach format information to
-## selected color variables by appending to their end a
-## colon followed by one or more format flags, e.g. black:b
-## or red:ur. The following variables support this syntax:
-## visualizer_color, color1, color2, empty_tag_color,
-## volume_color, state_line_color, state_flags_color,
-## progressbar_color, progressbar_elapsed_color,
-## player_state_color, statusbar_time_color,
+## Moreover, it is possible to attach format information to selected color
+## variables by appending to their end a colon followed by one or more format
+## flags, e.g. black:b or red:ur. The following variables support this syntax:
+## visualizer_color, color1, color2, empty_tag_color, volume_color,
+## state_line_color, state_flags_color, progressbar_color,
+## progressbar_elapsed_color, player_state_color, statusbar_time_color,
 ## alternative_ui_separator_color.
 ##
-## Note: due to technical limitations of older ncurses
-## version, if 256 colors are used there is a possibility
-## that you'll be able to use only colors with transparent
-## background.
+## Note: due to technical limitations of older ncurses version, if 256 colors
+## are used there is a possibility that you'll be able to use only colors with
+## transparent background.
 #
 #colors_enabled = yes
 #