doc/config.example

   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
  11
  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
  15
  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. The first argument describes how the key
  19 # behaves when a repeat count is used (typing a series of numbers before
  20 # pressing the key). A type of 'set' will append the repeat count to the
  21 # command, 'repeat' will send the command the amount of times specified by the
  22 # repeat count and 'none' will send the command only once, unaltered.
  23 #
  24 # Typing '23P' in play mode will send "depth 23" to the engine.
  25 #bind   set     P       depth
  26 #
  27 # Typing '23$' in play mode will send "something" to the engine 23 times.
  28 #bind   repeat  $       something
  29 #
  30 # Only send "depth 1" to the engine.
  31 #bine   none    !       depth 1
  32
  33 # The number of moves to jump when browsing move history and pressing the UP
  34 # or DOWN keys.
  35 jump_count      5
  36
  37 # If set, the default directory where games will be saved to and opened from.
  38 # Tildes '~' and environment variables are supported.
  39 #save_directory /some/path
  40
  41 # When saving a game, prompt to edit PGN data. When saving in history mode,
  42 # prompt for the history type. If off, you can override it using the ingame 'S'
  43 # command. BOOL
  44 save_prompt     on
  45
  46 # When deleting games with the 'X' command and this is on, prompt before
  47 # deleting. BOOL
  48 delete_prompt   on
  49
  50 # If enabled, chess board line graphics will be drawn. BOOL
  51 line_graphics   on
  52
  53 # If on, show valid moves for the selected piece. BOOL
  54 valid_moves     on
  55
  56 # When enabled castling availability and the en passasnt square will be shown
  57 # on the board. This can be toggled with the `d' key. BOOL
  58 board_details   off
  59
  60 # If enabled and there is a parsing error when loading a file, stop processing
  61 # immediately. Normally a game or round will be flagged as having an error and
  62 # other games will be loaded. BOOL
  63 stop_on_error   off
  64
  65 # The number of full moves to write per linea (up to 80 columns) when saving a
  66 # game. If 0, then try and fit as many as possible in 80 columns.
  67 mpl             0
  68
  69 # Custom roster tags to add to new games and existing games with the -t
  70 # switch. If an existing tag with the same name exists then the tag will be
  71 # updated with the new value. You can specify as many tags as needed.
  72 #tag            White   Ben Kibbey
  73
  74 # When browsing files in the file browser filter files in the current
  75 # directory according to the specified pattern. If save_directory is defined
  76 # then the pattern will be appended to that value. Directories (including
  77 # hidden) are always displayed reguardless of the pattern.
  78 #pattern                *.pgn
  79
  80 # Below are color and attribute settings. These parameters may contain up to
  81 # four values. The first and second are the foreground and background color
  82 # names which must be one of: black, white, red, magenta, yellow, blue, cyan
  83 # or green.
  84 #
  85 # Each ..._window parameter sets the defaults for all characters in the
  86 # associated window.
  87 #
  88 # The third and fourth values are attributes for the color and non-color
  89 # terminal. To include more than one attribute for a value, separate them with
  90 # a single comma. The following attributes are available: bold, blink,
  91 # reverse, dim, standout, underline, invisible, or none. Note that not all
  92 # terminals support all attributes.
  93 color_board_window              white   black
  94 color_board_graphics            white   black
  95 color_board_selected            white   yellow  none    bold,reverse
  96 color_board_cursor              white   green   none    bold,reverse
  97 color_board_black               white   black
  98 color_board_white               white   red     none    reverse
  99 color_board_coords              yellow  black   bold
 100 color_board_count               magenta cyan    bold    bold,reverse
 101 color_board_white_moves white   magenta none    reverse
 102 color_board_black_moves white   blue    none    reverse
 103
 104 color_status_window     white   black
 105 color_status_title      white   blue    none    reverse
 106 color_status_border     cyan    black
 107 color_status_notify     green   black   none    bold
 108 color_status_engine     yellow  black   none    bold
 109
 110 color_tag_window        white   black
 111 color_tag_title white   blue    none    reverse
 112 color_tag_border        cyan    black
 113
 114 color_history_window    white   black
 115 color_history_title     white   blue    none    reverse
 116 color_history_border    cyan    black
 117
 118 color_message_window    white   black
 119 color_message_title     white   magenta none    reverse
 120 color_message_border    cyan    black
 121 color_message_prompt    white   magenta none    bold
 122
 123 color_input_window      white   black
 124 color_input_title       white   magenta none    reverse
 125 color_input_border      cyan    black
 126 color_input_prompt      white   magenta none    bold
 127
 128 color_menu              white   blue    none    none
 129 color_menu_selected     white   red     none    bold
 130 color_menu_highlight    yellow  red     bold    bold