doc/documentation/chapters/vocabulary.texi

   1 @node Vocabulary
   2 @chapter Vocabulary
   3
   4 @menu
   5 * Definitions abbreviations and acronyms::
   6 * Words and characters::
   7 * Technical Assumptions::
   8 @end menu
   9
  10 Throughout this Reference Manual we will use certain words and characters
  11 which are listed in this introductionary chapter.
  12
  13 @node Definitions abbreviations and acronyms
  14 @section Definitions abbreviations and acronyms
  15
  16 @menu
  17 * Definitions::
  18 @end menu
  19
  20 @node Definitions
  21 @subsection Defitions
  22
  23 Throughout this Reference Manual, the following terms and definitions
  24 apply.
  25
  26 @node Words and characters
  27 @section Words and characters
  28
  29 @enumerate
  30 @item
  31 In chapter Installation Handbook,
  32 ``@command{#}'' in example code blocks describes commands executed as root
  33
  34 @example
  35 # echo "I am root"
  36 I am root
  37 @end example
  38
  39 @item
  40 However, in the chapter GNUnet C Tutorial
  41 ``@command{#}'' in example code blocks describes commands, ie comments.
  42
  43 @example
  44 # Do the foobar thing:
  45 $ make foobar
  46 @end example
  47
  48 @item
  49 Dollarsign ``@command{$}'' in example code blocks describes commands you
  50 execute as unprivileged users.
  51
  52 @example
  53 $ cd foo; ./configure --example-switch
  54 @end example
  55
  56 @item
  57 Backslash ``@command{\}'' describes linebreaks.
  58
  59 @example
  60 ./configure --foo --bar --baz \
  61  --short-loop
  62 @end example
  63
  64 ...expands to @code{./configure --foo --bar --baz --short-loop}
  65
  66 @end enumerate
  67
  68 @node Technical Assumptions
  69 @section Technical Assumptions
  70
  71 @c Is it really assuming Bash (ie Bash extensions of POSIX being used)?
  72 The shell on GNU systems is assumed to be Bash.