1.4. About the documentation

The Pantry User Guide, the document that you are reading right now, is available in several formats in the Pantry distribution in the directory named docs. There you will find one gigantic HTML file and a plain-text version as well. You will also find an HTML version that has been "chunked" into smaller files in the docs/html-chunk directory. Finally, you will also find a PDF version in US Letter-sized paper. Unfortunately, right now I do not know how to make a good PDF in A4 paper, so US Letter is all you will find.

There are many examples sprinkled throughout the text. In these examples, your shell prompt is indicated with $. Many of the lines we will be entering in the examples are quite long. When you type them into your computer, you can just enter them on one line. However, this would look bad in the printed documentation, so we use the backslash to continue lines across line breaks. The beginning of each continued line is indicated with a >. Don't enter the > if you are entering the lines at your computer.

Some of the examples are too wide to fit on the PDF pages, so they got cut off. I don't know how to fix this, but you can always look at the HTML versio to see examples that are not cut off.