---
title: Preface
prev: books/fdp-primer
next: books/fdp-primer/overview
description: Preface about the FreeBSD Documentation Project
tags: ["preface", "prompts", "conventions"]
showBookMenu: true
weight: 1
params:
  path: "/books/fdp-primer/preface/"
---

[preface]
[[preface]]
= Preface
:doctype: book
:toc: macro
:toclevels: 1
:icons: font
:source-highlighter: rouge
:experimental:
:images-path: books/fdp-primer/

ifdef::env-beastie[]
ifdef::backend-html5[]
:imagesdir: ../../../../images/{images-path}
endif::[]
ifndef::book[]
include::shared/authors.adoc[]
include::shared/mirrors.adoc[]
include::shared/releases.adoc[]
include::shared/attributes/attributes-{{% lang %}}.adoc[]
include::shared/{{% lang %}}/teams.adoc[]
include::shared/{{% lang %}}/mailing-lists.adoc[]
include::shared/{{% lang %}}/urls.adoc[]
toc::[]
endif::[]
ifdef::backend-pdf,backend-epub3[]
include::../../../../../shared/asciidoctor.adoc[]
endif::[]
endif::[]

ifndef::env-beastie[]
toc::[]
include::../../../../../shared/asciidoctor.adoc[]
endif::[]

[[preface-prompts]]
== Shell Prompts

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.

[.informaltable]
[cols="1,2", frame="none", options="header"]
|===
| User
| Prompt


|Normal user
|%

|`root`
|# 
|===

[[preface-conventions]]
== Typographic Conventions

This table describes the typographic conventions used in this book.

[.informaltable]
[cols="1,2", frame="none", options="header"]
|===
| Meaning
| Examples


|The names of commands.
|Use `ls -l` to list all files.

|The names of files.
|Edit [.filename]#.login#.

|On-screen computer output.
a|

[source,shell]
....
You have mail.
....


|What the user types, contrasted with on-screen computer output.
a|

[source,shell]
....
% 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.
|===

[[preface-notes]]
== Notes, Tips, Important Information, Warnings, and Examples

Notes, warnings, and examples appear within the text.

[NOTE]
====
Notes are represented like this, and contain information to take note of, as it may affect what the user does.
====

[TIP]
====

Tips are represented like this, and contain information helpful to the user, such as showing an easier way to do something.
====

[IMPORTANT]
====
Important information is represented like this.
Typically, these show extra steps the user may need to take.
====

[WARNING]
====

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.
====

.A Sample Example
[example]
====
Examples are represented like this, and typically contain examples showing a walkthrough, or the results of a particular action.
====

[[preface-acknowledgements]]
== Acknowledgments

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. 
