Code

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