aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-05-14 07:10:32 +0000
committerNils Gillmann <ng0@n0.is>2018-05-14 07:10:32 +0000
commitf1c528c2196d1bf1cc3a662a157ee0a0ffc15fbb (patch)
treecae4787090a5908de394551c1c4508aea448faa4 /doc
parent1f80a11e90ee982bffaae4685e281f75ee1c225d (diff)
downloadgnunet-f1c528c2196d1bf1cc3a662a157ee0a0ffc15fbb.tar.gz
gnunet-f1c528c2196d1bf1cc3a662a157ee0a0ffc15fbb.zip
doc/documentation: Move book "terminology" into new book "preface".
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc')
-rw-r--r--doc/documentation/Makefile.am2
-rw-r--r--doc/documentation/chapters/preface.texi64
-rw-r--r--doc/documentation/chapters/terminology.texi23
-rw-r--r--doc/documentation/gnunet.texi12
4 files changed, 69 insertions, 32 deletions
diff --git a/doc/documentation/Makefile.am b/doc/documentation/Makefile.am
index 37c7fa961..0781b2fbb 100644
--- a/doc/documentation/Makefile.am
+++ b/doc/documentation/Makefile.am
@@ -112,7 +112,7 @@ info_TEXINFOS = \
112 112
113gnunet_TEXINFOS = \ 113gnunet_TEXINFOS = \
114 chapters/developer.texi \ 114 chapters/developer.texi \
115 chapters/terminology.texi \ 115 chapters/preface.texi \
116 chapters/installation.texi \ 116 chapters/installation.texi \
117 chapters/philosophy.texi \ 117 chapters/philosophy.texi \
118 chapters/user.texi \ 118 chapters/user.texi \
diff --git a/doc/documentation/chapters/preface.texi b/doc/documentation/chapters/preface.texi
new file mode 100644
index 000000000..b1fd14e6a
--- /dev/null
+++ b/doc/documentation/chapters/preface.texi
@@ -0,0 +1,64 @@
1@node Preface
2@chapter Prefacwe
3
4@c introductionary words here
5This collection of Manuals describes how to use GNUnet, a framework
6for secure peer-to-peer networking with the high-level goal to provide
7a strong foundation Free Software for a global, distributed network
8that provides security and privacy. GNUnet in that sense aims to
9replace the current internet protocol stack. Along with an
10application for secure publication of files, it has grown to include
11all kinds of basic applications for the foundation of a new internet.
12
13@menu
14* About this book
15* Introduction
16* General Terminology::
17* Typography::
18@end menu
19
20@node About this book
21@section About this book
22
23The books (described as ``book'' or ``books'' in the following) bundled as
24the ``GNUnet Reference Manual'' are based on the historic work of all
25contributors to GNUnet's Documentation. The Documentation existed in
26various formats before it came to be in the format you are currently
27reading. It is our hope that the content is described in a way that does
28not require any academic background, although some concepts will require
29further reading.
30
31Our (long-term) goal with these books is to keep them self-contained. If
32you see references to Wikipedia and other external sources (except for
33our academic papers) it means that we are working on a solution to
34describe the explanations found there which fits our usecase and licensing.
35
36The first chapter (``Preface'') as well as the the second
37chapter (``Philosophy'') give an introduction to GNUnet as a project,
38what GNUnet tries to achieve,
39
40@node Introduction
41@section Introduction
42
43@c In less than 2 printed pages describe the history of GNUnet here,
44@c what we have now and what's still missing (could be split into
45@c subchapters).
46
47GNUnet in its current version is the result of almost 20 years of work
48from many contributors, with many publications.
49
50@node General Terminology
51@section General Terminology
52
53In the following Manual we may use words that can not be found in the
54Appendix. Since we want to keep the Manual selfcontained, we will
55explain words here.
56
57@node Typography
58@section Typography
59
60When giving examples for commands, shell prompts are used to show if the
61command should/can be issued as root, or if "normal" user privileges are
62sufficient. We use a @code{#} for root's shell prompt, a
63@code{%} for users' shell prompt, assuming they use the C-shell or tcsh
64and a @code{$} for bourne shell and derivatives.
diff --git a/doc/documentation/chapters/terminology.texi b/doc/documentation/chapters/terminology.texi
deleted file mode 100644
index 566a7b167..000000000
--- a/doc/documentation/chapters/terminology.texi
+++ /dev/null
@@ -1,23 +0,0 @@
1@node Terminology
2@chapter Terminology
3
4@menu
5* General Terminology::
6* Typography::
7@end menu
8
9@node General Terminology
10@section General Terminology
11
12In the following Manual we may use words that can not be found in the
13Appendix. Since we want to keep the Manual selfcontained, we will
14explain words here.
15
16@node Typography
17@section Typography
18
19When giving examples for commands, shell prompts are used to show if the
20command should/can be issued as root, or if "normal" user privileges are
21sufficient. We use a @code{#} for root's shell prompt, a
22@code{%} for users' shell prompt, assuming they use the C-shell or tcsh
23and a @code{$} for bourne shell and derivatives.
diff --git a/doc/documentation/gnunet.texi b/doc/documentation/gnunet.texi
index 2cd72373b..e914f11ba 100644
--- a/doc/documentation/gnunet.texi
+++ b/doc/documentation/gnunet.texi
@@ -88,8 +88,10 @@ This document is the Reference Manual for GNUnet version @value{VERSION}.
88@detailmenu 88@detailmenu
89 --- The Detailed Node Listing --- 89 --- The Detailed Node Listing ---
90 90
91Terminology 91Preface
92 92
93* About this book
94* Introduction
93* General Terminology:: 95* General Terminology::
94* Typography:: 96* Typography::
95 97
@@ -111,12 +113,6 @@ Philosophy
111* Backup of Identities and Egos:: 113* Backup of Identities and Egos::
112* Revocation:: 114* Revocation::
113 115
114@c Vocabulary
115@c
116@c * Definitions abbreviations and acronyms::
117@c * Words and characters::
118@c * Technical Assumptions::
119
120GNUnet Installation Handbook 116GNUnet Installation Handbook
121 117
122* Dependencies:: 118* Dependencies::
@@ -196,7 +192,7 @@ GNUnet Developer Handbook
196@end menu 192@end menu
197 193
198@c ********************************************************************* 194@c *********************************************************************
199@include chapters/terminology.texi 195@include chapters/preface.texi
200@c ********************************************************************* 196@c *********************************************************************
201 197
202@c ********************************************************************* 198@c *********************************************************************