summaryrefslogtreecommitdiff
path: root/doc/chapters/vocabulary.texi
blob: 8b6cbe35ade8199c6a1534a1cf0aa181e8f7b152 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
@node Vocabulary
@chapter Vocabulary

@menu
* Words and characters::
* Technical Assumptions::
@end menu

@node Words and characters
@section Words and characters

Throughout this document we use certain words and characters.

@enumerate
@item
``@command{#}'' in example code blocks describes commands, ie comments.

@example
# Do the foobar thing:
$ make foobar
@end example

@item
Dollarsign ``@command{$}'' in example code blocks describes commands you
execute as unprivileged users.

@example
$ cd foo; ./configure --example-switch
@end example

@item
Backslash ``@command{\}'' describes linebreaks.

@example
./configure --foo --bar --baz \
 --short-loop
@end example

...expands to @code{./configure --foo --bar --baz --short-loop}

@end enumerate

@node Technical Assumptions
@section Technical Assumptions

@c Is it really assuming Bash (ie Bash extensions of POSIX being used)?
The shell on GNU systems is assumed to be Bash.