aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/doxygen/gnunet.doxy70
-rw-r--r--doc/gnunet-gns-gtk.129
3 files changed, 65 insertions, 36 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 40bd0365..d44f8f22 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,6 +4,7 @@ SUBDIRS = . doxygen
4man_MANS = \ 4man_MANS = \
5 gnunet-conversation-gtk.1 \ 5 gnunet-conversation-gtk.1 \
6 gnunet-fs-gtk.1 \ 6 gnunet-fs-gtk.1 \
7 gnunet-gns-gtk.1 \
7 gnunet-identity-gtk.1 \ 8 gnunet-identity-gtk.1 \
8 gnunet-namestore-gtk.1 \ 9 gnunet-namestore-gtk.1 \
9 gnunet-setup.1 \ 10 gnunet-setup.1 \
@@ -11,4 +12,3 @@ man_MANS = \
11 gnunet-statistics-gtk.1 12 gnunet-statistics-gtk.1
12 13
13EXTRA_DIST = $(man_MANS) 14EXTRA_DIST = $(man_MANS)
14
diff --git a/doc/doxygen/gnunet.doxy b/doc/doxygen/gnunet.doxy
index d4d0c929..ddf83393 100644
--- a/doc/doxygen/gnunet.doxy
+++ b/doc/doxygen/gnunet.doxy
@@ -5,7 +5,7 @@
5#--------------------------------------------------------------------------- 5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING = UTF-8 6DOXYFILE_ENCODING = UTF-8
7PROJECT_NAME = GNUnet-gtk 7PROJECT_NAME = GNUnet-gtk
8PROJECT_NUMBER = 0.9.x 8PROJECT_NUMBER = 0.14.x
9OUTPUT_DIRECTORY = . 9OUTPUT_DIRECTORY = .
10CREATE_SUBDIRS = YES 10CREATE_SUBDIRS = YES
11OUTPUT_LANGUAGE = English 11OUTPUT_LANGUAGE = English
@@ -35,7 +35,7 @@ MULTILINE_CPP_IS_BRIEF = NO
35INHERIT_DOCS = YES 35INHERIT_DOCS = YES
36SEPARATE_MEMBER_PAGES = NO 36SEPARATE_MEMBER_PAGES = NO
37TAB_SIZE = 8 37TAB_SIZE = 8
38ALIASES = 38ALIASES =
39OPTIMIZE_OUTPUT_FOR_C = YES 39OPTIMIZE_OUTPUT_FOR_C = YES
40OPTIMIZE_OUTPUT_JAVA = NO 40OPTIMIZE_OUTPUT_JAVA = NO
41OPTIMIZE_FOR_FORTRAN = NO 41OPTIMIZE_FOR_FORTRAN = NO
@@ -73,12 +73,12 @@ GENERATE_TODOLIST = YES
73GENERATE_TESTLIST = YES 73GENERATE_TESTLIST = YES
74GENERATE_BUGLIST = YES 74GENERATE_BUGLIST = YES
75GENERATE_DEPRECATEDLIST= YES 75GENERATE_DEPRECATEDLIST= YES
76ENABLED_SECTIONS = 76ENABLED_SECTIONS =
77MAX_INITIALIZER_LINES = 30 77MAX_INITIALIZER_LINES = 30
78SHOW_USED_FILES = YES 78SHOW_USED_FILES = YES
79SHOW_FILES = YES 79SHOW_FILES = YES
80SHOW_NAMESPACES = YES 80SHOW_NAMESPACES = YES
81FILE_VERSION_FILTER = 81FILE_VERSION_FILTER =
82#--------------------------------------------------------------------------- 82#---------------------------------------------------------------------------
83# configuration options related to warning and progress messages 83# configuration options related to warning and progress messages
84#--------------------------------------------------------------------------- 84#---------------------------------------------------------------------------
@@ -88,7 +88,7 @@ WARN_IF_UNDOCUMENTED = YES
88WARN_IF_DOC_ERROR = YES 88WARN_IF_DOC_ERROR = YES
89WARN_NO_PARAMDOC = YES 89WARN_NO_PARAMDOC = YES
90WARN_FORMAT = "$file:$line: $text" 90WARN_FORMAT = "$file:$line: $text"
91WARN_LOGFILE = 91WARN_LOGFILE =
92#--------------------------------------------------------------------------- 92#---------------------------------------------------------------------------
93# configuration options related to the input files 93# configuration options related to the input files
94#--------------------------------------------------------------------------- 94#---------------------------------------------------------------------------
@@ -144,16 +144,16 @@ FILE_PATTERNS = *.c \
144 *.VHD \ 144 *.VHD \
145 *.VHDL 145 *.VHDL
146RECURSIVE = YES 146RECURSIVE = YES
147EXCLUDE = 147EXCLUDE =
148EXCLUDE_SYMLINKS = NO 148EXCLUDE_SYMLINKS = NO
149EXCLUDE_PATTERNS = */test_* */.svn/* */perf_* 149EXCLUDE_PATTERNS = */test_* */.svn/* */perf_*
150EXCLUDE_SYMBOLS = 150EXCLUDE_SYMBOLS =
151EXAMPLE_PATH = 151EXAMPLE_PATH =
152EXAMPLE_PATTERNS = * 152EXAMPLE_PATTERNS = *
153EXAMPLE_RECURSIVE = NO 153EXAMPLE_RECURSIVE = NO
154IMAGE_PATH = 154IMAGE_PATH =
155INPUT_FILTER = 155INPUT_FILTER =
156FILTER_PATTERNS = 156FILTER_PATTERNS =
157FILTER_SOURCE_FILES = NO 157FILTER_SOURCE_FILES = NO
158#--------------------------------------------------------------------------- 158#---------------------------------------------------------------------------
159# configuration options related to source browsing 159# configuration options related to source browsing
@@ -178,18 +178,18 @@ IGNORE_PREFIX = GNUNET_
178GENERATE_HTML = YES 178GENERATE_HTML = YES
179HTML_OUTPUT = html 179HTML_OUTPUT = html
180HTML_FILE_EXTENSION = .html 180HTML_FILE_EXTENSION = .html
181HTML_HEADER = 181HTML_HEADER =
182HTML_FOOTER = 182HTML_FOOTER =
183HTML_STYLESHEET = 183HTML_STYLESHEET =
184GENERATE_HTMLHELP = NO 184GENERATE_HTMLHELP = NO
185GENERATE_DOCSET = NO 185GENERATE_DOCSET = NO
186DOCSET_FEEDNAME = "GNUnet Source Documentation" 186DOCSET_FEEDNAME = "GNUnet Source Documentation"
187DOCSET_BUNDLE_ID = org.gnunet 187DOCSET_BUNDLE_ID = org.gnunet
188HTML_DYNAMIC_SECTIONS = NO 188HTML_DYNAMIC_SECTIONS = NO
189CHM_FILE = 189CHM_FILE =
190HHC_LOCATION = 190HHC_LOCATION =
191GENERATE_CHI = NO 191GENERATE_CHI = NO
192CHM_INDEX_ENCODING = 192CHM_INDEX_ENCODING =
193BINARY_TOC = NO 193BINARY_TOC = NO
194TOC_EXPAND = NO 194TOC_EXPAND = NO
195DISABLE_INDEX = NO 195DISABLE_INDEX = NO
@@ -206,8 +206,8 @@ LATEX_CMD_NAME = latex
206MAKEINDEX_CMD_NAME = makeindex 206MAKEINDEX_CMD_NAME = makeindex
207COMPACT_LATEX = YES 207COMPACT_LATEX = YES
208PAPER_TYPE = a4 208PAPER_TYPE = a4
209EXTRA_PACKAGES = 209EXTRA_PACKAGES =
210LATEX_HEADER = 210LATEX_HEADER =
211PDF_HYPERLINKS = YES 211PDF_HYPERLINKS = YES
212USE_PDFLATEX = YES 212USE_PDFLATEX = YES
213LATEX_BATCHMODE = NO 213LATEX_BATCHMODE = NO
@@ -219,8 +219,8 @@ GENERATE_RTF = NO
219RTF_OUTPUT = rtf 219RTF_OUTPUT = rtf
220COMPACT_RTF = NO 220COMPACT_RTF = NO
221RTF_HYPERLINKS = NO 221RTF_HYPERLINKS = NO
222RTF_STYLESHEET_FILE = 222RTF_STYLESHEET_FILE =
223RTF_EXTENSIONS_FILE = 223RTF_EXTENSIONS_FILE =
224#--------------------------------------------------------------------------- 224#---------------------------------------------------------------------------
225# configuration options related to the man page output 225# configuration options related to the man page output
226#--------------------------------------------------------------------------- 226#---------------------------------------------------------------------------
@@ -233,8 +233,8 @@ MAN_LINKS = NO
233#--------------------------------------------------------------------------- 233#---------------------------------------------------------------------------
234GENERATE_XML = NO 234GENERATE_XML = NO
235XML_OUTPUT = xml 235XML_OUTPUT = xml
236XML_SCHEMA = 236XML_SCHEMA =
237XML_DTD = 237XML_DTD =
238XML_PROGRAMLISTING = YES 238XML_PROGRAMLISTING = YES
239#--------------------------------------------------------------------------- 239#---------------------------------------------------------------------------
240# configuration options for the AutoGen Definitions output 240# configuration options for the AutoGen Definitions output
@@ -246,21 +246,21 @@ GENERATE_AUTOGEN_DEF = NO
246GENERATE_PERLMOD = NO 246GENERATE_PERLMOD = NO
247PERLMOD_LATEX = NO 247PERLMOD_LATEX = NO
248PERLMOD_PRETTY = YES 248PERLMOD_PRETTY = YES
249PERLMOD_MAKEVAR_PREFIX = 249PERLMOD_MAKEVAR_PREFIX =
250#--------------------------------------------------------------------------- 250#---------------------------------------------------------------------------
251# Configuration options related to the preprocessor 251# Configuration options related to the preprocessor
252#--------------------------------------------------------------------------- 252#---------------------------------------------------------------------------
253ENABLE_PREPROCESSING = YES 253ENABLE_PREPROCESSING = YES
254MACRO_EXPANSION = YES 254MACRO_EXPANSION = YES
255EXPAND_ONLY_PREDEF = NO 255EXPAND_ONLY_PREDEF = NO
256SEARCH_INCLUDES = YES 256SEARCH_INCLUDES = YES
257INCLUDE_PATH = 257INCLUDE_PATH =
258INCLUDE_FILE_PATTERNS = 258INCLUDE_FILE_PATTERNS =
259PREDEFINED = GNUNET_UNUSED="" GNUNET_PACKED="" 259PREDEFINED = GNUNET_UNUSED="" GNUNET_PACKED=""
260EXPAND_AS_DEFINED = 260EXPAND_AS_DEFINED =
261SKIP_FUNCTION_MACROS = YES 261SKIP_FUNCTION_MACROS = YES
262#--------------------------------------------------------------------------- 262#---------------------------------------------------------------------------
263# Configuration::additions related to external references 263# Configuration::additions related to external references
264#--------------------------------------------------------------------------- 264#---------------------------------------------------------------------------
265TAGFILES = ../../../gnunet/doc/doxygen/gnunet.tag=../../../../gnunet/doc/doxygen/html 265TAGFILES = ../../../gnunet/doc/doxygen/gnunet.tag=../../../../gnunet/doc/doxygen/html
266GENERATE_TAGFILE = gnunet-gtk.tag 266GENERATE_TAGFILE = gnunet-gtk.tag
@@ -268,14 +268,14 @@ ALLEXTERNALS = NO
268EXTERNAL_GROUPS = YES 268EXTERNAL_GROUPS = YES
269PERL_PATH = /usr/bin/perl 269PERL_PATH = /usr/bin/perl
270#--------------------------------------------------------------------------- 270#---------------------------------------------------------------------------
271# Configuration options related to the dot tool 271# Configuration options related to the dot tool
272#--------------------------------------------------------------------------- 272#---------------------------------------------------------------------------
273CLASS_DIAGRAMS = YES 273CLASS_DIAGRAMS = YES
274MSCGEN_PATH = 274MSCGEN_PATH =
275HIDE_UNDOC_RELATIONS = YES 275HIDE_UNDOC_RELATIONS = YES
276HAVE_DOT = YES 276HAVE_DOT = YES
277DOT_FONTNAME = FreeSans 277DOT_FONTNAME = FreeSans
278DOT_FONTPATH = 278DOT_FONTPATH =
279CLASS_GRAPH = YES 279CLASS_GRAPH = YES
280COLLABORATION_GRAPH = YES 280COLLABORATION_GRAPH = YES
281GROUP_GRAPHS = YES 281GROUP_GRAPHS = YES
@@ -288,8 +288,8 @@ CALLER_GRAPH = YES
288GRAPHICAL_HIERARCHY = YES 288GRAPHICAL_HIERARCHY = YES
289DIRECTORY_GRAPH = YES 289DIRECTORY_GRAPH = YES
290DOT_IMAGE_FORMAT = png 290DOT_IMAGE_FORMAT = png
291DOT_PATH = 291DOT_PATH =
292DOTFILE_DIRS = 292DOTFILE_DIRS =
293DOT_GRAPH_MAX_NODES = 500 293DOT_GRAPH_MAX_NODES = 500
294MAX_DOT_GRAPH_DEPTH = 1000 294MAX_DOT_GRAPH_DEPTH = 1000
295DOT_TRANSPARENT = YES 295DOT_TRANSPARENT = YES
@@ -297,6 +297,6 @@ DOT_MULTI_TARGETS = YES
297GENERATE_LEGEND = YES 297GENERATE_LEGEND = YES
298DOT_CLEANUP = YES 298DOT_CLEANUP = YES
299#--------------------------------------------------------------------------- 299#---------------------------------------------------------------------------
300# Configuration::additions related to the search engine 300# Configuration::additions related to the search engine
301#--------------------------------------------------------------------------- 301#---------------------------------------------------------------------------
302SEARCHENGINE = YES 302SEARCHENGINE = YES
diff --git a/doc/gnunet-gns-gtk.1 b/doc/gnunet-gns-gtk.1
new file mode 100644
index 00000000..05c99674
--- /dev/null
+++ b/doc/gnunet-gns-gtk.1
@@ -0,0 +1,29 @@
1.TH GNUNET-GNS-GTK "1" "25 Feb 2012" "GNUnet"
2.SH NAME
3gnunet\-gns\-gtk \- a gtk interface to manipulate GNUnet GNS zones
4.SH SYNOPSIS
5.B gnunet\-gns\-gtk
6[\fIOPTIONS\fR]
7.SH DESCRIPTION
8.PP
9gnunet\-gns\-gtk is a gtk+ based GUI which can be used to create and manipulate a GNS zone.
10.TP
11\fB\-h\fR, \fB\-\-help\fR
12print help page
13.TP
14\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
15load config file (default: ~/.config/gnunet.conf)
16.TP
17\fB\-t, \fB\-\-tray\fR
18start with main window minimized (only put icon in tray)
19.TP
20\fB\-v\fR, \fB\-\-version\fR
21print the version number
22.SH FILES
23.TP
24~/.config/gnunet.conf
25User's GNUnet configuration file
26.SH "REPORTING BUGS"
27Report bugs by using mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet-developers@gnu.org>
28.SH "SEE ALSO"
29\fBgnunet\-gns\fP(1)