There is a free KOMA-Script manual and a KOMA-Script book published by Lehmanns Media on the main components of KOMA-Script. The free KOMA-Script manual already describes the function of the KOMA-Script classes and all official KOMA-Script user packages. This free manual is available as scrguide.pdf
in German and as scrguien.pdf
in English and is an integral part of every legal KOMA-Script distribution. The KOMA-Script book is available from bookshops and for members from DANTE e. V.. Both versions are intended for use on a monitor and take this into account with regard to page format and margin settings. The pagination is not optimised. In contrast, the book has so far only been published in German. Compared to the manual, it contains some content enhancements and is of course optimised in pagination.
In general, the TeX distributions MiKTeX and TeX Live (and therefore also MacTeX) come with a tool called 'texdoc'. This tool is intended to display the instructions for the installed classes and packages. With MiKTeX, this is actually the tool mthelp
, which is also available under the name texdoc
for standardisation.
The tool texdoc
expects at least one parameter indicating which document you are looking for. The easiest way is to enter the package name.
To start the tool under Windows, simply press the key combination [WINDOWS]
+[R]
. A dialogue opens in which you now enter the programme name followed by the parameter and confirm with the Enter key or the [OK]
button.
To start the tool under KDE or Gnome simply press the key combination [ALT]
+[F2]
. A dialogue opens in which you now enter the programme name followed by the parameter and confirm with the [RETURN]
or [ENTER]
key.
How to start a console tool on other Linux desktops or Mac OSX can be found in the documentation for the respective system or desktop.
In some cases texdoc
will find neither a DVI file nor a PDF file, but only a simple text file as manual. If you start texdoc
as described above, unfortunately nothing will be displayed in most cases, because a terminal is usually necessary for the text display. In this case, a terminal should be opened (in KDE for example konsole
. in Gnome gnome-terminal
). You can then directly enter the call for texdoc
. By the way, the terminal can be started in the same way as texdoc
. Most graphical desktops also offer menus or key combinations for this purpose.
For the instructions for scrlayer-fancyhdr
, for example,
texdoc scrlayer-fancyhdr
would be entered. The instructions for texdoc
itself, in which further possibilities of the tool are mentioned, are available at least with TeX Live via
texdoc texdoc
at least in TeX Live. The manual for mthelp
can be found in the MiKTeX documentation.
By the way, the German KOMA-Script manual can be obtained by searching for the manual of any KOMA-Script class, for example, via an HTML page. With
texdoc scrguide
you get them directly.
Please also refer to the documentation of the TeX distribution you are using. Links to the distributions and their instructions can be found above. Some of these can also be reached via texdoc
itself.
The KOMA-Script manual of the official current KOMA-Script release can of course also be found on CTAN. The same applies to other LaTeX packages.