%chapters; ]> The FreeBSD Documentation Project 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 DocEng &legalnotice; Thank you for becoming a part of the FreeBSD Documentation Project. Your contribution is extremely valuable, and we appreciate it. This primer covers details needed to start contributing to the FreeBSD Documentation Project, or FDP, including tools, software, and the philosophy behind the Documentation Project. This is a work in progress. Corrections and additions are always welcome. This table shows the default system prompt and superuser prompt. The examples use these prompts to indicate which type of user is running the example. User Prompt Normal user &prompt.user; root &prompt.root; This table describes the typographic conventions used in this book. Meaning Examples The names of commands. Use ls -l to list all files. The names of files. Edit .login. On-screen computer output. You have mail. What the user types, contrasted with on-screen computer output. &prompt.user; date +"The time is %H:%M" The time is 09:18 Manual page references. Use &man.su.1; to change user identity. User and group names. Only root can do this. Emphasis. The user must do this. Text that the user is expected to replace with the actual text. To search for a keyword in the manual pages, type man -k keyword Environment variables. $HOME is set to the user's home directory. Notes, warnings, and examples appear within the text. Notes are represented like this, and contain information to take note of, as it may affect what the user does. Tips are represented like this, and contain information helpful to the user, like showing an easier way to do something. Important information is represented like this. Typically, these show extra steps the user may need to take. Warnings are represented like this, and contain information warning about possible damage if the instructions are not followed. This damage may be physical, to the hardware or the user, or it may be non-physical, such as the inadvertent deletion of important files. Examples are represented like this, and typically contain examples showing a walkthrough, or the results of a particular action. My thanks to Sue Blake, Patrick Durusau, Jon Hamilton, Peter Flynn, and Christopher Maden, who took the time to read early drafts of this document and offer many valuable comments and criticisms. &chap.overview; &chap.tools; &chap.working-copy; &chap.structure; &chap.doc-build; &chap.the-website; &chap.xml-primer; &chap.xhtml-markup; &chap.docbook-markup; &chap.stylesheets; &chap.translations; &chap.po-translations; &chap.manpages; &chap.writing-style; &chap.editor-config; &chap.see-also; &app.examples;