doc/ncmpc.1: migrate to Sphinx
[ncmpc-debian.git] / doc / config.sample
1 ##
2 ## Configuration file for ncmpc (~/.ncmpc/config)
3 ##
4
5 ############## Connection ###################
6 ## Connect to mpd running on a specified host
7 #host = "localhost"
8
9 ## Connect to mpd on the specified port.
10 #port = 6600
11
12 ## Connect to mpd using the specified password.
13 #password = "secret"
14
15 ## Reconnect after NUM seconds of MPD not responding.
16 #timeout = 5
17
18 ############## Interface ####################
19 ## Enable mouse support (if enabled at compile time).
20 #enable-mouse = no
21
22 ## A list of screens to cycle through when using
23 ## the previous/next screen commands (tab and shift+tab).
24 ## names: playlist browse help artist search song keydef lyrics outputs chat
25 #screen-list = playlist browse
26
27 ## Default search mode for the search screen. The mode is an
28 ## integer index, with  0  for title, 1 for artist, 2 for album,
29 ## 3 for filename, and 4 for artist+title.
30 #search-mode = 0
31
32 ## Auto center (center the playing track in the playlist)
33 #auto-center = no
34
35 ## Show the most recent query when using find.
36 #find-show-last = no
37
38 ## Wrapped find mode.
39 #find-wrap = yes
40
41 ## Wrapped cursor movement.
42 #wrap-around = no
43
44 ## Ring bell when find wraps around.
45 #bell-on-wrap = yes
46
47 ## Sound audible bell on alerts.
48 #audible-bell = yes
49
50 ## Enable visible bell on alerts.
51 #visible-bell = no
52
53 ## Default crossfade time in seconds.
54 #crossfade-time = 10
55
56 ## Seek forward/backward by NUM seconds.
57 #seek-time = 1
58
59 ############## Display ######################
60 ## Show a list of the screens in the top line on startup.
61 #welcome-screen-list = yes
62
63 ## Make the cursor as wide as the screen.
64 #wide-cursor = yes
65
66 ## Use the terminal's hardware cursor instead of inverse colors
67 #hardware-cursor = yes
68
69 ## Hide playlist cursor after x seconds (0 disables this feature).
70 #hide-cursor = 5
71
72 ## Scroll the title if it is too long for the screen.
73 #scroll = yes
74
75 ## The separator to show at the end of the scrolling title.
76 #scroll-sep = " *** "
77
78 ## list-format
79 ## The format used to display songs in the main window.
80 #list-format = "%name%|[%artist% - ]%title%|%file%"
81
82 ## The format used to display songs in the search window.
83 #search-format = "%name%|[%artist% - ]%title%|%file%"
84
85 ## The format used to display songs on the status line.
86 #status-format = "[%artist% - ]%title%|%shortfile%"
87
88 ## The time, in seconds, for which status messages will be displayed.
89 #status-message-time = 3
90
91 ## Sets whether to display remaining or elapsed time in
92 ## the status window. Default is elapsed.
93 #timedisplay-type = elapsed
94
95 ## Show the bitrate in the status bar when playing a stream.
96 #visible-bitrate = no
97
98 ## Change the XTerm title (ncmpc will not restore the title).
99 #set-xterm-title = no
100
101 ## The format used to for the xterm title when ncmpc is playing.
102 #xterm-title-format = "ncmpc: [ %name%|[%artist% - ]%title%|%file%]"
103
104 ## Automatically save the lyrics after receiving them.
105 #lyrics-autosave = no
106
107 ## The text editor used for editing lyrics.
108 #text-editor = emacs
109
110 ## Ask before starting an editor.
111 #text-editor-ask = yes
112
113 ## The prefix of chat messages
114 #chat-prefix = "<user> "
115
116 ## Display song length in second column
117 #second-column = yes
118
119 ############## Colors #######################
120 ## colors: none, black, red, green, yellow, blue, magenta, cyan, white
121 ## attributes: standout, underline, reverse, blink, dim, bold
122 ##
123 ## Colors can also be given as an integer representing a terminal specific
124 ## color code. The special color, none, represents the terminals default color.
125
126 ## Enable/disable colors.
127 #enable-colors = no
128
129 ## Set the background color.
130 #color background = black
131
132 ## Set the text color for the title row.
133 #color title = yellow
134
135 ## Set the text color for the title row (the bold part).
136 #color title-bold = yellow,bold
137
138 ## Set the color of the line on the second row.
139 #color line = white
140
141 ## Set the text color used to indicate mpd flags on the second row.
142 #color line-flags = white,bold
143
144 ## Set the text color in the main area of ncmpc.
145 #color list = green
146
147 ## Set the bold text color in the main area of ncmpc.
148 #color list-bold = green,bold
149
150 ## Sets the text color of directories in the browser
151 #color browser-directory = yellow
152
153 ## Sets the text color of playlists in the browser
154 #color browser-playlist = red
155
156 ## Set the color of the progress indicator.
157 #color progressbar = white
158
159 ## Set the text color used to display mpd status in the status window.
160 #color status-state = yellow,bold
161
162 ## Set the text color used to display song names in the status window.
163 #color status-song  = yellow
164
165 ## Set the text color used to display time the status window.
166 #color status-time  = red
167
168 ## Text color used to display alerts in the status window.
169 #color alert = red,bold
170
171 ## Redefine any of the base colors.
172 ## The RGB values must be an integer value between 0 and 1000.
173 ## Note: Only some terminals allow redefinitions of colors!
174 #colordef yellow = 255, 140, 0