aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation/chapters/vocabulary.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/documentation/chapters/vocabulary.texi')
-rw-r--r--doc/documentation/chapters/vocabulary.texi57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/documentation/chapters/vocabulary.texi b/doc/documentation/chapters/vocabulary.texi
new file mode 100644
index 000000000..9621cb174
--- /dev/null
+++ b/doc/documentation/chapters/vocabulary.texi
@@ -0,0 +1,57 @@
1@node Vocabulary
2@chapter Vocabulary
3
4@menu
5* Words and characters::
6* Technical Assumptions::
7@end menu
8
9@node Words and characters
10@section Words and characters
11
12Throughout this document we use certain words and characters.
13
14@enumerate
15@item
16In chapter Installation Handbook,
17``@command{#}'' in example code blocks describes commands executed as root
18
19@example
20# echo "I am root"
21I am root
22@end example
23
24@item
25However, in the chapter GNUnet C Tutorial
26``@command{#}'' in example code blocks describes commands, ie comments.
27
28@example
29# Do the foobar thing:
30$ make foobar
31@end example
32
33@item
34Dollarsign ``@command{$}'' in example code blocks describes commands you
35execute as unprivileged users.
36
37@example
38$ cd foo; ./configure --example-switch
39@end example
40
41@item
42Backslash ``@command{\}'' describes linebreaks.
43
44@example
45./configure --foo --bar --baz \
46 --short-loop
47@end example
48
49...expands to @code{./configure --foo --bar --baz --short-loop}
50
51@end enumerate
52
53@node Technical Assumptions
54@section Technical Assumptions
55
56@c Is it really assuming Bash (ie Bash extensions of POSIX being used)?
57The shell on GNU systems is assumed to be Bash.