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
  71 These are the default key and pointer bindings. (\fBMod1\fP) depends on your
  72 system. On PC:s with XFree86 it is probably bound to the left Alt key
  73 (\fBAlt_L\fP). On Suns it is usually bound to the diamond keys
  74 (\fBMeta_L\fP, \fBMeta_R\fP). Use \fIxmodmap(1x)\fP to find out.
  75
  76 The string in square brackets after a binding group heading below indicates
  77 the module whose configuration file defines these bindings.
  78
  79 .SS Globally available bindings
  80
  81 BINDINGS:WScreen
  82
  83 .SS Bindings operating on all frames and screens
  84
  85 BINDINGS:WMPlex
  86
  87 .SS Bindings operating on all frames
  88
  89 BINDINGS:WFrame
  90
  91 .SS Bindings operating on top-level (non-transient) frames and screens
  92
  93 BINDINGS:WMPlex.toplevel
  94
  95 .SS Bindings operating on top-level (non-transient) frames
  96
  97 BINDINGS:WFrame.toplevel
  98
  99 .SS Bindings for floating/detached frames
 100
 101 BINDINGS:WFrame.floating
 102
 103 .SS Bindings for tilings and tiled frames [mod_tiling]
 104
 105 BINDINGS:WTiling
 106 .\" BINDINGS:WFrame.tiled
 107
 108 .SS Bindings for client windows
 109
 110 BINDINGS:WClientWin
 111 BINDINGS:WGroupCW
 112
 113 .SS Move/resize mode bindings
 114
 115 BINDINGS:WMoveresMode
 116
 117 .SS Bindings for message boxes and queries [mod_query]
 118
 119 BINDINGS:WInput
 120
 121 .SS Bindings for editing in queries [mod_query]
 122
 123 These bindings are similar to those of the \fIjoe(1)\fP text editor.
 124 Cut, copy and paste works in a more conventional manner, though, but
 125 the keys are equivalent.
 126
 127 BINDINGS:WEdln
 128
 129 .SS Bindings for menus [mod_menu]
 130
 131 BINDINGS:WMenu
 132
 133
 134 .SH FILES AND DIRECTORIES
 135 .TP
 136 .B ETCDIR/cfg_notion.lua
 137 System default main configuration files
 138 .TP
 139 .B ETCDIR/cfg_*.lua
 140 Other configuration files.
 141 .TP
 142 .B ETCDIR/look_*.lua
 143 Colour scheme configuration files
 144 .TP
 145 .B ~/.notion/
 146 User configuration files
 147 .TP
 148 .B ~/.notion/cfg_notion.lua
 149 User default main configuration file (overrides system default)
 150
 151 .SH SEE ALSO
 152 The Notion home page, \fIhttp://notion.sf.net/\fP
 153 .PP
 154 The document "Configuring and extending Notion with Lua" found on the
 155 Notion home page.
 156 .PP
 157 .I DOCDIR/
 158 .PP
 159 \fIX(7x)\fP, \fIjoe(1)\fP
 160
 161 .SH AUTHOR
 162 Notion was written by the Notion team, based on Ion which was written by Tuomo Valkonen <tuomov at iki.fi>.