doc:
  short_help: Configuration for the 'zile' text editor

args:
  var_name:
    doc:
      short_help: The config variable name.
    type: string
    required: true
  var_value:
    doc:
      short_help: The config variable value.
    type: string
    required: true
  vars_dict:
    doc:
      short_help: a map of config key value pairs
    type: dict
    required: true
    cli:
      enabled: true
  key_bindings:
    required: false
    doc:
      short_help: Rebind keys.
    type: dict
    default: {}
    empty: true
    cli:
      show_default: false
  inhabit_splash_screen:
    doc:
      short_help: whether to inhibit the startup screen
      help: |
        Non-nil inhibits the startup screen.
        It also inhibits display of the initial message in the `*scratch*' buffer.
        Default value is nil.
    type: boolean
    default: false
  standard_indent:
    doc:
      short_help: default number of columns for margin-changing functions to indent
    type: integer
    min: 0
    default: 4
  tab_width:
    doc:
      short_help: distance between tab stops
      help: |
        Distance between tab stops (for display of tab characters), in columns.
        Default value is 8.
    type: integer
    min: 0
    default: 8
  tab_always_indent:
    doc:
      short_help: controls the operation of the TAB key
      help: |
        Controls the operation of the TAB key.
        If t, hitting TAB always just indents the current line.
        If nil, hitting TAB indents the current line if point is at the
        left margin or in the line's indentation, otherwise it inserts a
        "real" TAB character.
        Default value is t.
    type: boolean
    default: true
  indent_tabs_mode:
    doc:
      short_help: use tabs or whitespaces
      help: |
        If non-nil, insert-tab inserts "real" tabs; otherwise, it always inserts
        spaces.
        Default value is t.
    type: boolean
    default: true
  fill_column:
    doc:
      short_help: column beyond which automatic line-wrapping should happen
      help: |
        Column beyond which automatic line-wrapping should happen.
        Automatically becomes buffer-local when set in any fashion.
        Default value is 70.
    type: integer
    min: 0
    default: 70
  auto_fill_mode:
    doc:
      short_help: enable auto-filll-mode
      help: |
        If non-nil, Auto Fill Mode is automatically enabled.
        Default value is nil.
    default: false
    type: boolean
  kill_whole_line:
    doc:
      short_help: whether 'kill-line' with no arg starts at the beginning of line
      help: |
        If non-nil, `kill-line' with no arg at beg of line kills the whole line.
        Default value is nil.
    type: boolean
    default: false
  case_fold_search:
    doc:
      short_help: "'true' means searches ignore case"
      help: |
        Non-nil means searches ignore case.
        Default value is t.
    type: boolean
    default: true
  case_replace:
    type: boolean
    doc:
      short_help: "'true' means 'query-replace' shold preserve case in replacements"
    default: true
  ring_bell:
    doc:
      short_help: "'true' means ring the terminal bell on any error"
    type: boolean
    default: true
  highlight_nonselected_windows:
    doc:
      short_help: if 'true', highlight region even in nonselected windows
    type: boolean
    default: false
  make_backup_files:
    doc:
      short_help: "'true' means make a backup of a file the first time it is saved."
      help: |
        Non-nil means make a backup of a file the first time it is saved.
        This is done by appending `~' to the file name.
        Default value is t.
    type: boolean
    default: true
  backup_directory:
    doc:
      short_help: the directory for backup files, which must exist
      help: |
        The directory for backup files, which must exist.
        If this variable is nil, the backup is made in the original file's
        directory.
        This value is used only when `make-backup-files' is t.
        Default value is nil.
    type: string
    default: nil
  global_set_keys:
    required: false
    doc:
      short_help: rebound keys
    type: dict
    schema:
      key:
        type: string
      func:
        type: string
frecklets:
- file-with-content:
    path: '{{:: path ::}}'
    group: '{{:: group ::}}'
    owner: '{{:: owner ::}}'
    mode: '{{:: mode ::}}'
    content: ";;;; .zile configuration\n\n;; Rebind keys with:\n;; (global-set-key \"key\" 'func)\n{%:: for key, value in key_bindings.items() ::%}\n(global-set-key \"{{:: key ::}}\" '{{:: value ::}})\n{%:: endfor ::%}\n\n; Non-nil inhibits the startup screen.\n; It also inhibits display of the initial message in the `*scratch*' buffer.\n; Default value is nil.\n(setq inhibit-splash-screen {{:: inhabit_splash_screen | string_for_boolean('t', 'nil') ::}})\n\n; Default number of columns for margin-changing functions to indent.\n; Default value is 4.\n(setq standard-indent {{:: standard_indent ::}})\n\n; Distance between tab stops (for display of tab characters), in columns.\n; Default value is 8.\n(setq tab-width {{:: tab_width ::}})\n\n; Controls the operation of the TAB key.\n; If t, hitting TAB always just indents the current line.\n; If nil, hitting TAB indents the current line if point is at the\n; left margin or in the line's indentation, otherwise it inserts a\n; \"real\" TAB character.\n; Default value is t.\n(setq tab-always-indent {{:: tab_always_indent | string_for_boolean('t', 'nil') ::}})\n\n; If non-nil, insert-tab inserts \"real\" tabs; otherwise, it always inserts\n; spaces.\n; Default value is t.\n(setq indent-tabs-mode {{:: indent_tabs_mode | string_for_boolean('t', 'nil') ::}})\n\n; Column beyond which automatic line-wrapping should happen.\n; Automatically becomes buffer-local when set in any fashion.\n; Default value is 70.\n(setq fill-column {{:: fill_column ::}})\n\n; If non-nil, Auto Fill Mode is automatically enabled.\n; Default value is nil.\n(setq auto-fill-mode {{:: auto_fill_mode | string_for_boolean('t', 'nil') ::}})\n\n; If non-nil, `kill-line' with no arg at beg of line kills the whole line.\n; Default value is nil.\n(setq kill-whole-line {{:: kill_whole_line | string_for_boolean('t', 'nil') ::}})\n\n; Non-nil means searches ignore case.\n; Default value is t.\n(setq case-fold-search {{:: case_fold_search | string_for_boolean('t', 'nil') ::}})\n\n; Non-nil means `query-replace' should preserve case in replacements.\n; Default value is t.\n(setq case-replace {{:: case_replace | string_for_boolean('t', 'nil') ::}})\n\n; Non-nil means ring the terminal bell on any error.\n; Default value is t.\n(setq ring-bell {{:: ring_bell | string_for_boolean('t', 'nil') ::}})\n\n; If non-nil, highlight region even in nonselected windows.\n; Default value is nil.\n(setq highlight-nonselected-windows {{:: highlight_nonselected_windows | string_for_boolean('t', 'nil') ::}})\n\n; Non-nil means make a backup of a file the first time it is saved.\n; This is done by appending `~' to the file name.\n; Default value is t.\n(setq make-backup-files {{:: make_backup_files | string_for_boolean('t', 'nil') ::}})\n\n; The directory for backup files, which must exist.\n; If this variable is nil, the backup is made in the original file's\n; directory.\n; This value is used only when `make-backup-files' is t.\n; Default value is nil.\n(setq backup-directory {{:: backup_directory ::}})"
meta: {}