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