diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/Makefile.in | 94 | ||||
-rw-r--r-- | doc/README.mysql | 95 | ||||
-rw-r--r-- | doc/README.postgres | 49 | ||||
-rw-r--r-- | doc/man/Makefile.am | 9 | ||||
-rw-r--r-- | doc/man/Makefile.in | 179 | ||||
-rw-r--r-- | doc/man/gnunet-arm.1 | 4 | ||||
-rw-r--r-- | doc/man/gnunet-ats.1 | 64 | ||||
-rw-r--r-- | doc/man/gnunet-auto-share.1 | 86 | ||||
-rw-r--r-- | doc/man/gnunet-config.1 | 43 | ||||
-rw-r--r-- | doc/man/gnunet-dns2gns.1 | 46 | ||||
-rw-r--r-- | doc/man/gnunet-download.1 | 2 | ||||
-rw-r--r-- | doc/man/gnunet-ecc.1 | 43 | ||||
-rw-r--r-- | doc/man/gnunet-gns-fcfsd.1 | 38 | ||||
-rw-r--r-- | doc/man/gnunet-gns-proxy.1 | 41 | ||||
-rw-r--r-- | doc/man/gnunet-gns.1 | 36 | ||||
-rw-r--r-- | doc/man/gnunet-namestore.1 | 3 | ||||
-rw-r--r-- | doc/man/gnunet-peerinfo.1 | 8 | ||||
-rw-r--r-- | doc/man/gnunet-publish.1 | 10 | ||||
-rw-r--r-- | doc/man/gnunet-rsa.1 | 3 | ||||
-rw-r--r-- | doc/man/gnunet-search.1 | 8 | ||||
-rw-r--r-- | doc/man/gnunet-transport.1 | 19 | ||||
-rw-r--r-- | doc/man/gnunet-uri.1 | 30 | ||||
-rw-r--r-- | doc/man/gnunet-vpn.1 | 4 | ||||
-rw-r--r-- | doc/man/gnunet.conf.5 | 20 |
25 files changed, 698 insertions, 238 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 738d970..6f92cc1 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,3 +1,3 @@ SUBDIRS = man -EXTRA_DIST = README.mysql README.postgres +docdir = $(datadir)/doc/gnunet/ diff --git a/doc/Makefile.in b/doc/Makefile.in index f1b7b45..9db5f9c 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -1,9 +1,9 @@ -# Makefile.in generated by automake 1.11.1 from Makefile.am. +# Makefile.in generated by automake 1.11.6 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. +# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software +# Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -15,6 +15,23 @@ @SET_MAKE@ VPATH = @srcdir@ +am__make_dryrun = \ + { \ + am__dry=no; \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \ + | grep '^AM OK$$' >/dev/null || am__dry=yes;; \ + *) \ + for am__flg in $$MAKEFLAGS; do \ + case $$am__flg in \ + *=*|--*) ;; \ + *n*) am__dry=yes; break;; \ + esac; \ + done;; \ + esac; \ + test $$am__dry = yes; \ + } pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -39,14 +56,15 @@ DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/absolute-header.m4 \ $(top_srcdir)/m4/align.m4 $(top_srcdir)/m4/argz.m4 \ - $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/iconv.m4 \ - $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ - $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/libcurl.m4 \ - $(top_srcdir)/m4/libgcrypt.m4 $(top_srcdir)/m4/libtool.m4 \ - $(top_srcdir)/m4/libunistring.m4 $(top_srcdir)/m4/ltdl.m4 \ - $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ - $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ - $(top_srcdir)/m4/nls.m4 $(top_srcdir)/m4/po.m4 \ + $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/glib-2.0.m4 \ + $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/lib-ld.m4 \ + $(top_srcdir)/m4/lib-link.m4 $(top_srcdir)/m4/lib-prefix.m4 \ + $(top_srcdir)/m4/libcurl.m4 $(top_srcdir)/m4/libgcrypt.m4 \ + $(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/libunistring.m4 \ + $(top_srcdir)/m4/ltdl.m4 $(top_srcdir)/m4/ltoptions.m4 \ + $(top_srcdir)/m4/ltsugar.m4 $(top_srcdir)/m4/ltversion.m4 \ + $(top_srcdir)/m4/lt~obsolete.m4 $(top_srcdir)/m4/nls.m4 \ + $(top_srcdir)/m4/pkg.m4 $(top_srcdir)/m4/po.m4 \ $(top_srcdir)/m4/progtest.m4 $(top_srcdir)/acinclude.m4 \ $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ @@ -55,11 +73,11 @@ mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/gnunet_config.h CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = -AM_V_GEN = $(am__v_GEN_$(V)) -am__v_GEN_ = $(am__v_GEN_$(AM_DEFAULT_VERBOSITY)) +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) am__v_GEN_0 = @echo " GEN " $@; -AM_V_at = $(am__v_at_$(V)) -am__v_at_ = $(am__v_at_$(AM_DEFAULT_VERBOSITY)) +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) am__v_at_0 = @ SOURCES = DIST_SOURCES = @@ -70,6 +88,11 @@ RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ install-pdf-recursive install-ps-recursive install-recursive \ installcheck-recursive installdirs-recursive pdf-recursive \ ps-recursive uninstall-recursive +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ distclean-recursive maintainer-clean-recursive AM_RECURSIVE_TARGETS = $(RECURSIVE_TARGETS:-recursive=) \ @@ -139,6 +162,10 @@ EXEEXT = @EXEEXT@ EXT_LIBS = @EXT_LIBS@ EXT_LIB_PATH = @EXT_LIB_PATH@ FGREP = @FGREP@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ GMSGFMT = @GMSGFMT@ GMSGFMT_015 = @GMSGFMT_015@ GNUNETDNS_GROUP = @GNUNETDNS_GROUP@ @@ -149,6 +176,7 @@ GN_LIBINTL = @GN_LIBINTL@ GN_LIB_LDFLAGS = @GN_LIB_LDFLAGS@ GN_PLUGIN_LDFLAGS = @GN_PLUGIN_LDFLAGS@ GN_USER_HOME_DIR = @GN_USER_HOME_DIR@ +GOBJECT_QUERY = @GOBJECT_QUERY@ GREP = @GREP@ HAVE_LIBUNISTRING = @HAVE_LIBUNISTRING@ INCLTDL = @INCLTDL@ @@ -171,6 +199,8 @@ LIBCURL_CPPFLAGS = @LIBCURL_CPPFLAGS@ LIBGCRYPT_CFLAGS = @LIBGCRYPT_CFLAGS@ LIBGCRYPT_CONFIG = @LIBGCRYPT_CONFIG@ LIBGCRYPT_LIBS = @LIBGCRYPT_LIBS@ +LIBGTOP_CFLAGS = @LIBGTOP_CFLAGS@ +LIBGTOP_LIBS = @LIBGTOP_LIBS@ LIBICONV = @LIBICONV@ LIBINTL = @LIBINTL@ LIBLTDL = @LIBLTDL@ @@ -192,6 +222,7 @@ LT_CONFIG_H = @LT_CONFIG_H@ LT_DLLOADERS = @LT_DLLOADERS@ LT_DLPREOPEN = @LT_DLPREOPEN@ MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ MKDIR_P = @MKDIR_P@ MONKEYPREFIX = @MONKEYPREFIX@ MSGFMT = @MSGFMT@ @@ -201,6 +232,7 @@ MYSQL_CPPFLAGS = @MYSQL_CPPFLAGS@ MYSQL_LDFLAGS = @MYSQL_LDFLAGS@ NM = @NM@ NMEDIT = @NMEDIT@ +NSS_DIR = @NSS_DIR@ OBJC = @OBJC@ OBJCDEPMODE = @OBJCDEPMODE@ OBJCFLAGS = @OBJCFLAGS@ @@ -216,6 +248,7 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@ PACKAGE_URL = @PACKAGE_URL@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ POSTGRES_CPPFLAGS = @POSTGRES_CPPFLAGS@ POSTGRES_LDFLAGS = @POSTGRES_LDFLAGS@ POSUB = @POSUB@ @@ -247,6 +280,7 @@ abs_builddir = @abs_builddir@ abs_srcdir = @abs_srcdir@ abs_top_builddir = @abs_top_builddir@ abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ ac_ct_CC = @ac_ct_CC@ ac_ct_CXX = @ac_ct_CXX@ ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ @@ -266,9 +300,10 @@ build_vendor = @build_vendor@ builddir = @builddir@ datadir = @datadir@ datarootdir = @datarootdir@ -docdir = @docdir@ +docdir = $(datadir)/doc/gnunet/ dvidir = @dvidir@ exec_prefix = @exec_prefix@ +gitcommand = @gitcommand@ host = @host@ host_alias = @host_alias@ host_cpu = @host_cpu@ @@ -282,7 +317,6 @@ libdir = @libdir@ libexecdir = @libexecdir@ localedir = @localedir@ localstatedir = @localstatedir@ -lt_ECHO = @lt_ECHO@ ltdl_LIBOBJS = @ltdl_LIBOBJS@ ltdl_LTLIBOBJS = @ltdl_LTLIBOBJS@ mandir = @mandir@ @@ -300,6 +334,7 @@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ subdirs = @subdirs@ +svnversioncommand = @svnversioncommand@ sys_symbol_underscore = @sys_symbol_underscore@ sysconfdir = @sysconfdir@ target = @target@ @@ -311,7 +346,6 @@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ SUBDIRS = man -EXTRA_DIST = README.mysql README.postgres all: all-recursive .SUFFIXES: @@ -519,13 +553,10 @@ distdir: $(DISTFILES) done @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ if test "$$subdir" = .; then :; else \ - test -d "$(distdir)/$$subdir" \ - || $(MKDIR_P) "$(distdir)/$$subdir" \ - || exit 1; \ - fi; \ - done - @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ - if test "$$subdir" = .; then :; else \ + $(am__make_dryrun) \ + || test -d "$(distdir)/$$subdir" \ + || $(MKDIR_P) "$(distdir)/$$subdir" \ + || exit 1; \ dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ $(am__relativize); \ new_distdir=$$reldir; \ @@ -560,10 +591,15 @@ install-am: all-am installcheck: installcheck-recursive install-strip: - $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ - install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi mostlyclean-generic: clean-generic: diff --git a/doc/README.mysql b/doc/README.mysql deleted file mode 100644 index 84aeb24..0000000 --- a/doc/README.mysql +++ /dev/null @@ -1,95 +0,0 @@ -How to setup the MySQL database for GNUnet. - -NOTE: This db module does NOT work with mysql before 4.1 since we need -prepared statements. We are generally testing the code against MySQL -5.0 at this point. - -HIGHLIGHTS - -Pros - + On up-to-date hardware where mysql can be used comfortably, this - module will have better performance than the other db choices - (according to our tests). - + Its often possible to recover the mysql database from internal - inconsistencies. The other db choices do not support repair - (gnunet-check cannot fix problems internal to the dbmgr!). - For example, we have seen several cases where power failure - has ruined a gdbm database beyond repair. - + much faster (for one of the key benchmarks -- content migration - -- we have measure mysql taking 2s for an operation where - sqlite takes 150s). -Cons - - Memory usage (Comment: "I have 1G and it never caused me trouble") - - Manual setup - -MANUAL SETUP INSTRUCTIONS - - 1) in /etc/gnunet.conf, set - DATABASE = mysql - - 2) Then access mysql as root, - $ mysql -u root -p - and do the following. [You should replace $USER with the username - that will be running the gnunetd process]. - - CREATE DATABASE gnunet; - GRANT select,insert,update,delete,create,alter,drop,create temporary tables - ON gnunet.* TO $USER@localhost; - SET PASSWORD FOR $USER@localhost=PASSWORD('$the_password_you_like'); - FLUSH PRIVILEGES; - - 3) In the $HOME directory of $USER, create a ".my.cnf" file - with the following lines - - [client] - user=$USER - password=$the_password_you_like - - Thats it. Note that .my.cnf file is a security risk unless its on - a safe partition etc. The $HOME/.my.cnf can of course be a symbolic - link. Even greater security risk can be achieved by setting no - password for $USER. Luckily $USER has only priviledges to mess - up GNUnet's tables, nothing else (unless you give him more, - of course). - - 4) Still, perhaps you should briefly try if the DB connection - works. First, login as $USER. Then use, - - $ mysql -u $USER - mysql> use gnunet; - - If you get the message "Database changed" it probably works. - - [If you get "ERROR 2002: Can't connect to local MySQL server - through socket '/tmp/mysql.sock' (2)" it may be resolvable by - "ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock" - so there may be some additional trouble depending on your mysql setup.] - - 5) If you want to run the testcases, you must create a second - database "gnunetcheck" with the same username and password. - This database will then be used for testing ("make check"). - - -REPAIRING TABLES - -- Its probably healthy to check your tables for inconsistencies - every now and then, especially after system crashes. -- If you get odd SEGVs on gnunetd startup, it might be that the mysql - databases have been corrupted. -- The tables can be verified/fixed in two ways; - 1) by shutting down mysqld (mandatory!) and running - # myisamchk -r *.MYI - in /var/lib/mysql/gnunet/ (or wherever the tables are stored). - Another repair command is "mysqlcheck". The usable command - may depend on your mysql build/version. Or, - 2) by executing - mysql> REPAIR TABLE gn090; - - -PROBLEMS? - -If you have problems related to the mysql module, your best friend is -probably the mysql manual. The first thing to check is that mysql is -basically operational, that you can connect to it, create tables, -issue queries etc. - diff --git a/doc/README.postgres b/doc/README.postgres deleted file mode 100644 index 2c96716..0000000 --- a/doc/README.postgres +++ /dev/null @@ -1,49 +0,0 @@ -How to setup the Postgres database for GNUnet. - -NOTE: This db module was developed for Postgres 8.3. I have no -idea what the minimum version that we require is exactly. - -HIGHLIGHTS - -Pros - + Easier to setup than MySQL - + Real database -Cons - - Quite slow - - Still some setup - -MANUAL SETUP INSTRUCTIONS - - 1) in /etc/gnunet.conf, set - DATABASE = postgres - - 2) Then access postgres to create a user; I had to do this to get - access and create a user: - # su - postgres - $ createuser - At this point, use the name of the user running gnunet - for the role, do not set it to superuser, allow the creation - of databases. - - 3) As that user, create a database (or two): - $ createdb gnunet - $ createdb gnunetcheck # this way you can run "make check" - - Thats it. - - 4) Still, perhaps you should briefly try if the DB connection - works. First, login as the user who will run gnunetd. Then use, - - $ psql gnunet # or gnunetcheck - gnunet=> \dt - - If, after you have started gnunetd at least once, you get a - gn090 table here, it probably works. - -PROBLEMS? - -If you have problems related to the postgres module, your best friend -is probably the postgres manual. The first thing to check is that -postgres is basically operational, that you can connect to it, create -tables, issue queries etc. (see step 4 above for details). - diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index c640460..dc68375 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -1,11 +1,19 @@ man_MANS = \ + gnunet.conf.5 \ gnunet-arm.1 \ + gnunet-ats.1 \ + gnunet-auto-share.1 \ + gnunet-config.1 \ gnunet-core.1 \ gnunet-directory.1 \ + gnunet-dns2gns.1 \ gnunet-download.1 \ gnunet-download-manager.1 \ + gnunet-ecc.1 \ gnunet-fs.1 \ gnunet-gns.1 \ + gnunet-gns-fcfsd.1 \ + gnunet-gns-proxy.1 \ gnunet-namestore.1 \ gnunet-nat-server.1 \ gnunet-peerinfo.1 \ @@ -16,6 +24,7 @@ man_MANS = \ gnunet-statistics.1 \ gnunet-transport.1 \ gnunet-unindex.1 \ + gnunet-uri.1 \ gnunet-vpn.1 EXTRA_DIST = ${man_MANS} diff --git a/doc/man/Makefile.in b/doc/man/Makefile.in index 76f2b02..44981d0 100644 --- a/doc/man/Makefile.in +++ b/doc/man/Makefile.in @@ -1,9 +1,9 @@ -# Makefile.in generated by automake 1.11.1 from Makefile.am. +# Makefile.in generated by automake 1.11.6 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. +# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software +# Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -15,6 +15,23 @@ @SET_MAKE@ VPATH = @srcdir@ +am__make_dryrun = \ + { \ + am__dry=no; \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \ + | grep '^AM OK$$' >/dev/null || am__dry=yes;; \ + *) \ + for am__flg in $$MAKEFLAGS; do \ + case $$am__flg in \ + *=*|--*) ;; \ + *n*) am__dry=yes; break;; \ + esac; \ + done;; \ + esac; \ + test $$am__dry = yes; \ + } pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -39,14 +56,15 @@ DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/absolute-header.m4 \ $(top_srcdir)/m4/align.m4 $(top_srcdir)/m4/argz.m4 \ - $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/iconv.m4 \ - $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ - $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/libcurl.m4 \ - $(top_srcdir)/m4/libgcrypt.m4 $(top_srcdir)/m4/libtool.m4 \ - $(top_srcdir)/m4/libunistring.m4 $(top_srcdir)/m4/ltdl.m4 \ - $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ - $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ - $(top_srcdir)/m4/nls.m4 $(top_srcdir)/m4/po.m4 \ + $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/glib-2.0.m4 \ + $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/lib-ld.m4 \ + $(top_srcdir)/m4/lib-link.m4 $(top_srcdir)/m4/lib-prefix.m4 \ + $(top_srcdir)/m4/libcurl.m4 $(top_srcdir)/m4/libgcrypt.m4 \ + $(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/libunistring.m4 \ + $(top_srcdir)/m4/ltdl.m4 $(top_srcdir)/m4/ltoptions.m4 \ + $(top_srcdir)/m4/ltsugar.m4 $(top_srcdir)/m4/ltversion.m4 \ + $(top_srcdir)/m4/lt~obsolete.m4 $(top_srcdir)/m4/nls.m4 \ + $(top_srcdir)/m4/pkg.m4 $(top_srcdir)/m4/po.m4 \ $(top_srcdir)/m4/progtest.m4 $(top_srcdir)/acinclude.m4 \ $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ @@ -55,14 +73,19 @@ mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/gnunet_config.h CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = -AM_V_GEN = $(am__v_GEN_$(V)) -am__v_GEN_ = $(am__v_GEN_$(AM_DEFAULT_VERBOSITY)) +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) am__v_GEN_0 = @echo " GEN " $@; -AM_V_at = $(am__v_at_$(V)) -am__v_at_ = $(am__v_at_$(AM_DEFAULT_VERBOSITY)) +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) am__v_at_0 = @ SOURCES = DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; am__vpath_adj = case $$p in \ $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ @@ -84,8 +107,15 @@ am__nobase_list = $(am__nobase_strip_setup); \ am__base_list = \ sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } man1dir = $(mandir)/man1 -am__installdirs = "$(DESTDIR)$(man1dir)" +am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" +man5dir = $(mandir)/man5 NROFF = nroff MANS = $(man_MANS) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) @@ -124,6 +154,10 @@ EXEEXT = @EXEEXT@ EXT_LIBS = @EXT_LIBS@ EXT_LIB_PATH = @EXT_LIB_PATH@ FGREP = @FGREP@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ GMSGFMT = @GMSGFMT@ GMSGFMT_015 = @GMSGFMT_015@ GNUNETDNS_GROUP = @GNUNETDNS_GROUP@ @@ -134,6 +168,7 @@ GN_LIBINTL = @GN_LIBINTL@ GN_LIB_LDFLAGS = @GN_LIB_LDFLAGS@ GN_PLUGIN_LDFLAGS = @GN_PLUGIN_LDFLAGS@ GN_USER_HOME_DIR = @GN_USER_HOME_DIR@ +GOBJECT_QUERY = @GOBJECT_QUERY@ GREP = @GREP@ HAVE_LIBUNISTRING = @HAVE_LIBUNISTRING@ INCLTDL = @INCLTDL@ @@ -156,6 +191,8 @@ LIBCURL_CPPFLAGS = @LIBCURL_CPPFLAGS@ LIBGCRYPT_CFLAGS = @LIBGCRYPT_CFLAGS@ LIBGCRYPT_CONFIG = @LIBGCRYPT_CONFIG@ LIBGCRYPT_LIBS = @LIBGCRYPT_LIBS@ +LIBGTOP_CFLAGS = @LIBGTOP_CFLAGS@ +LIBGTOP_LIBS = @LIBGTOP_LIBS@ LIBICONV = @LIBICONV@ LIBINTL = @LIBINTL@ LIBLTDL = @LIBLTDL@ @@ -177,6 +214,7 @@ LT_CONFIG_H = @LT_CONFIG_H@ LT_DLLOADERS = @LT_DLLOADERS@ LT_DLPREOPEN = @LT_DLPREOPEN@ MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ MKDIR_P = @MKDIR_P@ MONKEYPREFIX = @MONKEYPREFIX@ MSGFMT = @MSGFMT@ @@ -186,6 +224,7 @@ MYSQL_CPPFLAGS = @MYSQL_CPPFLAGS@ MYSQL_LDFLAGS = @MYSQL_LDFLAGS@ NM = @NM@ NMEDIT = @NMEDIT@ +NSS_DIR = @NSS_DIR@ OBJC = @OBJC@ OBJCDEPMODE = @OBJCDEPMODE@ OBJCFLAGS = @OBJCFLAGS@ @@ -201,6 +240,7 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@ PACKAGE_URL = @PACKAGE_URL@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ POSTGRES_CPPFLAGS = @POSTGRES_CPPFLAGS@ POSTGRES_LDFLAGS = @POSTGRES_LDFLAGS@ POSUB = @POSUB@ @@ -232,6 +272,7 @@ abs_builddir = @abs_builddir@ abs_srcdir = @abs_srcdir@ abs_top_builddir = @abs_top_builddir@ abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ ac_ct_CC = @ac_ct_CC@ ac_ct_CXX = @ac_ct_CXX@ ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ @@ -254,6 +295,7 @@ datarootdir = @datarootdir@ docdir = @docdir@ dvidir = @dvidir@ exec_prefix = @exec_prefix@ +gitcommand = @gitcommand@ host = @host@ host_alias = @host_alias@ host_cpu = @host_cpu@ @@ -267,7 +309,6 @@ libdir = @libdir@ libexecdir = @libexecdir@ localedir = @localedir@ localstatedir = @localstatedir@ -lt_ECHO = @lt_ECHO@ ltdl_LIBOBJS = @ltdl_LIBOBJS@ ltdl_LTLIBOBJS = @ltdl_LTLIBOBJS@ mandir = @mandir@ @@ -285,6 +326,7 @@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ subdirs = @subdirs@ +svnversioncommand = @svnversioncommand@ sys_symbol_underscore = @sys_symbol_underscore@ sysconfdir = @sysconfdir@ target = @target@ @@ -296,13 +338,21 @@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ man_MANS = \ + gnunet.conf.5 \ gnunet-arm.1 \ + gnunet-ats.1 \ + gnunet-auto-share.1 \ + gnunet-config.1 \ gnunet-core.1 \ gnunet-directory.1 \ + gnunet-dns2gns.1 \ gnunet-download.1 \ gnunet-download-manager.1 \ + gnunet-ecc.1 \ gnunet-fs.1 \ gnunet-gns.1 \ + gnunet-gns-fcfsd.1 \ + gnunet-gns-proxy.1 \ gnunet-namestore.1 \ gnunet-nat-server.1 \ gnunet-peerinfo.1 \ @@ -313,6 +363,7 @@ man_MANS = \ gnunet-statistics.1 \ gnunet-transport.1 \ gnunet-unindex.1 \ + gnunet-uri.1 \ gnunet-vpn.1 EXTRA_DIST = ${man_MANS} @@ -357,11 +408,18 @@ clean-libtool: -rm -rf .libs _libs install-man1: $(man_MANS) @$(NORMAL_INSTALL) - test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)" - @list=''; test -n "$(man1dir)" || exit 0; \ - { for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ - sed -n '/\.1[a-z]*$$/p'; \ + @list1=''; \ + list2='$(man_MANS)'; \ + test -n "$(man1dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man1dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man1dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.1[a-z]*$$/p'; \ + fi; \ } | while read p; do \ if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; echo "$$p"; \ @@ -390,9 +448,50 @@ uninstall-man1: sed -n '/\.1[a-z]*$$/p'; \ } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ - test -z "$$files" || { \ - echo " ( cd '$(DESTDIR)$(man1dir)' && rm -f" $$files ")"; \ - cd "$(DESTDIR)$(man1dir)" && rm -f $$files; } + dir='$(DESTDIR)$(man1dir)'; $(am__uninstall_files_from_dir) +install-man5: $(man_MANS) + @$(NORMAL_INSTALL) + @list1=''; \ + list2='$(man_MANS)'; \ + test -n "$(man5dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man5dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man5dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.5[a-z]*$$/p'; \ + fi; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man5dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man5dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man5dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man5dir)" || exit $$?; }; \ + done; } + +uninstall-man5: + @$(NORMAL_UNINSTALL) + @list=''; test -n "$(man5dir)" || exit 0; \ + files=`{ for i in $$list; do echo "$$i"; done; \ + l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + sed -n '/\.5[a-z]*$$/p'; \ + } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ + dir='$(DESTDIR)$(man5dir)'; $(am__uninstall_files_from_dir) tags: TAGS TAGS: @@ -447,7 +546,7 @@ check-am: all-am check: check-am all-am: Makefile $(MANS) installdirs: - for dir in "$(DESTDIR)$(man1dir)"; do \ + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)"; do \ test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: install-am @@ -460,10 +559,15 @@ install-am: all-am installcheck: installcheck-am install-strip: - $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ - install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi mostlyclean-generic: clean-generic: @@ -511,7 +615,7 @@ install-info: install-info-am install-info-am: -install-man: install-man1 +install-man: install-man1 install-man5 install-pdf: install-pdf-am @@ -541,7 +645,7 @@ ps-am: uninstall-am: uninstall-man -uninstall-man: uninstall-man1 +uninstall-man: uninstall-man1 uninstall-man5 .MAKE: install-am install-strip @@ -551,11 +655,12 @@ uninstall-man: uninstall-man1 install-data install-data-am install-dvi install-dvi-am \ install-exec install-exec-am install-html install-html-am \ install-info install-info-am install-man install-man1 \ - install-pdf install-pdf-am install-ps install-ps-am \ - install-strip installcheck installcheck-am installdirs \ - maintainer-clean maintainer-clean-generic mostlyclean \ - mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \ - uninstall uninstall-am uninstall-man uninstall-man1 + install-man5 install-pdf install-pdf-am install-ps \ + install-ps-am install-strip installcheck installcheck-am \ + installdirs maintainer-clean maintainer-clean-generic \ + mostlyclean mostlyclean-generic mostlyclean-libtool pdf pdf-am \ + ps ps-am uninstall uninstall-am uninstall-man uninstall-man1 \ + uninstall-man5 # Tell versions [3.59,3.63) of GNU make to not export all variables. diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1 index 86a748e..1fbfa41 100644 --- a/doc/man/gnunet-arm.1 +++ b/doc/man/gnunet-arm.1 @@ -17,7 +17,7 @@ gnunet\-arm \- control GNUnet services Use the configuration file FILENAME. .B .IP "\-e, \-\-end" -Shutdown all GNUnet services (including ARM itself). Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer. +Shutdown all GNUnet services (including ARM itself). Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. .B .IP "\-h, \-\-help" Print short help on options. @@ -32,7 +32,7 @@ Starts the specified SERVICE if it is not already running. More specifically, t Stop the specified SERVICE if it is running. While this will kill the service right now, the service may be restarted immediately if other services depend on it (service is then started 'on-demand'). If the service used to be a 'default' service, its default-service status will be revoked. If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time. .B .IP "\-s, \-\-start" -Start all GNUnet default services on this system (and also ARM). Naturally, if a service is demanded by a default service, it will then also be started. Running "gnunet-arm -s" is the usual way to start a GNUnet peer. +Start all GNUnet default services on this system (and also ARM). Naturally, if a service is demanded by a default service, it will then also be started. Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. .B .IP "\-I, \-\-info" List all running services. diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1 new file mode 100644 index 0000000..c143f7a --- /dev/null +++ b/doc/man/gnunet-ats.1 @@ -0,0 +1,64 @@ +.TH GNUNET\-ATS 1 "Oct 31, 2012" "GNUnet" + +.SH NAME +gnunet\-ats \- display information about transport resource allocation + +.SH SYNOPSIS +.B gnunet\-ats +.RI [ options ] +.br + +.SH DESCRIPTION +\fBgnunet\-ats\fP can be used to display information about the GNUnet's +transport selection mechanism. It shows information about the +addresses and the assigned input and output bandwidth. + +.SH OPTIONS +.B +.IP "\-a, \-\-aa" +List all addresses currently known to ats. +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-i, \-\-id=PEERID" +Print information for a specific peer identity only +.B +.IP "\-k, \-\-value=VALUE" +Value to set for when changing preference values +.B +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" +Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. +.B +.IP "\-m, \-\-monitor" +Monitor changes to the bandwidth assignments continously +.B +.IP "\-n, \-\-numeric" +Do not resolve IP addresses to hostnames +.B +.IP "\-k, \-\-preference=E" +Set preference values, -i, -k and -t required +.B +.IP "\-q, \-\-quotas" +Print quotas for all network types +.B +.IP "\-t, \-\-type=VALUE" +Preference type to change: latency | bandwidth +.B +.IP "\-u, \-\-used" +Print addresses actively used only +.B +.IP "\-V, \-\-verbose" +Print verbose output (include ATS address properties) +.B +.IP "\-v, \-\-version" +Print GNUnet version number. + +.SH BUGS +Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org> + +.SH SEE ALSO +gnunet\-transport(1) diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1 new file mode 100644 index 0000000..6373da2 --- /dev/null +++ b/doc/man/gnunet-auto-share.1 @@ -0,0 +1,86 @@ +.TH GNUNET\-AUTO\-SHARE "1" "18 Jun 2012" "GNUnet" +.SH NAME +gnunet\-auto\-share \- a command line tool to automatically share an entire directory with other users +.SH SYNOPSIS +.B gnunet\-auto\-share +[\fIOPTIONS\fR] DIRNAME +.SH DESCRIPTION +.PP +In order to share files with other GNUnet users, the files must first be made available to GNUnet. This tool can be used to automatically share all files from a certain directory. The program will periodically scan the directory for changes and publish files that are new or that changed on GNUnet. Which files have already been shared is remembered in a ".auto-share" file in the shared directory. You can run the tool by hand or automatically by adding the respective options to your configuration. gnunet\-auto\-share has many options in common with gnunet\-publish, but can only be used to index files. +.PP +You can use automatic meta\-data extraction (based on libextractor). +.PP + +\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR +Use alternate config file (if this option is not specified, the default is ~/.gnunet/gnunet.conf). + +.TP +\fB\-D\fR, \fB\-\-disable\-extractor\fR +Disable use of GNU libextractor for finding additional keywords and metadata. + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print a brief help page with all the options. + +.TP +\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR +Change the loglevel. Possible values for LOGLEVEL are +ERROR, WARNING, INFO and DEBUG. + +.TP +\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR +Executive summary: You probably don't need it. + +Set the priority of the published content (default: 365). If the local database is full, GNUnet will discard the content with the lowest ranking. Note that ranks change over time depending on popularity. The default should be high enough to preserve the locally published content in favor of content that migrates from other peers. + +.TP +\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR +Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the file) LEVEL times to other peers before doing normal "random" replication of all content. This option can be used to push some content out into the network harder. Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas. + +.TP +\fB\-v\fR, \fB\-\-version\fR +Print the version number. + +.TP +\fB\-V\fR, \fB\-\-verbose\fR +Be verbose. Using this option causes gnunet\-publish to print progress information and at the end the file identification that can be used to download the file from GNUnet. + + +.SH SETTING ANONYMITY LEVEL + +The \fB\-a\fR option can be used to specify additional anonymity constraints. If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key. This will allow other users to download the file as fast as possible, including using non-anonymous methods (DHT, direct transfer). If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity. You can gain better privacy by specifying a higher level of anonymity, which increases the amount of cover traffic your own traffic will get, at the expense of performance. Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. + +The definition of the ANONYMITY LEVEL is the following. 0 means no anonymity is required. Otherwise a value of 'v' means that 1 out of v bytes of "anonymous" traffic can be from the local user, leaving 'v-1' bytes of cover traffic per byte on the wire. Thus, if GNUnet routes n bytes of messages from foreign peers (using anonymous routing), it may originate n/(v-1) bytes of data in the same time\-period. The time\-period is twice the average delay that GNUnet defers forwarded queries. + +The default is 1 and this should be fine for most users. Also notice that if you choose very large values, you may end up having no throughput at all, especially if many of your fellow GNUnet\-peers all do the same. + + +.SH EXAMPLES +.PP + +\fBBasic example\fR + +Share a directory "$HOME/gnunet\-share/": + + # gnunet\-auto\-share $HOME/gnunet\-share/ & + + +\fBBasic configuration\fR + +Share a directory "$HOME/gnunet\-share/": + + [ARM] + DEFAULTSERVICES = gnunet-auto-share # other default services here + + [gnunet-auto-share] + OPTIONS = $HOME/gnunet\-share + + +.SH FILES +.TP +~/.gnunet/gnunet.conf +GNUnet configuration file +.SH "REPORTING BUGS" +Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> +.SH "SEE ALSO" +\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1) diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1 new file mode 100644 index 0000000..3a7fa62 --- /dev/null +++ b/doc/man/gnunet-config.1 @@ -0,0 +1,43 @@ +.TH GNUNET\-CONFIG 1 "Jul 15, 2012" "GNUnet" + +.SH NAME +gnunet\-config \- manipulate GNUnet configuration files + +.SH SYNOPSIS +.B gnunet\-config +.RI [ options ] +.br + +.SH DESCRIPTION +\fBgnunet\-config\fP can be used to read or modify GNUnet configuration files. + +.SH OPTIONS +.B +.IP "\-f, \-\-filename" +When accessing a specific option using \-s and \-o, perform expansions as if the value represents a filename. +.B +.IP "\-s SECTION, \-\-section=SECTION" +Which configuration section should be accessed or edited. Required option. +.B +.IP "\-o OPTION, \-\-option=OPTION" +Which configuration option should be accessed or edited. Required to set a value. If not given, all values of a given section will be printed in the format "OPTION = VALUE". +.B +.IP "\-V VALUE, \-\-value VALUE" +Configuration value to store in the given section under the given option. Must only be given together with \-s and \-o options. +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" +Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. +.B +.IP "\-v, \-\-version" +Print GNUnet version number. + + +.SH BUGS +Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> + diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1 new file mode 100644 index 0000000..f60f40e --- /dev/null +++ b/doc/man/gnunet-dns2gns.1 @@ -0,0 +1,46 @@ +.TH GNUNET\-DNS2GNS 1 "Oct 25, 2012" "GNUnet" + +.SH NAME +gnunet\-dns2gns \- run a DNS-to-GNS proxy + +.SH SYNOPSIS +.B gnunet\-dns2gns +.RI [ options ] +.br + +.SH DESCRIPTION +Most users will not want to run an DNS to GADS proxy/gateway and thus will not need this program. + +\fBgnunet\-dns2gns\fP runs a DNS resolver which delegates requests to the ".gads" and ".zkey" zones to GADS. All other requests are forwarded to DNS. This DNS proxy is useful for enabling non-personalized GADS\-resolution to an entire network or to offer GADS\-resolution to DNS users. + +A DNS\-to\-GNS proxy using gnunet\-dns2gns is available at ".zkey.eu" + +.SH OPTIONS +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-d IP, \-\-dns=IP" +IP address of a recursive DNS resolver that should be used for non-GADS hostnames. +.B +.IP "\-f NAME, \-\-fcfs=NAME" +Authoritative FCFS suffix to use. This is the name under which the local zone's names will be made available. Default is "fcfs.zkey.eu". +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" +Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. +.B +.IP "\-s SUFFIX, \-\-suffix=SUFFIX" +Authoritative DNS suffix to use. This is the name under which the GADS ".zkey" zone is mapped into the DNS namespace. Default is "zkey.eu". +.B +.IP "\-v, \-\-version" +Print GNUnet version number. + + +.SH BUGS +Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org> + +.SH SEE ALSO +gnunet\-gns\-fcfs(1), gnunet\-gns(1) diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1 index 9754cb0..a2d1aad 100644 --- a/doc/man/gnunet-download.1 +++ b/doc/man/gnunet-download.1 @@ -47,7 +47,7 @@ set the maximum number of parallel requests that is allowed. If multiple files .TP \fB\-R\fR, \fB\-\-recursive\fR -download directories recursively (and in parallel); note that the URI must belong to a GNUnet directory and that the filename given must end with a '/' \-\- otherwise, only the file corresponding to the URI will be downloaded. Note that in addition to using '-R', you must also specify a filename ending in '.gnd' so that the code realizes that the top-level file is a directory (since we have no meta data). +download directories recursively (and in parallel); note that the URI must belong to a GNUnet directory and that the filename given must end with a '/' \-\- otherwise, only the file corresponding to the URI will be downloaded. Note that in addition to using '\-R', you must also specify a filename ending in '.gnd' so that the code realizes that the top-level file is a directory (since we have no meta data). .TP \fB\-v\fR, \fB\-\-version\fR diff --git a/doc/man/gnunet-ecc.1 b/doc/man/gnunet-ecc.1 new file mode 100644 index 0000000..943f85e --- /dev/null +++ b/doc/man/gnunet-ecc.1 @@ -0,0 +1,43 @@ +.TH GNUNET\-ECC 1 "Mar 15, 2012" "GNUnet" + +.SH NAME +gnunet\-ecc \- manipulate GNUnet ECC key files + +.SH SYNOPSIS +.B gnunet\-ecc +.RI [ options ] FILENAME +.br + +.SH DESCRIPTION +\fBgnunet\-ecc\fP can be used to create an ECC private key and to print the corresponding public key. You must specify a filename containing an ECC private key in GNUnet format as an argument. If the file does not exist, gnunet\-ecc will create a key. This may then take a while. If the option \-p is given, the corresponding public key will be printed to the console. + +.SH OPTIONS +.B +.IP "\-g COUNT, \-\-generate-keys=COUNT" +Create COUNT public-private key pairs and write them to FILENAME. Used for creating a file for testing. +.B +.IP "\-p, \-\-print-public-key" +Print the corresponding public key to stdout. +.B +.IP "\-P, \-\-print-peer-identity" +Print the corresponding peer identity (hash of the public key) to stdout. This hash is used for the name of peers. +.B +.IP "\-s, \-\-print-short-identity" +Print the corresponding short hash (256-bit hash of the public key) to stdout. This hash is used for names in the zkey zone. +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" +Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. +.B +.IP "\-v, \-\-version" +Print GNUnet version number. + + +.SH BUGS +Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> + diff --git a/doc/man/gnunet-gns-fcfsd.1 b/doc/man/gnunet-gns-fcfsd.1 new file mode 100644 index 0000000..fbd45e4 --- /dev/null +++ b/doc/man/gnunet-gns-fcfsd.1 @@ -0,0 +1,38 @@ +.TH GNUNET\-GNS-FCFSD 1 "Oct 25, 2012" "GNUnet" + +.SH NAME +gnunet\-gns-fcfsd \- HTTP server for GADS domain registration + +.SH SYNOPSIS +.B gnunet\-gns-fcfsd +.RI [ options ] +.br + +.SH DESCRIPTION +Most users will not want to run an FCFS\-zone and thus will not need this program. + +\fBgnunet\-gns-fcfsd\fP runs a web server where users can register names to be mapped to their GADS zone. Names are made available on a First Come First Served basis (hence fcfs). Registered names do not expire. The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT". The key of the zone in which the names are registered must be specified under the name "ZONEKEY" in the same section. It is possible to manage gnunet\-gns\-fcfsd using gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm -i fcfsd" or by adding "fcfds" to the "DEFAULTSERVICES" option. + +An FCFS\-zone is run at http://gnunet.org/fcfs/. The respective zone key can be imported into an individual user's zone using "gnunet-gns-import.sh". GADS users are encouraged to register their zone with the gnunet.org FCFS authority. + +.SH OPTIONS +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" +Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. +.B +.IP "\-v, \-\-version" +Print GNUnet version number. + + +.SH BUGS +Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org> + +.SH SEE ALSO +gnunet\-gns(1), gnunet\-gns\-proxy(1) + diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1 new file mode 100644 index 0000000..9b9f603 --- /dev/null +++ b/doc/man/gnunet-gns-proxy.1 @@ -0,0 +1,41 @@ +.TH GNUNET\-GNS\-PROXY 1 "Oct 25, 2012" "GNUnet" + +.SH NAME +gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy + +.SH SYNOPSIS +.B gnunet\-gns\-proxy +.RI [ options ] +.br + +.SH DESCRIPTION +Most users will want to run this SOCKS proxy. It can be used in combination with browsers that support the SOCKS 4a protocol. + +The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content. To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy. Thus "gnunet-gns-proxy-setup-ca" should be executed before the first launch of this proxy or the \-\-authority switch is used to specify an appropriate CA certificate that is already trusted by the browser. + +.SH OPTIONS +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-a AUTHORITY, \-\-authority=AUTHORITY" +Path to a PEM CA file that contains the certificate and private key of the CA to use to assert the validity of GNS names. The default port is specified in the configuration file for the gns service under "[gns-proxy]" PROXY_CACERT. +.B +.IP "\-p PORT, \-\-port=PORT" +The port this proxy should listen on. Default is 7777. +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" +Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. +.B +.IP "\-v, \-\-version" +Print GNUnet version number. + + +.SH BUGS +Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org> + +.SH SEE ALSO +gnunet\-gns(1) diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1 index 4d00c82..ef5a0f9 100644 --- a/doc/man/gnunet-gns.1 +++ b/doc/man/gnunet-gns.1 @@ -1,32 +1,56 @@ -.TH GNUNET\-GNS 1 "Mar 5, 2012" "GNUnet" +.TH GNUNET\-GNS 1 "Aug 8, 2012" "GNUnet" .SH NAME -gnunet\-gns \- manipulate GNUnet GNS zones +gnunet\-gns \- Access to GNUnet Name Service .SH SYNOPSIS .B gnunet\-gns -.RI [ options ] -z ZONEFILE +.RI [ options ] .br .SH DESCRIPTION -\fBgnunet\-gns\fP can be used to create and manipulate a GNS zone. +\fBgnunet\-gns\fP can be used to lookup and process GNUnet Name Service names. .SH OPTIONS .B +.IP "\-a NAME, \-\-authority=NAME" +Get the authority of a particular name. +For example the authority for "www.fcfs.gads" is "fcfs.gads". +.B .IP "\-c FILENAME, \-\-config=FILENAME" Use the configuration file FILENAME. .B +.IP "\-r, \-\-raw" +No unneeded output. +This is a quiet mode where only important information is displayed. +For example a lookup for an IP address will only yield the IP address, no +descriptive text. +.B +.IP "\-s NAME, \-\-shorten NAME" +Shorten GNUnet Name Service Name. +The service will try to shorten the delegation chain of the name if a "closer" +authority chain exists relative to your local root zone. +.B +.IP "\-t RRTYPE, \-\-type=RRTYPE" +Resource Record Type (RRTYPE) to look for. +Supported RRTYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, MX, LEHO, VPN, REV, PTR, TXT + +Defaults to "A". +.B .IP "\-h, \-\-help" Print short help on options. .B .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. .B -.IP "\-s NAME, \-\-shorten=NAME" -GNS domain name to shorten +.IP "\-u NAME, \-\-lookup=NAME" +Name to lookup. +Resolve the specified name using the GNUnet Name System. .B .IP "\-v, \-\-version" Print GNUnet version number. +.B + .SH BUGS Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1 index 4ecdbb0..f05db0a 100644 --- a/doc/man/gnunet-namestore.1 +++ b/doc/man/gnunet-namestore.1 @@ -40,6 +40,9 @@ Name of the record to add/delete/display .IP "\-t TYPE, \-\-type=TYPE" Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.) .B +.IP "\-u URI, \-\-uri=URI" +Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used +.B .IP "\-v, \-\-version" Print GNUnet version number. .B diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1 index e2691b1..354fd05 100644 --- a/doc/man/gnunet-peerinfo.1 +++ b/doc/man/gnunet-peerinfo.1 @@ -17,12 +17,18 @@ gnunet\-peerinfo \- Display information about other peers. .IP "\-c FILENAME, \-\-config=FILENAME" Load config file (default: ~/.gnunet/gnunet.conf) .B +.IP "\-g, \-\-get\-hello +Output HELLO uri(s) +.B .IP "\-h, \-\-help" Print help page .B .IP "\-n, \-\-numeric" Disable resolution of IPs to hostnames .B +.IP "\-p, \-\-put\-hello=HELLO +Add given HELLO uri to the database +.B .IP "\-q, \-\-quiet" Do not print anything but the peer identities .B @@ -32,7 +38,7 @@ Print only our own identity (together with "\-q", this is the exact line that ot .IP "\-v, \-\-version" Print the version number .B -.IP "\-L LOGLEVEL, \-\-loglelvel=LOGLEVEL" +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" Set the loglevel diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1 index a189c74..467f45a 100644 --- a/doc/man/gnunet-publish.1 +++ b/doc/man/gnunet-publish.1 @@ -6,14 +6,12 @@ gnunet\-publish \- a command line interface for publishing new content into GNUn [\fIOPTIONS\fR] FILENAME .SH DESCRIPTION .PP -In order to share files with other GNUnet users, the files must first be made available to GNUnet. GNUnet does not automatically share all files from a certain directory. In fact, even files that are downloaded are not automatically shared. +In order to share files with other GNUnet users, the files must first be made available to GNUnet. GNUnet does not automatically share all files from a certain directory (however, you can do this with the gnunet\-auto\-share tool). In fact, even files that are downloaded are not automatically shared. .PP In order to start sharing files, the files must be added either using gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk. The command line tool gnunet\-publish is more useful if many files are supposed to be added. gnunet\-publish can automatically publish batches of files, recursively publish directories, create directories that can be browsed within GNUnet and publish file lists in a namespace. When run on a directory, gnunet\-publish will always recursively publish all of the files in the directory. .PP gnunet\-publish can automatically extract keywords from the files that are shared. Users that want to download files from GNUnet use keywords to search for the appropriate content. You can disable keyword extraction with the \-D option. You can manually add keywords using the \-k option. The keywords are case\-sensitive. .PP -You can use automatic meta\-data extraction (based on libextractor) or the command\-line option \-m to specify meta-data. For the \-m option you need to use the form keyword\-type:value. For example, use "\-m os:Linux" to specify that the operating system is Linux. Common meta\-data types are "author name", "title" , "mimetype", "filename", "language", "subject" and "keywords". A full list can be obtained from the extract tool using the option \-\-list. The meta\-data is used to help users in searching for files on the network. -.PP In addition to searching for files by keyword, GNUnet allows organizing files into directories. With directories, the user only needs to find the directory in order to be able to download any of the files listed in the directory. Directories can contain pointers to other directories. .PP With gnunet\-publish, it is easy to create new directories simultaneously when adding the files. Simply pass the name of a directory instead of a file. @@ -127,7 +125,7 @@ Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR: Index a file COPYING with description "GNU License", mime-type "text/plain" and keywords \fBgpl\fR and \fBtest\fR: - # gnunet\-publish \-m "description:GNU License" \-k gpl \-k test -m "mimetype:text/plain" COPYING + # gnunet\-publish \-m "description:GNU License" \-k gpl \-k test \-m "mimetype:text/plain" COPYING \fBUsing directories\fR @@ -157,7 +155,7 @@ Recursively publish (\-n) /var/lib/mysql and build a matching directory structur Create a namespace entry 'root' in namespace MPAA-1 and announce that the next update will be called 'next': - # gnunet\-publish \-P MPAA-1 -t root \-N next noise.mp3 + # gnunet\-publish \-P MPAA-1 \-t root \-N next noise.mp3 Update the previous entry, do not allow any future updates: @@ -171,4 +169,4 @@ GNUnet configuration file .SH "REPORTING BUGS" Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> .SH "SEE ALSO" -\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-pseudonym\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1) +\fBgnunet\-auto\-share\fP(1), \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-pseudonym\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1) diff --git a/doc/man/gnunet-rsa.1 b/doc/man/gnunet-rsa.1 index 46f24de..c61bc1f 100644 --- a/doc/man/gnunet-rsa.1 +++ b/doc/man/gnunet-rsa.1 @@ -13,6 +13,9 @@ gnunet\-rsa \- manipulate GNUnet RSA key files .SH OPTIONS .B +.IP "\-g COUNT, \-\-generate-keys=COUNT" +Create COUNT public-private key pairs and write them to FILENAME. Used for creating a file for testing. +.B .IP "\-p, \-\-print-public-key" Print the corresponding public key to stdout. .B diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1 index ccca75f..05ab275 100644 --- a/doc/man/gnunet-search.1 +++ b/doc/man/gnunet-search.1 @@ -47,8 +47,8 @@ Only search locally, do not forward requests to other peers. automatically terminate the search after receiving VALUE results. .TP -\fB\-t \fIVALUE\fR, \fB\-\-timeout=\fIVALUE\fR -Automatically timeout search after VALUE ms. Otherwise the search runs until gnunet\-search is aborted with CTRL\-C. +\fB\-t \fIDELAY\fR, \fB\-\-timeout=\fIDELAY\fR +Automatically timeout search after DELAY. The value given must be a number followed by a space and a time unit, for example "500 ms". Note that the quotes are required on the shell. Otherwise the search runs until gnunet\-search is aborted with CTRL\-C. .TP \fB\-v\fR, \fB\-\-version\fR @@ -76,12 +76,12 @@ Search results are printed by gnunet\-search like this: .ad l gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE - Description: The GNU Public License + Description: The GNU General Public License Mime-type: text/plain .ad b -The first line contains the command to run to download the file. The suggested filename in the example is COPYING. The GNUnet URI consists of the key and query hash of the file and finally the size of the file. After the command to download the file GNUnet will print meta\-data about the file as advertised in the search result, here "The GNU Public License" and the mime\-type (see the options for gnunet\-publish on how to supply meta-data by hand). +The first line contains the command to run to download the file. The suggested filename in the example is COPYING. The GNUnet URI consists of the key and query hash of the file and finally the size of the file. After the command to download the file GNUnet will print meta\-data about the file as advertised in the search result, here "The GNU General Public License" and the mime\-type (see the options for gnunet\-publish on how to supply meta-data by hand). .SH FILES .TP diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1 index cc1a022..45fd706 100644 --- a/doc/man/gnunet-transport.1 +++ b/doc/man/gnunet-transport.1 @@ -14,11 +14,14 @@ gnunet\-transport is a tool to access various functions of GNUnet's transport su \fB\-b\fR, \fB\-\-benchmark\fR measure how fast we are receiving data (from all connections). On exit, the data rate will be reported. Runs until aborted with CTRL-C. .TP +\fB\-C \fIPEER\fR, \fB\-\-connect=PEER\fR +peer to connect to (used in conjunction with \-p) +.TP \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR configuration file to use .TP -\fB\-C \fIPEER\fR, \fB\-\-connect=PEER\fR -peer to connect to (and to use for sending if used in conjunction with \-s) +\fB\-e \fB\-\-events\fR +provide information about all connect and disconnect events (continuously) .TP \fB\-h\fR, \fB\-\-help\fR print help page @@ -26,14 +29,20 @@ print help page \fB\-i\fR, \fB\-\-information\fR print information about our current connections (once) .TP +\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR +Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. +.TP +\fB\-l \fILOGFILE\fR, \fB\-\-logfile=LOGFILE\fR +configure logging to write logs to LOGFILE +.TP \fB\-m\fR, \fB\-\-monitor\fR print information about our current connections (continuously) .TP -\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR -Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. +\fB\-p \fIPEER\fR, \fB\-\-peer=PEER\fR +the peer identity .TP \fB\-s\fR, \fB\-\-send\fR -transmit (dummy) traffic as quickly as possible to the peer specified with the \-C option. The rate will still be limited by the quota(s) determined by the peers (ATS subsystem). Will run until CTRL\-C is pressed or until the connection to the other peer is disrupted. +transmit (dummy) traffic as quickly as possible to the peer specified with the \-p option. The rate will still be limited by the quota(s) determined by the peers (ATS subsystem). Will run until CTRL\-C is pressed or until the connection to the other peer is disrupted. .TP \fB\-t\fR, \fB\-\-test\fR test transport configuration. With this flag, the tool will check if each of the configured transport plugins has a working address. Plugins that do not have a listen port configured will be ignored. The test is performed with the help of an external server (by default running on gnunet.org) which tries to contact the local machine. The test can only work if the local GNUnet peer is not yet running. diff --git a/doc/man/gnunet-uri.1 b/doc/man/gnunet-uri.1 new file mode 100644 index 0000000..9eac68a --- /dev/null +++ b/doc/man/gnunet-uri.1 @@ -0,0 +1,30 @@ +.TH GNUNET\-URI 1 "Jun 26, 2012" "GNUnet" + +.SH NAME +gnunet\-uri \- invoke default handler for GNUnet URIs + +.SH SYNOPSIS +.B gnunet\-uri +.RI URI +.br + +.SH DESCRIPTION +\fBgnunet\-uri\fP can be used to invoke the correct tool to handle a GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" and thus the specific tool to handle the URI depends on the subsystem. gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM in the configuration section "uri") and invoke it. + +.SH OPTIONS +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-h, \-\-help" +Print short help on options. +.B +.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" +Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. +.B +.IP "\-v, \-\-version" +Print GNUnet version number. + + +.SH BUGS +Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1 index ad5b9db..80b78ce 100644 --- a/doc/man/gnunet-vpn.1 +++ b/doc/man/gnunet-vpn.1 @@ -27,8 +27,8 @@ Display IP address only after the tunnel is fully connected. .IP "\-c FILENAME, \-\-config=FILENAME" Use the configuration file FILENAME. .B -.IP "\-d SEC, \-\-duration SEC" -The mapping should be established for SEC seconds. Default is 5 minutes. +.IP "\-d TIME, \-\-duration TIME" +The mapping should be established for TIME. The value given must be a number followed by a space and a time unit, for example "500 ms". Note that the quotes are required on the shell. Default is 5 minutes. .B .IP "\-h, \-\-help" Print short help on options. diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5 new file mode 100644 index 0000000..0d2f868 --- /dev/null +++ b/doc/man/gnunet.conf.5 @@ -0,0 +1,20 @@ +.TH GNUNET.CONF "5" "25 Oct 2012" "GNUnet" +.SH NAME +gnunet.conf \- GNUnet configuration file +.SH SYNOPSIS +~/.gnunet/gnunet.conf +.SH DESCRIPTION +.PP +A GNUnet setup typically consists of a a set of service processes run by a user "gnunet" and a set of user-interface processes run by a standard account. The service processes are usually started using "gnunet\-arm \-s". The default location for the configuration file is then "~gnunet/.gnunet/gnunet.conf"; however, as normal users also may need read-access to this configuration, you might want to instead put the service process configuration to "/etc/gnunet.conf". gnunet\-setup can be used to edit this configuration. The configuration for normal users is in "$HOME/.gnunet/gnunet.conf". The file does not have to exist, and there are no options that typically require manual configuration in this file. Note that while it is possible to run both sets of processes as the same user (and use one shared configuration file), this breaks some GNUnet components (GADS/GNS) and is generally not recommended. +.TP +The basic structure of the configuration file is the following. The file is split into sections. Every section begins with "[SECTIONNAME]" and contains a number of options of the form "OPTION=VALUE". Empty lines and lines beginning with a "#" are treated as comments. Almost all options are optional and the tools resort to reasonable defaults if they are not present. +.PP +Default values for all of the options can be found in the files in the "$GNUNET_PREFIX/share/gnunet/config.d/" directory. Note that only some of the options can be configured with gnunet\-setup, as for most options the default choice is all that should ever be needed by normal users. However, developers may find some of the other options of interest. +.SH FILES +.TP +~/.gnunet/gnunet.conf +GNUnet configuration file +.SH "REPORTING BUGS" +Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug-gnunet@gnu.org> +.SH "SEE ALSO" +\fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) |