X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=doc%2Fconf.tex;h=ed19b517b91c7b47b8c7af03822170900f376d2f;hb=20070506;hp=eb0f565067373710401e1c1be0ac38bae246b793;hpb=de22e45179cb3bafa490294d31d47f361047a30a;p=ion3.git diff --git a/doc/conf.tex b/doc/conf.tex index eb0f565..ed19b51 100644 --- a/doc/conf.tex +++ b/doc/conf.tex @@ -15,8 +15,8 @@ configuration file \file{ion.lua} is provided in section \ref{sec:walkthrough}. How keys and mouse action are bound to functions is described in detail in \ref{sec:bindings} and in section \ref{sec:winprops} winprops are -explained. For a reference on exported functions, see section -\ref{sec:exports}. +explained. Finally, the statusbar is explained in \ref{sec:statusbar}. +For a reference on exported functions, see section \ref{sec:exports}. \section{The configuration files} \label{sec:conffiles} @@ -44,7 +44,7 @@ file in \file{\~{}/.ion3/} and modify this file. When searching for a file, if no extension or path component is given, compiled \file{.lc} files are attempted before \file{.lua} files. -All the configuration files are named \file{cfg\_*.lua} with the ''\file{*}'' +All the configuration files are named \file{cfg\_*.lua} with the ``\file{*}'' part varying. The configuration file for each module \file{mod\_modname} is \file{cfg\_modname.lua}, with \file{modname} varying by the module in question. The following table summarises these and other configuration @@ -91,19 +91,21 @@ file. Some basic 'feel' settings are usually configured there and the necessary modules and other configuration files configuring some more specific aspects of Ion are loaded there. In this section we take a walk through the stock \file{cfg\_ion.lua}. -Notice that most of the settings are commented-out (\code{--} is a +Notice that most of the settings are commented-out (\verb!--! is a line comment in Lua) in the actual file, as they're the defaults nevertheless. -The first thing one in the file is to set +The first thing done in the file, is to set \begin{verbatim} META="Mod1+" ALTMETA="" \end{verbatim} These settings cause most of Ion's key bindings to use \key{Mod1} as the -modifier key. If \code{ALTMETA} is set, it is used as modifier for the keys -that don't normally use a modifier. for details on modifiers and key -binding setup in general see section \ref{sec:bindings}. +modifier key. If \code{ALTMETA} is set, it is used as modifier for the +keys that don't normally use a modifier. Note that these two are Lua +variables used in the configuration files only, and not Ion settings. +For details on modifiers and key binding setup in general, see section +\ref{sec:bindings}. Next we do some basic feel configuration: @@ -134,7 +136,7 @@ There are some other options as well; see the documentation for \fnref{ioncore.set} for details. As a next step, in the actual \file{cfg\_ion.lua} file, we load -\file{cfg\_defaults.lua}. However, it is merely a conveniency file for +\file{cfg\_defaults.lua}. However, it is merely a convenience file for doing exactly what we will going through below, and what is commented out in the actual file. If you do not want to load what \file{cfg\_defaults.lua} loads, just comment out the corresponding @@ -150,8 +152,8 @@ dopath("cfg_layouts") Most bindings and menus are defined in \file{cfg\_ioncore.lua}. Details on making such definitions follow in sections \ref{sec:bindings} and \ref{sec:menus}, respectively. -some kludges or ''winprops'' to make some applications behave better -under Ion are colledted in \file{cfg\_kludges.lua}; see section +some kludges or ``winprops'' to make some applications behave better +under Ion are collected in \file{cfg\_kludges.lua}; see section \ref{sec:winprops} for details. In addition to these, this file lists quite a few statements of the form \begin{verbatim} @@ -184,3 +186,7 @@ dopath("mod_sp") \input{conf-menus.tex} \input{conf-winprops.tex} + +\input{conf-statusbar.tex} + +