Added configuration parameters color_menu, color_menu_highlight and
[cboard.git] / data / config.example
blob225bda64b6f1433b2ccff99939af3bcb3f766741
1 ###############################################################################
2 # This is an example configuration file for CBoard. All of the settings below
3 # are the program defaults. Empty lines and lines beginning with '#' are
4 # ignored. Parameters and values are separated by one or more space or TAB
5 # characters and must be on the same line. Options which are noted to have a
6 # BOOL value can be one of: true, 1, yes, on OR false, 0, no, off.
7 ###############################################################################
8 # The command of the chess engine to use. Engines that support the xboard
9 # protocol should work.
10 #engine_cmd     gnuchess --xboard
12 # Send a command to the chess engine each time a new game is started or reset.
13 # Can be used more than once to specify as many commands as needed.
14 #engine_init    depth 3
16 # Sends a command to the engine when the specified key is pressed. The bound
17 # key will only be available in play mode and will only get sent if it doesn't
18 # conflict with other play mode keys.
19 #key            #       depth 3
21 # The number of moves to jump when browsing move history and pressing the UP
22 # or DOWN keys.
23 jump_count      5
25 # Show agony strings on captures. BOOL
26 agony           on
28 # Show agony strings when browsing history. If "agony" above is off, this will
29 # be off also regardless of the setting. BOOL
30 history_agony   off
32 # If set, the default directory where games will be saved to and opened from.
33 # Tildes '~' and environment variables are supported.
34 #save_directory /some/path
36 # When saving a game, prompt to edit PGN data. When saving in history mode,
37 # prompt for the history type. If off, you can override it using the ingame 'S'
38 # command. BOOL
39 save_prompt     on
41 # When deleting games with the 'X' command and this is on, prompt before
42 # deleting. BOOL
43 delete_prompt   on
45 # If enabled, chess board line graphics will be drawn. BOOL
46 line_graphics   on
48 # If on, show valid moves for the selected piece. BOOL
49 valid_moves     on
51 # If enabled and there is a parsing error when loading a file, stop processing
52 # immediately. Normally a game or round will be flagged as having an error and
53 # other games will be loaded. BOOL
54 stop_on_error   off
56 # The number of full moves to write per linea (up to 80 columns) when saving a
57 # game. If 0, then try and fit as many as possible in 80 columns.
58 mpl             0
60 # Custom roster tags to add to new games and existing games with the -t
61 # switch. If an existing tag with the same name exists then the tag will be
62 # updated with the new value. You can specify as many tags as needed.
63 #tag            White   Ben Kibbey
65 # When browsing files in the file browser filter files in the current
66 # directory according to the specified pattern. If save_directory is defined
67 # then the pattern will be appended to that value. Directories (including
68 # hidden) are always displayed reguardless of the pattern.
69 #pattern                *.pgn
71 # Below are color and attribute settings. These parameters may contain up to
72 # four values. The first and second are the foreground and background color
73 # names which must be one of: black, white, red, magenta, yellow, blue, cyan
74 # or green. 
76 # Each ..._window parameter sets the defaults for all characters in the
77 # associated window.
79 # The third and fourth values are attributes for the color and non-color
80 # terminal. To include more than one attribute for a value, separate them with
81 # a single comma. The following attributes are available: bold, blink,
82 # reverse, dim, standout, underline, invisible, or none. Note that not all
83 # terminals support all attributes.
84 color_board_window              white   black
85 color_board_graphics            white   black
86 color_board_selected            white   yellow  none    bold,reverse
87 color_board_cursor              white   green   none    bold,reverse
88 color_board_black               white   black
89 color_board_white               white   red     none    reverse
90 color_board_coords              yellow  black   bold
91 color_board_count               magenta cyan    bold    bold,reverse
92 color_board_white_moves white   magenta none    reverse
93 color_board_black_moves white   blue    none    reverse
95 color_status_window     white   black
96 color_status_title      white   blue    none    reverse
97 color_status_border     cyan    black
98 color_status_notify     green   black   none    bold
99 color_status_engine     yellow  black   none    bold
101 color_tag_window        white   black
102 color_tag_title white   blue    none    reverse
103 color_tag_border        cyan    black
105 color_history_window    white   black
106 color_history_title     white   blue    none    reverse
107 color_history_border    cyan    black
109 color_message_window    white   black
110 color_message_title     white   magenta none    reverse
111 color_message_border    cyan    black
112 color_message_prompt    white   magenta none    bold
114 color_input_window      white   black
115 color_input_title       white   magenta none    reverse
116 color_input_border      cyan    black
117 color_input_prompt      white   magenta none    bold
119 color_menu              white   blue    none    none
120 color_menu_selected     white   red     none    bold
121 color_menu_highlight    yellow  red     bold    bold