man/notion.in

   1 .TH NOTION 1
   2 .SH NAME
   3 Notion - an X11 window manager
   4 .SH SYNOPSIS
   5 .B notion
   6 .I "[options]"
   7 .SH "DESCRIPTION"
   8
   9 Notion 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 (~/.notion/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 Notion 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 Notion 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. A workspace containing no tilings and only detached/floating
  57 windows is also called a \fBfloating workspace\fP. Tilings themselves contain
  58 \fBframes\fP tiled to fill the screen, and possibly a statusbar or dock. Akin
  59 to screens, frames multiplex other objects, but in this case mostly client
  60 window \fBgroups\fP. Most of the time, frames are the only trace of Notion
  61 you see on the screen. Frames may have border decorations, and they have a
  62 \fBtab\fP for each multiplexed object.
  63
  64 \fBQueries\fP are boxes that appear at the bottoms of frames or screens
  65 to ask you for textual input to execute an action that depends on it.
  66 Most queries support tab-completion.
  67
  68
  69 .SH BINDINGS
  70 These are the default key and pointer bindings. Below, \fBMod4\fP refers to the
  71 modifier used by Notion. \fBMod4\fP is the default, but this can be configured
  72 by setting \fBMETA\fP in the configuration. The particular key that is
  73 interpreted as \fBMod4\fP depends on your system. On Xorg-based systems it is
  74 usually bound to the \fBwindows\fP key. The \fIxmodmap(1x)\fP tool can be used
  75 to get/set which key codes correspond to which modifiers, and the \fIxev(1x)\fP
  76 tool can be used to see what codes are generated by particular keys.
  77
  78 The string in square brackets after a binding group heading below indicates
  79 the module whose configuration file defines these bindings.
  80
  81 .SS Globally available bindings
  82
  83 BINDINGS:WScreen
  84
  85 .SS Bindings operating on all frames and screens
  86
  87 BINDINGS:WMPlex
  88
  89 .SS Bindings operating on all frames
  90
  91 BINDINGS:WFrame
  92
  93 .SS Bindings operating on top-level (non-transient) frames and screens
  94
  95 BINDINGS:WMPlex.toplevel
  96
  97 .SS Bindings operating on top-level (non-transient) frames
  98
  99 BINDINGS:WFrame.toplevel
 100
 101 .SS Bindings for floating/detached frames
 102
 103 BINDINGS:WFrame.floating
 104
 105 .SS Bindings for tilings and tiled frames [mod_tiling]
 106
 107 BINDINGS:WTiling
 108 .\" BINDINGS:WFrame.tiled
 109
 110 .SS Bindings for client windows
 111
 112 BINDINGS:WClientWin
 113 BINDINGS:WGroupCW
 114
 115 .SS Move/resize mode bindings
 116
 117 BINDINGS:WMoveresMode
 118
 119 .SS Bindings for message boxes and queries [mod_query]
 120
 121 BINDINGS:WInput
 122
 123 .SS Bindings for editing in queries [mod_query]
 124
 125 These bindings are similar to those of the \fIjoe(1)\fP text editor.
 126 Cut, copy and paste works in a more conventional manner, though, but
 127 the keys are equivalent.
 128
 129 BINDINGS:WEdln
 130
 131 .SS Bindings for menus [mod_menu]
 132
 133 BINDINGS:WMenu
 134
 135
 136 .SH FILES AND DIRECTORIES
 137 .TP
 138 .B ETCDIR/cfg_notion.lua
 139 System default main configuration files
 140 .TP
 141 .B ETCDIR/cfg_*.lua
 142 Other configuration files.
 143 .TP
 144 .B ETCDIR/look_*.lua
 145 Colour scheme configuration files
 146 .TP
 147 .B ~/.notion/
 148 User configuration files
 149 .TP
 150 .B ~/.notion/cfg_notion.lua
 151 User default main configuration file (overrides system default)
 152
 153 .SH SEE ALSO
 154 The Notion home page, \fIhttp://notion.sf.net/\fP
 155 .PP
 156 The document "Configuring and extending Notion with Lua" found on the
 157 Notion home page.
 158 .PP
 159 .I DOCDIR/
 160 .PP
 161 \fIX(7x)\fP, \fInotionflux(1)\fP, \fIjoe(1)\fP
 162
 163 .SH AUTHOR
 164 Notion was written by the Notion team, based on Ion which was written by Tuomo Valkonen <tuomov at iki.fi>.