doc/config.txt

   1 #
   2 # Here is the structure and options of Ion configuration file commented.
   3 #
   4
   5 # Include another file
   6 include "file"
   7
   8 # Double click delay (default: 250ms)
   9 dblclick_delay msec
  10
  11 # Timeout before automatically leaving resize mode (default: 1.5s)
  12 resize_delay msec
  13
  14 # Opaque resize? (default: no)
  15 opaque_resize TRUE/FALSE
  16
  17
  18 # Screen <screennum> specific settings
  19 screen <screennum> {
  20         # Font used in terminal emulators (xterm, etc.)
  21         # CF_WIDTH/HEIGHT_UNIT that grow/shrink use are taken from this.
  22         term_font "font"
  23
  24         # Font
  25         font "fontname"
  26
  27         # Tab font
  28         tab_font "fontname"
  29
  30         # Frame border
  31         #  tl - top and left border width
  32         #  br - bottom and right border width
  33         #  ipad - contents padding
  34         frame_border tl, br, ipad
  35
  36         # Tab border
  37         tab_border tl, br, ipad
  38
  39         # Input (line-editor) border
  40         input_border tl, br, ipad
  41
  42         # Frame and tab spacing
  43         spacing pixels
  44
  45         # Place bar inside or outside frame border?
  46         bar_inside_frame TRUE/FALSE?
  47
  48         # Active frame, unselected tab colors
  49         #  tl - top and left border
  50         #  br - bottom and right border
  51         #  bg - background
  52         #  fg - foreground (text)
  53         # The colors are normal X color specifications. See the
  54         # manual page for XParserColor(3x) for more.
  55         act_tab_colors "tl", "br", "bg", "fg"
  56
  57         # Active frame, selected tab colors
  58         act_tab_sel_colors "tl", "br", "bg", "fg"
  59
  60         # Inactive frame, unselected tab colors
  61         tab_colors "tl", "br", "bg", "fg"
  62
  63         # Inactive frame, selected tab clors
  64         tab_sel_colors "tl", "br", "bg", "fg"
  65
  66         # Frame colors
  67         frame_colors "tl", "br", "bg", "fg"
  68
  69         # Workspace background
  70         background_color "bg"
  71
  72         # Input (line-editor) colors
  73         input_colors "tl", "br", "bg", "fg"
  74
  75         # Selected text colors
  76         selection_colors "bg", "fg"
  77 }
  78
  79
  80 # Settings for window "class.instance"  (e.g. XTerm.xterm)
  81 winprop "class.instance" {
  82         # Maximum size (overrides size hints)
  83         max_size w, h
  84
  85         # Aspect ratio (overrides size hints)
  86         aspect w, h
  87
  88         # Kludge to get acrobat reader work
  89         acrobatic
  90
  91         # Switch to newly created client? (default: yes)
  92         switchto TRUE/FALSE
  93
  94         # Stubborn window placement? Used with CF_PLACEMENT_GEOM
  95         # to ignore client-supplied coordinates of badly behaving
  96         # windows. (default: no)
  97         stubborn TRUE/FALSE
  98
  99         # current - force window become a transient for active client
 100         # off - force window not be interpreted as a transient
 101         transient_mode normal|current|off
 102 }
 103
 104
 105 # Key and pointer bindings
 106 # Key names are passed to XStringToKeysym and are those defined in
 107 # /whereever_x_is/include/keysymdef.h without the XK_ -prefix.
 108 bindings {
 109         # Set default modifier
 110         set_mod "modifier"
 111
 112         # Key press
 113         kpress "[modifiers+]key", "function" [, args]
 114
 115         # Key press, wait for pointer release
 116         kpress_waitrel "[modifiers+]key", "function" [, args]
 117
 118         # Pointer button press
 119         mpress "[modifiers+]ButtonX", "function" [, args]
 120
 121         # Pointer drag
 122         mdrag "[modifiers+]ButtonX", "function" [, args]
 123
 124         # Click
 125         mclick "[modifiers+]ButtonX", "function" [, args]
 126
 127         # Double click
 128         mdblclick "[modifiers+]ButtonX", "function" [, args]
 129
 130         submap "[modifiers+]key" {
 131                 # ...
 132         }
 133 }
 134
 135
 136 # Line-editor bindings
 137 edln_bindings {
 138         # ...
 139 }
 140
 141
 142 # Tab bindings (keys not useful)
 143 tab_bindings {
 144         # ...
 145 }
 146
 147
 148 # Resize-mode bindings
 149 moveres_bindings {
 150         # ...
 151 }