summaryrefslogtreecommitdiff
path: root/doc/man/gnunet-directory.1
blob: c08eca46d99d4a122e593bdd9396b67e2ee42972 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.TH GNUNET-DIRECTORY "1" "February 25, 2012" "GNUnet"
.SH NAME
gnunet\-directory \- display directories
.SH SYNOPSIS
.B gnunet\-directory
[\fIOPTIONS\fR] (FILENAME)*
.SH DESCRIPTION
.PP
gnunet\-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.
.TP
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
configuration file to use (useless option since gnunet\-directory does not
really depend on any configuration options)
.TP
\fB\-h\fR, \fB\-\-help\fR
print help page
.TP
\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
Change the loglevel.  Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
.TP
\fB\-v\fR, \fB\-\-version\fR
print the version number
.SH NOTES
A 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.
.PP
If 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.
.PP
At 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.
.PP
GNUnet 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).

.SH BUGS
Report bugs by using mantis <https://bugs.gnunet.org/> 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)
The full documentation for
.B gnunet
is maintained as a Texinfo manual.
If the
.B info
and
.B gnunet
programs are properly installed at your site, the command
.IP
.B info gnunet
.PP
should give you access to the complete handbook,
.IP
.B info gnunet-c-tutorial
.PP
will give you access to a tutorial for developers.
.PP
Depending on your installation, this information is also
available in
\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).