diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/doxygen/gnunet.doxy | 70 | ||||
-rw-r--r-- | doc/gnunet-gns-gtk.1 | 29 |
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 | |||
4 | man_MANS = \ | 4 | man_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 | ||
13 | EXTRA_DIST = $(man_MANS) | 14 | EXTRA_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 | #--------------------------------------------------------------------------- |
6 | DOXYFILE_ENCODING = UTF-8 | 6 | DOXYFILE_ENCODING = UTF-8 |
7 | PROJECT_NAME = GNUnet-gtk | 7 | PROJECT_NAME = GNUnet-gtk |
8 | PROJECT_NUMBER = 0.9.x | 8 | PROJECT_NUMBER = 0.14.x |
9 | OUTPUT_DIRECTORY = . | 9 | OUTPUT_DIRECTORY = . |
10 | CREATE_SUBDIRS = YES | 10 | CREATE_SUBDIRS = YES |
11 | OUTPUT_LANGUAGE = English | 11 | OUTPUT_LANGUAGE = English |
@@ -35,7 +35,7 @@ MULTILINE_CPP_IS_BRIEF = NO | |||
35 | INHERIT_DOCS = YES | 35 | INHERIT_DOCS = YES |
36 | SEPARATE_MEMBER_PAGES = NO | 36 | SEPARATE_MEMBER_PAGES = NO |
37 | TAB_SIZE = 8 | 37 | TAB_SIZE = 8 |
38 | ALIASES = | 38 | ALIASES = |
39 | OPTIMIZE_OUTPUT_FOR_C = YES | 39 | OPTIMIZE_OUTPUT_FOR_C = YES |
40 | OPTIMIZE_OUTPUT_JAVA = NO | 40 | OPTIMIZE_OUTPUT_JAVA = NO |
41 | OPTIMIZE_FOR_FORTRAN = NO | 41 | OPTIMIZE_FOR_FORTRAN = NO |
@@ -73,12 +73,12 @@ GENERATE_TODOLIST = YES | |||
73 | GENERATE_TESTLIST = YES | 73 | GENERATE_TESTLIST = YES |
74 | GENERATE_BUGLIST = YES | 74 | GENERATE_BUGLIST = YES |
75 | GENERATE_DEPRECATEDLIST= YES | 75 | GENERATE_DEPRECATEDLIST= YES |
76 | ENABLED_SECTIONS = | 76 | ENABLED_SECTIONS = |
77 | MAX_INITIALIZER_LINES = 30 | 77 | MAX_INITIALIZER_LINES = 30 |
78 | SHOW_USED_FILES = YES | 78 | SHOW_USED_FILES = YES |
79 | SHOW_FILES = YES | 79 | SHOW_FILES = YES |
80 | SHOW_NAMESPACES = YES | 80 | SHOW_NAMESPACES = YES |
81 | FILE_VERSION_FILTER = | 81 | FILE_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 | |||
88 | WARN_IF_DOC_ERROR = YES | 88 | WARN_IF_DOC_ERROR = YES |
89 | WARN_NO_PARAMDOC = YES | 89 | WARN_NO_PARAMDOC = YES |
90 | WARN_FORMAT = "$file:$line: $text" | 90 | WARN_FORMAT = "$file:$line: $text" |
91 | WARN_LOGFILE = | 91 | WARN_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 |
146 | RECURSIVE = YES | 146 | RECURSIVE = YES |
147 | EXCLUDE = | 147 | EXCLUDE = |
148 | EXCLUDE_SYMLINKS = NO | 148 | EXCLUDE_SYMLINKS = NO |
149 | EXCLUDE_PATTERNS = */test_* */.svn/* */perf_* | 149 | EXCLUDE_PATTERNS = */test_* */.svn/* */perf_* |
150 | EXCLUDE_SYMBOLS = | 150 | EXCLUDE_SYMBOLS = |
151 | EXAMPLE_PATH = | 151 | EXAMPLE_PATH = |
152 | EXAMPLE_PATTERNS = * | 152 | EXAMPLE_PATTERNS = * |
153 | EXAMPLE_RECURSIVE = NO | 153 | EXAMPLE_RECURSIVE = NO |
154 | IMAGE_PATH = | 154 | IMAGE_PATH = |
155 | INPUT_FILTER = | 155 | INPUT_FILTER = |
156 | FILTER_PATTERNS = | 156 | FILTER_PATTERNS = |
157 | FILTER_SOURCE_FILES = NO | 157 | FILTER_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_ | |||
178 | GENERATE_HTML = YES | 178 | GENERATE_HTML = YES |
179 | HTML_OUTPUT = html | 179 | HTML_OUTPUT = html |
180 | HTML_FILE_EXTENSION = .html | 180 | HTML_FILE_EXTENSION = .html |
181 | HTML_HEADER = | 181 | HTML_HEADER = |
182 | HTML_FOOTER = | 182 | HTML_FOOTER = |
183 | HTML_STYLESHEET = | 183 | HTML_STYLESHEET = |
184 | GENERATE_HTMLHELP = NO | 184 | GENERATE_HTMLHELP = NO |
185 | GENERATE_DOCSET = NO | 185 | GENERATE_DOCSET = NO |
186 | DOCSET_FEEDNAME = "GNUnet Source Documentation" | 186 | DOCSET_FEEDNAME = "GNUnet Source Documentation" |
187 | DOCSET_BUNDLE_ID = org.gnunet | 187 | DOCSET_BUNDLE_ID = org.gnunet |
188 | HTML_DYNAMIC_SECTIONS = NO | 188 | HTML_DYNAMIC_SECTIONS = NO |
189 | CHM_FILE = | 189 | CHM_FILE = |
190 | HHC_LOCATION = | 190 | HHC_LOCATION = |
191 | GENERATE_CHI = NO | 191 | GENERATE_CHI = NO |
192 | CHM_INDEX_ENCODING = | 192 | CHM_INDEX_ENCODING = |
193 | BINARY_TOC = NO | 193 | BINARY_TOC = NO |
194 | TOC_EXPAND = NO | 194 | TOC_EXPAND = NO |
195 | DISABLE_INDEX = NO | 195 | DISABLE_INDEX = NO |
@@ -206,8 +206,8 @@ LATEX_CMD_NAME = latex | |||
206 | MAKEINDEX_CMD_NAME = makeindex | 206 | MAKEINDEX_CMD_NAME = makeindex |
207 | COMPACT_LATEX = YES | 207 | COMPACT_LATEX = YES |
208 | PAPER_TYPE = a4 | 208 | PAPER_TYPE = a4 |
209 | EXTRA_PACKAGES = | 209 | EXTRA_PACKAGES = |
210 | LATEX_HEADER = | 210 | LATEX_HEADER = |
211 | PDF_HYPERLINKS = YES | 211 | PDF_HYPERLINKS = YES |
212 | USE_PDFLATEX = YES | 212 | USE_PDFLATEX = YES |
213 | LATEX_BATCHMODE = NO | 213 | LATEX_BATCHMODE = NO |
@@ -219,8 +219,8 @@ GENERATE_RTF = NO | |||
219 | RTF_OUTPUT = rtf | 219 | RTF_OUTPUT = rtf |
220 | COMPACT_RTF = NO | 220 | COMPACT_RTF = NO |
221 | RTF_HYPERLINKS = NO | 221 | RTF_HYPERLINKS = NO |
222 | RTF_STYLESHEET_FILE = | 222 | RTF_STYLESHEET_FILE = |
223 | RTF_EXTENSIONS_FILE = | 223 | RTF_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 | #--------------------------------------------------------------------------- |
234 | GENERATE_XML = NO | 234 | GENERATE_XML = NO |
235 | XML_OUTPUT = xml | 235 | XML_OUTPUT = xml |
236 | XML_SCHEMA = | 236 | XML_SCHEMA = |
237 | XML_DTD = | 237 | XML_DTD = |
238 | XML_PROGRAMLISTING = YES | 238 | XML_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 | |||
246 | GENERATE_PERLMOD = NO | 246 | GENERATE_PERLMOD = NO |
247 | PERLMOD_LATEX = NO | 247 | PERLMOD_LATEX = NO |
248 | PERLMOD_PRETTY = YES | 248 | PERLMOD_PRETTY = YES |
249 | PERLMOD_MAKEVAR_PREFIX = | 249 | PERLMOD_MAKEVAR_PREFIX = |
250 | #--------------------------------------------------------------------------- | 250 | #--------------------------------------------------------------------------- |
251 | # Configuration options related to the preprocessor | 251 | # Configuration options related to the preprocessor |
252 | #--------------------------------------------------------------------------- | 252 | #--------------------------------------------------------------------------- |
253 | ENABLE_PREPROCESSING = YES | 253 | ENABLE_PREPROCESSING = YES |
254 | MACRO_EXPANSION = YES | 254 | MACRO_EXPANSION = YES |
255 | EXPAND_ONLY_PREDEF = NO | 255 | EXPAND_ONLY_PREDEF = NO |
256 | SEARCH_INCLUDES = YES | 256 | SEARCH_INCLUDES = YES |
257 | INCLUDE_PATH = | 257 | INCLUDE_PATH = |
258 | INCLUDE_FILE_PATTERNS = | 258 | INCLUDE_FILE_PATTERNS = |
259 | PREDEFINED = GNUNET_UNUSED="" GNUNET_PACKED="" | 259 | PREDEFINED = GNUNET_UNUSED="" GNUNET_PACKED="" |
260 | EXPAND_AS_DEFINED = | 260 | EXPAND_AS_DEFINED = |
261 | SKIP_FUNCTION_MACROS = YES | 261 | SKIP_FUNCTION_MACROS = YES |
262 | #--------------------------------------------------------------------------- | 262 | #--------------------------------------------------------------------------- |
263 | # Configuration::additions related to external references | 263 | # Configuration::additions related to external references |
264 | #--------------------------------------------------------------------------- | 264 | #--------------------------------------------------------------------------- |
265 | TAGFILES = ../../../gnunet/doc/doxygen/gnunet.tag=../../../../gnunet/doc/doxygen/html | 265 | TAGFILES = ../../../gnunet/doc/doxygen/gnunet.tag=../../../../gnunet/doc/doxygen/html |
266 | GENERATE_TAGFILE = gnunet-gtk.tag | 266 | GENERATE_TAGFILE = gnunet-gtk.tag |
@@ -268,14 +268,14 @@ ALLEXTERNALS = NO | |||
268 | EXTERNAL_GROUPS = YES | 268 | EXTERNAL_GROUPS = YES |
269 | PERL_PATH = /usr/bin/perl | 269 | PERL_PATH = /usr/bin/perl |
270 | #--------------------------------------------------------------------------- | 270 | #--------------------------------------------------------------------------- |
271 | # Configuration options related to the dot tool | 271 | # Configuration options related to the dot tool |
272 | #--------------------------------------------------------------------------- | 272 | #--------------------------------------------------------------------------- |
273 | CLASS_DIAGRAMS = YES | 273 | CLASS_DIAGRAMS = YES |
274 | MSCGEN_PATH = | 274 | MSCGEN_PATH = |
275 | HIDE_UNDOC_RELATIONS = YES | 275 | HIDE_UNDOC_RELATIONS = YES |
276 | HAVE_DOT = YES | 276 | HAVE_DOT = YES |
277 | DOT_FONTNAME = FreeSans | 277 | DOT_FONTNAME = FreeSans |
278 | DOT_FONTPATH = | 278 | DOT_FONTPATH = |
279 | CLASS_GRAPH = YES | 279 | CLASS_GRAPH = YES |
280 | COLLABORATION_GRAPH = YES | 280 | COLLABORATION_GRAPH = YES |
281 | GROUP_GRAPHS = YES | 281 | GROUP_GRAPHS = YES |
@@ -288,8 +288,8 @@ CALLER_GRAPH = YES | |||
288 | GRAPHICAL_HIERARCHY = YES | 288 | GRAPHICAL_HIERARCHY = YES |
289 | DIRECTORY_GRAPH = YES | 289 | DIRECTORY_GRAPH = YES |
290 | DOT_IMAGE_FORMAT = png | 290 | DOT_IMAGE_FORMAT = png |
291 | DOT_PATH = | 291 | DOT_PATH = |
292 | DOTFILE_DIRS = | 292 | DOTFILE_DIRS = |
293 | DOT_GRAPH_MAX_NODES = 500 | 293 | DOT_GRAPH_MAX_NODES = 500 |
294 | MAX_DOT_GRAPH_DEPTH = 1000 | 294 | MAX_DOT_GRAPH_DEPTH = 1000 |
295 | DOT_TRANSPARENT = YES | 295 | DOT_TRANSPARENT = YES |
@@ -297,6 +297,6 @@ DOT_MULTI_TARGETS = YES | |||
297 | GENERATE_LEGEND = YES | 297 | GENERATE_LEGEND = YES |
298 | DOT_CLEANUP = YES | 298 | DOT_CLEANUP = YES |
299 | #--------------------------------------------------------------------------- | 299 | #--------------------------------------------------------------------------- |
300 | # Configuration::additions related to the search engine | 300 | # Configuration::additions related to the search engine |
301 | #--------------------------------------------------------------------------- | 301 | #--------------------------------------------------------------------------- |
302 | SEARCHENGINE = YES | 302 | SEARCHENGINE = 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 | ||
3 | gnunet\-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 | ||
9 | gnunet\-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 | ||
12 | print help page | ||
13 | .TP | ||
14 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR | ||
15 | load config file (default: ~/.config/gnunet.conf) | ||
16 | .TP | ||
17 | \fB\-t, \fB\-\-tray\fR | ||
18 | start with main window minimized (only put icon in tray) | ||
19 | .TP | ||
20 | \fB\-v\fR, \fB\-\-version\fR | ||
21 | print the version number | ||
22 | .SH FILES | ||
23 | .TP | ||
24 | ~/.config/gnunet.conf | ||
25 | User's GNUnet configuration file | ||
26 | .SH "REPORTING BUGS" | ||
27 | Report 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) | ||