man/ion3.in

   1 .TH ION 1
   2 .SH NAME
   3 Ion - an X11 window manager
   4 .SH SYNOPSIS
   5 .B ion3
   6 .I "[options]"
   7 .SH "DESCRIPTION"
   8
   9 Ion is a tiling tabbed window manager designed with keyboard users in mind.
  10
  11 .SH "OPTIONS"
  12 .TP
  13 .B \-display host:display.screen
  14 X display to manage
  15 .TP
  16 .B \-conffile configfile
  17 Configuration file to use instead of default
  18 .TP
  19 .B \-searchdir dir
  20 Directory to search for configuration files and other scripts
  21 .TP
  22 .B \-oneroot
  23 On X servers with multiple (traditional non-Xinerama) screens, manage only
  24 default screen (root window), not all, as given by the -display option or
  25 in the DISPLAY environment variable.
  26 .TP
  27 .B \-session session_name
  28 Set session name. This option affects where workspace and other save files are
  29 put (~/.ion3/session_name if option set).
  30 .TP
  31 .B \-xinerama 0|1
  32 If Ion was compiled with Xinerama support, this option can be used to
  33 enable/disable (1/0) the use of it. The default is to use Xinerama
  34 screen information.
  35 .TP
  36 .B \-help
  37 Show help on command line options
  38 .TP
  39 .B \-version
  40 Show version
  41 .TP
  42 .B \-about
  43 Show about text (version, copyright)
  44
  45 .SH BASIC CONCEPTS
  46
  47 This section is an overview of the types objects that appear on an X
  48 display managed by Ion and their relationships in a standard setup. This
  49 information is necessary to understand the operations and availability
  50 of the different key bindings explained below. For a more detailed
  51 explanation, needed for writing custom bindings configuration files,
  52 see the additional documentation available from the Ion Web page.
  53
  54 The top-level objects that matter in the case at hand are \fBscreens\fP.
  55 They correspond to physical screens. Screens contain \fBworkspaces\fP
  56 (which are a kind of \fBgroup\fP), and \fBclient windows\fP put into full
  57 screen mode. These objects are \fBmultiplexed\fP in the sense that only
  58 one can be displayed at a time.
  59
  60 Workspaces themselves may contain \fBtilings\fP and detached/floating
  61 \fBframes\fP. Tilings themselves contain \fBframes\fP tiled to fill the
  62 screen, and possibly a statusbar or dock. Akin to screens, frames multiplex
  63 other objects, but in this case mostly client window \fBgroups\fP. Most of
  64 the time, frames are the only trace of Ion you see on the screen. Frames
  65 may have border decorations, and they have a \fBtab\fP for each multiplexed
  66 object.
  67
  68 \fBQueries\fP are boxes that appear at the bottoms of frames or screens
  69 to ask you for textual input to execute an action that depends on it.
  70 Most queries support tab-completion.
  71
  72
  73 .SH BINDINGS
  74
  75 These are the default key and pointer bindings. (\fBMod1\fP) depends on your
  76 system. On PC:s with XFree86 it is probably bound to the left Alt key
  77 (\fBAlt_L\fP). On Suns it is usually bound to the diamond keys
  78 (\fBMeta_L\fP, \fBMeta_R\fP). Use \fIxmodmap(1x)\fP to find out.
  79
  80 The string in square brackets after a binding group heading below indicates
  81 the module that whose configuration file defines these bindings.
  82
  83 .SS Globally available bindings
  84
  85 BINDINGS:WScreen
  86
  87 .SS Bindings operating on top-level frames and screens and their children
  88
  89 BINDINGS:WMPlex.toplevel
  90
  91 .SS Bindings operating on frames and screens and their children
  92
  93 BINDINGS:WMPlex
  94
  95 .SS Bindings operating on all frames (including transient) and their children
  96
  97 BINDINGS:WFrame
  98
  99 .SS Bindings operating on top-level (non-transient) frames and their children
 100
 101 BINDINGS:WFrame.toplevel
 102
 103 .SS Bindings for floating/detached frames
 104
 105 BINDINGS:WFloatFrame
 106
 107 .SS Bindings for tilings and tiled frames [mod_tiling]
 108
 109 BINDINGS:WTiling
 110 BINDINGS:WFrame-on-WTiling
 111
 112 .SS Bindings for client windows
 113
 114 BINDINGS:WClientWin
 115
 116 BINDINGS:WGroupCW
 117
 118 .SS Move/resize mode bindings
 119
 120 BINDINGS:WMoveresMode
 121
 122 .SS Bindings for message boxes and queries [mod_query]
 123
 124 BINDINGS:WInput
 125
 126 .SS Bindings for editing in queries [mod_query]
 127
 128 These bindings are similar to those of the \fIjoe(1)\fP text editor.
 129 Cut, copy and paste works in a more conventional manner, though, but
 130 the keys are equivalent.
 131
 132 BINDINGS:WEdln
 133
 134 .SS Bindings for menus [mod_menu]
 135
 136 BINDINGS:WMenu
 137
 138
 139 .SH FILES AND DIRECTORIES
 140 .TP
 141 .B ETCDIR/cfg_ion.lua
 142 System default main configuration files
 143 .TP
 144 .B ETCDIR/cfg_*.lua
 145 Other configuration files.
 146 .TP
 147 .B ETCDIR/look_*.lua
 148 Colour scheme configuration files
 149 .TP
 150 .B ~/.ion3/
 151 User configuration files
 152 .TP
 153 .B ~/.ion3/cfg_ion.lua
 154 User default main configuration file (overrides system default)
 155
 156 .SH SEE ALSO
 157 The Ion home page, \fIhttp://iki.fi/tuomov/ion/\fP
 158 .PP
 159 The document "Ion: Configuring and extending with Lua" found on the
 160 Ion home page.
 161 .PP
 162 .I DOCDIR/
 163 .PP
 164 \fIX(7x)\fP, \fIpwm3(1)\fP, \fIjoe(1)\fP
 165
 166 .SH AUTHOR
 167 Ion was written by Tuomo Valkonen <tuomov at iki.fi>.