aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-directory.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-directory.1')
-rw-r--r--doc/man/gnunet-directory.139
1 files changed, 33 insertions, 6 deletions
diff --git a/doc/man/gnunet-directory.1 b/doc/man/gnunet-directory.1
index 373e171f1..9a44be244 100644
--- a/doc/man/gnunet-directory.1
+++ b/doc/man/gnunet-directory.1
@@ -7,10 +7,14 @@ gnunet\-directory \- display directories
7[\fIOPTIONS\fR] (FILENAME)* 7[\fIOPTIONS\fR] (FILENAME)*
8.SH DESCRIPTION 8.SH DESCRIPTION
9.PP 9.PP
10gnunet\-directory lists the contents of one or more GNUnet directories. A GNUnet directory is a binary file that contains a list of GNUnet file\-sharing URIs and meta data. The names of the directory files must be passed as command\-line arguments to gnunet\-directory. 10gnunet\-directory lists the contents of one or more GNUnet directories.
11A GNUnet directory is a binary file that contains a list of GNUnet
12file\-sharing URIs and meta data. The names of the directory files must
13be passed as command\-line arguments to gnunet\-directory.
11.TP 14.TP
12\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 15\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
13configuration file to use (useless option since gnunet\-directory does not really depend on any configuration options) 16configuration file to use (useless option since gnunet\-directory does not
17really depend on any configuration options)
14.TP 18.TP
15\fB\-h\fR, \fB\-\-help\fR 19\fB\-h\fR, \fB\-\-help\fR
16print help page 20print help page
@@ -21,13 +25,36 @@ Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and
21\fB\-v\fR, \fB\-\-version\fR 25\fB\-v\fR, \fB\-\-version\fR
22print the version number 26print the version number
23.SH NOTES 27.SH NOTES
24A GNUnet directory is a file containing a list of GNUnet URIs and meta data. The keys can point to files, other directories or files in namespaces. In other words, a GNUnet directory is similar to UNIX directories. The difference to tar and zip is that GNUnet directory does not contain the actual files (except if they are really small, in which case they may be inlined), just symbolic (links), similar to directories with symbolic links in UNIX filesystems. The benefit is that the individual files can be retrieved separately (if desired) and if some of the files are inserted to another node in GNUnet, this just increases their availability but does not produce useless duplicates (for example, it is a better idea to publish a collection of pictures or compressed sound files using a GNUnet directory instead of processing them with archivers such as tar or zip first). Directories can contain arbitrary meta data for each file. 28A GNUnet directory is a file containing a list of GNUnet URIs and meta data.
29The keys can point to files, other directories or files in namespaces. In other
30words, a GNUnet directory is similar to UNIX directories. The difference to tar
31and zip is that GNUnet directory does not contain the actual files (except if
32they are really small, in which case they may be inlined), just symbolic (links),
33similar to directories with symbolic links in UNIX filesystems. The benefit is
34that the individual files can be retrieved separately (if desired) and if some
35of the files are inserted to another node in GNUnet, this just increases their
36availability but does not produce useless duplicates (for example, it is a
37better idea to publish a collection of pictures or compressed sound files
38using a GNUnet directory instead of processing them with archivers such as
39tar or zip first). Directories can contain arbitrary meta data for each file.
25 40
26If a directory has missing blocks (for example, some blocks failed to download), GNUnet is typically able to retrieve information about other files in the directory. Files in a GNUnet directory have no particular order; the GNUnet code that generates a directory can reorder the entries in order to better fit the information about files into blocks of 32k. Respecting 32k boundaries where possible makes it easier for gnunet\-directory (and other tools) to recover information from partially downloaded directory files. 41If a directory has missing blocks (for example, some blocks failed to download),
42GNUnet is typically able to retrieve information about other files in the
43directory. Files in a GNUnet directory have no particular order; the GNUnet
44code that generates a directory can reorder the entries in order to better
45fit the information about files into blocks of 32k. Respecting 32k boundaries
46where possible makes it easier for gnunet\-directory (and other tools) to
47recover information from partially downloaded directory files.
27 48
28At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be published in a namespace. 49At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP
50and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be
51published in a namespace.
29 52
30GNUnet directories use the (unregistered) mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal search results. The directory file can be downloaded to disk by \fBgnunet\-download\fP(1) for later processing or be handled more directly by \fBgnunet\-fs\-gtk\fP(1). 53GNUnet directories use the (unregistered)
54mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal
55search results. The directory file can be downloaded to disk
56by \fBgnunet\-download\fP(1) for later processing or be handled more directly
57by \fBgnunet\-fs\-gtk\fP(1).
31 58
32.SH "REPORTING BUGS" 59.SH "REPORTING BUGS"
33Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 60Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>