
Welcome to Notion!

If you have never used Notion before, it is highly recommended that you study
the Notion manual page before proceeding further. It is reproduced below, but
you can also access it later on, for example, by pressing <F1> and then
<Enter> or, by running 'man notion' in a terminal. All this supposing that
you have installed Notion in a standard location so that the system commands
can find the manual page.

If you are too eager to try out Notion and against all recommendation want to
skip reading the manual page, you should at least know that pressing <F2>
should start a terminal emulator (xterm) and that the main menu can be
accessed with <F12>.

When you feel ready to write customized configuration files (you're going
to do that in any case), please see the configuration manual available from
the Notion webpage listed at the end of the user manual below. It may, however,
be beneficial to become well acquainted with Notion before delving into this
so that you have grasped the basic concepts necessary to understand the
binding configuration files.


---- Manual page follows ----


[4mNOTION[24m(1)                    General Commands Manual                   [4mNOTION[24m(1)

[1mNAME[0m
     Notion - an X11 window manager

[1mSYNOPSIS[0m
     [1mnotion [4m[22m[options][0m

[1mDESCRIPTION[0m
     Notion  is  a  tiling tabbed window manager designed with keyboard users in
     mind.


[1mOPTIONS[0m
     [1m-display host:display.screen[0m
            X display to manage

     [1m-conffile configfile[0m
            Configuration file to use instead of default

     [1m-searchdir dir[0m
            Directory to search for configuration files and other scripts

     [1m-oneroot[0m
            On X servers with multiple (traditional non-Xinerama) screens,  man-
            age  only  default  screen  (root  window), not all, as given by the
            -display option or in the DISPLAY environment variable.

     [1m-session session_name[0m
            Set session name. This option affects where workspace and other save
            files are put (~/.notion/session_name if option set).

     [1m-help  [22mShow help on command line options

     [1m-version[0m
            Show version

     [1m-about[0m
            Show about text (version, author, license)


[1mBASIC CONCEPTS[0m
     This section is an overview of the types objects that appear on an  X  dis-
     play  managed  by  Notion and their relationships in a standard setup. This
     information is necessary to understand the operations and  availability  of
     the  different  key  bindings explained below. For a more detailed explana-
     tion, needed for writing custom bindings configuration files, see the addi-
     tional documentation available from the Notion Web page.

     The top-level objects that matter in the case at hand  are  [1mscreens[22m.   They
     correspond  to  physical  screens.  Screens contain [1mworkspaces [22m(which are a
     kind of [1mgroup[22m), and [1mclient windows [22mput into full screen mode. These objects
     are [1mmultiplexed [22min the sense that only one can be displayed at a time.

     Workspaces themselves may contain [1mtilings [22mand detached/floating  [1mframes[22m.  A
     workspace  containing no tilings and only detached/floating windows is also
     called a [1mfloating workspace[22m. Tilings themselves  contain  [1mframes  [22mtiled  to
     fill  the screen, and possibly a statusbar or dock. Akin to screens, frames
     multiplex other objects, but in this case mostly client window [1mgroups[22m. Most
     of the time, frames are the only trace of Notion you  see  on  the  screen.
     Frames  may  have  border  decorations, and they have a [1mtab [22mfor each multi-
     plexed object.

     [1mQueries [22mare boxes that appear at the bottoms of frames or  screens  to  ask
     you  for  textual  input  to  execute  an  action that depends on it.  Most
     queries support tab-completion.



[1mBINDINGS[0m
     These are the default key and pointer bindings. Below, [1mMod4 [22mrefers  to  the
     modifier used by Notion. [1mMod4 [22mis the default, but this can be configured by
     setting  [1mMETA  [22min the configuration. The particular key that is interpreted
     as [1mMod4 [22mdepends on your system. On Xorg-based systems it is  usually  bound
     to  the  [1mwindows [22mkey. The [4mxmodmap(1x)[24m tool can be used to get/set which key
     codes correspond to which modifiers, and the [4mxev(1x)[24m tool can  be  used  to
     see what codes are generated by particular keys.

     The string in square brackets after a binding group heading below indicates
     the module that whose configuration file defines these bindings.


   [1mGlobally available bindings[0m
     [1mMod4+1[0m
            Switch  to  object  0  (workspace, full screen client window) within
            current screen.

     [1mMod4+2[0m
            Switch to object 1 (workspace, full  screen  client  window)  within
            current screen.

     [1mMod4+3[0m
            Switch  to  object  2  (workspace, full screen client window) within
            current screen.

     [1mMod4+4[0m
            Switch to object 3 (workspace, full  screen  client  window)  within
            current screen.

     [1mMod4+5[0m
            Switch  to  object  4  (workspace, full screen client window) within
            current screen.

     [1mMod4+6[0m
            Switch to object 5 (workspace, full  screen  client  window)  within
            current screen.

     [1mMod4+7[0m
            Switch  to  object  6  (workspace, full screen client window) within
            current screen.

     [1mMod4+8[0m
            Switch to object 7 (workspace, full  screen  client  window)  within
            current screen.

     [1mMod4+9[0m
            Switch  to  object  8  (workspace, full screen client window) within
            current screen.

     [1mMod4+0[0m
            Switch to object 9 (workspace, full  screen  client  window)  within
            current screen.

     [1mMod4+grave[0m
            Switch  to next object (workspace, full screen client window) within
            current screen.

     [1mMod4+Shift+asciitilde[0m
            Switch to previous object (workspace,  full  screen  client  window)
            within current screen.

     [1mMod4+O O[0m
            Open first region demanding attention or previously active one.

     [1mMod4+Shift+1, Mod4+F1[0m
            Go to screen 0 on multihead setup.

     [1mMod4+Shift+2, Mod4+F2[0m
            Go to screen 1 on multihead setup.

     [1mMod4+Shift+3, Mod4+F3[0m
            Go to screen 2 on multihead setup.

     [1mMod4+Shift+4[0m
            Go to screen 3 on multihead setup.

     [1mMod4+Shift+Escape[0m
            Go to previous screen on multihead setup.

     [1mMod4+Escape[0m
            Go to next screen on multihead setup.

     [1mMod4+F9[0m
            Create a new workspace of chosen default type.

     [1mF12, Mod4+F12, Button3 press[0m
            Display the main menu.

     [1mButton2 press[0m
            Display the window list menu.

     [1mMod4+Tab[0m
            Forward-circulate focus.

     [1mMod4+Shift+Tab[0m
            Backward-circulate focus.

     [1mMod4+Shift+R[0m
            Raise focused object, if possible.



   [1mBindings operating on all frames and screens[0m
     [1mMod4+C[0m
            Close current object.

     [1mMod4+Shift+D[0m
            Detach (float) or reattach an object to its previous location.



   [1mBindings operating on all frames[0m
     [1mMod4+H[0m
            Maximize the frame horizontally.

     [1mMod4+V[0m
            Maximize the frame vertically.

     [1mButton3 press[0m
            Display context menu.

     [1mMod4+R[0m
            Begin move/resize mode.

     [1mButton1 click at tab, Button2 click at tab[0m
            Switch the frame to display the object indicated by the tab.

     [1mButton1 drag at border, Mod4+Button3 drag[0m
            Resize the frame.

     [1mMod4+Button1 drag[0m
            Move the frame.

     [1mButton1 drag at tab, Button2 drag at tab[0m
            Move objects between frames by dragging and dropping the tab.

     [1mMod4+Caps_Lock, Mod4+Button4 click[0m
            Switch to next object within the frame.

     [1mMod4+Shift+Caps_Lock, Mod4+Button5 click[0m
            Switch to previous object within the frame.



   [1mBindings operating on top-level (non-transient) frames and screens[0m
     [1mMod4+T[0m
            Toggle tag of current object.

     [1mMod4+Shift+T[0m
            Clear all tags.

     [1mMod4+L[0m
            Lock screen

     [1mMod4+Return, F2[0m
            Run a terminal emulator.

     [1mMod4+J[0m
            Query for command line to execute.

     [1mMod4+Shift+J[0m
            Query for Lua code to execute.

     [1mMod4+F4[0m
            Query for host to connect to with SSH.

     [1mMod4+F5[0m
            Query for file to edit.

     [1mMod4+F6[0m
            Query for file to view.

     [1mMod4+F7[0m
            Query for keybinding.

     [1mMod4+Shift+F9[0m
            Query for workspace to go to or create a new one.

     [1mMod4+G[0m
            Query for a client window to go to.

     [1mMod4+M[0m
            Display context menu.

     [1mMod4+Shift+M[0m
            Query for context menu.

     [1mMod4+slash[0m
            Show Notion 'live docs'.

     [1mMod4+Shift+slash[0m
            Query for manual page to be displayed.



   [1mBindings operating on top-level (non-transient) frames[0m
     [1mMod4+N[0m
            Attach tagged objects to this frame.

     [1mMod4+Shift+N[0m
            Query for a client window to attach ('nick').

     [1mMod4+A[0m
            Switch to tab 0 in this frame.

     [1mMod4+S[0m
            Switch to tab 1 in this frame.

     [1mMod4+D[0m
            Switch to tab 2 in this frame.

     [1mMod4+F[0m
            Switch to tab 3 in this frame.

     [1mMod4+comma[0m
            Move current tab to the right within the frame.

     [1mMod4+period[0m
            Move current tab to the left within the frame.

     [1mMod4+H, Mod4+V[0m
            Maximize the frame horizontally/vertically.



   [1mBindings for floating/detached frames[0m
     [1mButton1 double click at tab[0m
            Toggle shade mode

     [1mButton1 press at tab, Button1 press at border, Mod4+Button1 click[0m
            Raise the frame.

     [1mMod4+Button3 click[0m
            Lower the frame.

     [1mButton1 drag at tab[0m
            Move the frame.

     [1mMod4+Shift+B[0m
            Tile frame, if no tiling exists on the workspace



   [1mBindings for tilings and tiled frames [mod_tiling][0m
     [1mMod4+I[0m
            Split current into columns.

     [1mMod4+Shift+I[0m
            Split current into rows.

     [1mMod4+X[0m
            Destroy current frame.

     [1mMod4+W[0m
            Go to frame below current frame.

     [1mMod4+Shift+W, Mod4+Shift+Button4 click, Mod4+Shift+Button5 click[0m
            Go to frame above current frame.



   [1mBindings for client windows[0m
     [1mMod4+Shift+L[0m
            Nudge  the client window. This might help with some programs' resiz-
            ing problems.

     [1mMod4+Shift+C[0m
            Kill client owning the client window.

     [1mMod4+Shift+Q[0m
            Send next key press to the client window. Some programs may not  al-
            low this by default.


     [1mMod4+Q[0m
            Toggle client window group full-screen mode



   [1mMove/resize mode bindings[0m
     [1mEscape[0m
            Cancel the resize mode.

     [1mReturn[0m
            End the resize mode.

     [1mLeft, Right, Up, Down, F, B, P, N[0m
            Grow in specified direction.

     [1mShift+Left, Shift+Right, Shift+Up, Shift+Down, Shift+F, Shift+B, Shift+P,[0m
     [1mShift+N[0m
            Shrink in specified direction.

     [1mMod4+Left, Mod4+Right, Mod4+Up, Mod4+Down, Mod4+F, Mod4+B, Mod4+P, Mod4+N[0m
            Move in specified direction.



   [1mBindings for message boxes and queries [mod_query][0m
     [1mEscape, Control+G, Control+C[0m
            Close the query/message box, not executing bound actions.

     [1mControl+U, Control+V, Page_Up, Page_Down[0m
            Scroll the message or completions up/down.



   [1mBindings for editing in queries [mod_query][0m
     These  bindings  are similar to those of the [4mjoe(1)[24m text editor.  Cut, copy
     and paste works in a more conventional manner, though,  but  the  keys  are
     equivalent.


     [1mControl+F, Control+B, Right, Left[0m
            Move one character forward/backward.

     [1mControl+E, Control+A, End, Home[0m
            Go to end/beginning.

     [1mControl+X, Control+Z[0m
            Skip one word forward/backward.

     [1mControl+D, Delete[0m
            Delete next character.

     [1mBackSpace, Control+H[0m
            Delete previous character.

     [1mControl+W, Control+O[0m
            Delete one word forward/backward.

     [1mControl+J[0m
            Delete to end of line.

     [1mControl+Y[0m
            Delete the whole line.

     [1mControl+T[0m
            Transpose characters.

     [1mControl+P, Control+N, Up, Down, Control+Up, Control+Down[0m
            Select next/previous (matching) history entry.

     [1mButton2 click, Control+K C[0m
            Paste from the clipboard.

     [1mControl+K B[0m
            Set mark/begin selection.

     [1mControl+K Y[0m
            Cut selection.

     [1mControl+K K[0m
            Copy selection.

     [1mControl+K G[0m
            Clear mark/cancel selection.

     [1mTab, Shift+Tab, Control+Tab[0m
            Try to complete the entered text or cycle through completions.

     [1mControl+R, Control+S[0m
            Complete from history

     [1mControl+M, Return, KP_Enter[0m
            Close the query and execute bound action.



   [1mBindings for menus [mod_menu][0m
     [1mEscape, Control+G, Control+C, Left[0m
            Close the menu.

     [1mReturn, KP_Enter, Control+M, Right[0m
            Activate current menu entry.

     [1mControl+N, Control+P, Up, Down[0m
            Select next/previous menu entry.

     [1mBackSpace[0m
            Clear the menu's typeahead find buffer.




[1mFILES AND DIRECTORIES[0m
     [1m/etc/X11/notion/cfg_notion.lua[0m
            System default main configuration files

     [1m/etc/X11/notion/cfg_*.lua[0m
            Other configuration files.

     [1m/etc/X11/notion/look_*.lua[0m
            Colour scheme configuration files

     [1m~/.notion/[0m
            User configuration files

     [1m~/.notion/cfg_notion.lua[0m
            User default main configuration file (overrides system default)


[1mSEE ALSO[0m
     The Notion home page, [4mhttps://notionwm.net/[0m

     The  document  "Configuring and extending Notion with Lua" found on the No-
     tion home page.

     [4m/usr/share/doc/notion/[0m

     [4mX(7x)[24m, [4mnotionflux(1)[24m, [4mjoe(1)[0m


[1mAUTHOR[0m
     Notion was written by the Notion team, based on Ion which  was  written  by
     Tuomo Valkonen <tuomov at iki.fi>.

                                                                       [4mNOTION[24m(1)
