Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/guide/guide.tex @ 1759:921429804e20

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Sat, 13 Mar 2010 18:05:07 +0100
parents 0674abda9a8f
children 64de2d6858b0
comparison
equal deleted inserted replaced
1758:499d3ec34188 1759:921429804e20
9 \begin{document} 9 \begin{document}
10 \maketitle 10 \maketitle
11 \tableofcontents 11 \tableofcontents
12 \chapter*{Introduction} 12 \chapter*{Introduction}
13 This guide was written for users who are new to mcabber\cite{mcabber} which is a small 13 This guide was written for users who are new to mcabber\cite{mcabber} which is a small
14 command line client for the Jabber protocol\cite{jabber} as an introduction. This introduction may 14 command line client for the Jabber (XMPP) protocol\cite{jabber} as an introduction. This introduction may
15 become a comprehensive guide to every aspect of mcabber later, but the first versions should only be 15 become a comprehensive guide to every aspect of mcabber later, but the first versions should only be
16 regarded as an overview of all features. Feel free to bug me with corrections of spelling errors or 16 regarded as an overview of all features. Feel free to bug me with corrections of spelling errors or
17 with contributions to the content. 17 with contributions to the content.
18 \paragraph{Conventions used in this guide:\\} 18 \paragraph{Conventions used in this guide:\\}
19 \begin{tabular}{ c p{10cm} } 19 \begin{tabular}{ c p{10cm} }
21 \verb+command+ & A command for mcabber which can be given in the configuration file, too.\\ 21 \verb+command+ & A command for mcabber which can be given in the configuration file, too.\\
22 \verb+$command+ & The \$-sign precedes shell commands.\\ 22 \verb+$command+ & The \$-sign precedes shell commands.\\
23 \textit{variable} & This is a variable which can be set in the configuration file or during runtime. \\ 23 \textit{variable} & This is a variable which can be set in the configuration file or during runtime. \\
24 \end{tabular} 24 \end{tabular}
25 \chapter{Basic Usage} 25 \chapter{Basic Usage}
26 After installing mcabber, you should create a configuration file first. The easiest way of doing this 26 After installing mcabber, you should create a configuration file first.\\
27 is to copy the sample configuration file\cite{samplerc} to \~{}/.mcabber/mcabberrc. Then, you only have to change the variables 27 The easiest way of doing this is to copy the sample configuration file\cite{samplerc} to
28 \textit{username} and \textit{server} before you can, finally, start mcabber. When the Login was successful, 28 \~{}/.mcabber/mcabberrc. Then, you only have to change the variable
29 mcabber might look similar to the following screenshot:\\ 29 \textit{jid} before you can, finally, start mcabber. When the Login is
30 successful, mcabber might look similar to the following screenshot:\\
30 \begin{figure}[h!] 31 \begin{figure}[h!]
31 \centering 32 \centering
32 \includegraphics[scale=0.8]{guide} 33 \includegraphics[scale=0.8]{guide}
33 \caption{screenshot of mcabber} 34 \caption{screenshot of mcabber}
34 \label{fig:screenshot} 35 \label{fig:screenshot}