show the path of the config files in --version output
[ncmpc.git] / doc / config.sample
blob54fa82febbe6f7dd57795d359d7d35d21a9aaa9e
1 ##
2 ## Configuration file for ncmpc (~/.ncmpc/config)
3 ##
5 ############## Connection ###################
6 ## Connect to mpd running on a specified host
7 #host = "localhost"
9 ## Connect to mpd on the specified port.
10 #port = 6600
12 ## Connect to mpd using the specified password.
13 #password = "secret"
15 ## Reconnect after NUM seconds of MPD not responding.
16 #timeout = 5
18 ############## Interface ####################
19 ## Enable mouse support (if enabled at compile time).
20 #enable-mouse = no
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
25 #screen-list = playlist browse
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
32 ## Auto center (center the playing track in the playlist)
33 #auto-center = no
35 ## Show the most recent query when using find.
36 #find-show-last = no
38 ## Wrapped find mode.
39 #find-wrap = yes
41 ## Wrapped cursor movement.
42 #wrap-around = no
44 ## Ring bell when find wraps around.
45 #bell-on-wrap = yes
47 ## Sound audible bell on alerts.
48 #audible-bell = yes
50 ## Enable visible bell on alerts.
51 #visible-bell = no
53 ## Default crossfade time in seconds.
54 #crossfade-time = 10
56 ## Seek forward/backward by NUM seconds.
57 #seek-time = 1
59 ############## Display ######################
60 ## Show a list of the screens in the top line on startup.
61 #welcome-screen-list = yes
63 ## Make the cursor as wide as the screen.
64 #wide-cursor = yes
66 ## Use the terminal's hardware cursor instead of inverse colors
67 #hardware-cursor = yes
69 ## Hide playlist cursor after x seconds (0 disables this feature).
70 #hide-cursor = 5
72 ## Scroll the title if it is too long for the screen.
73 #scroll = yes
75 ## The separator to show at the end of the scrolling title.
76 #scroll-sep = " *** "
78 ## list-format
79 ## The format used to display songs in the main window.
80 #list-format = "%name%|[%artist% - ]%title%|%file%"
82 ## The format used to display songs on the status line.
83 #status-format = "[%artist% - ]%title%|%shortfile%"
85 ## The time, in seconds, for which status messages will be displayed.
86 #status-message-time = 3
88 ## Display the time in the status bar when idle.
89 #display-time = yes
91 ## Sets whether to display remaining or elapsed time in
92 ## the status window. Default is elapsed.
93 #timedisplay-type = elapsed
95 ## Show the bitrate in the status bar when playing a stream.
96 #visible-bitrate = no
98 ## Change the XTerm title (ncmpc will not restore the title).
99 #set-xterm-title = no
101 ## The format used to for the xterm title when ncmpc is playing.
102 #xterm-title-format = "ncmpc: [ %name%|[%artist% - ]%title%|%file%]"
104 ## Automatically save the lyrics after receiving them.
105 #lyrics-autosave = no
107 ## The text editor used for editing lyrics.
108 #text-editor = emacs
110 ## Ask before starting an editor.
111 #text-editor-ask = yes
113 ## Display song length in second column
114 #second-column = yes
116 ############## Colors #######################
117 ## colors: none, black, red, green, yellow, blue, magenta, cyan, white
118 ## attributes: standout, underline, reverse, blink, dim, bold
120 ## Colors can also be given as an integer representing a terminal specific
121 ## color code. The special color, none, represents the terminals default color.
123 ## Enable/disable colors.
124 #enable-colors = no
126 ## Set the background color.
127 #color background = black
129 ## Set the text color for the title row.
130 #color title = yellow
132 ## Set the text color for the title row (the bold part).
133 #color title-bold = yellow,bold
135 ## Set the color of the line on the second row.
136 #color line = white
138 ## Set the text color used to indicate mpd flags on the second row.
139 #color line-flags = white,bold
141 ## Set the text color in the main area of ncmpc.
142 #color list = green
144 ## Set the bold text color in the main area of ncmpc.
145 #color list-bold = green,bold
147 ## Sets the text color of directories in the browser
148 #color browser-directory = yellow
150 ## Sets the text color of playlists in the browser
151 #color browser-playlist = red
153 ## Set the color of the progress indicator.
154 #color progressbar = white
156 ## Set the text color used to display mpd status in the status window.
157 #color status-state = yellow,bold
159 ## Set the text color used to display song names in the status window.
160 #color status-song  = yellow
162 ## Set the text color used to display time the status window.
163 #color status-time  = red
165 ## Text color used to display alerts in the status window.
166 #color alert = red,bold
168 ## Redefine any of the base colors.
169 ## The RGB values must be an integer value between 0 and 1000.
170 ## Note: Only some terminals allow redefinitions of colors!
171 #colordef yellow = 255, 140, 0