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.1184
1 files changed, 105 insertions, 79 deletions
diff --git a/doc/man/gnunet-directory.1 b/doc/man/gnunet-directory.1
index c08eca46d..e4be45b28 100644
--- a/doc/man/gnunet-directory.1
+++ b/doc/man/gnunet-directory.1
@@ -1,83 +1,109 @@
1.TH GNUNET-DIRECTORY "1" "February 25, 2012" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-directory \- display directories 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-directory 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6[\fIOPTIONS\fR] (FILENAME)* 6.\" any later version published by the Free Software Foundation; with no
7.SH DESCRIPTION 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.PP 8.\" copy of the license is included in the file
9gnunet\-directory lists the contents of one or more GNUnet directories. 9.\" ``FDL-1.3''.
10A GNUnet directory is a binary file that contains a list of GNUnet 10.\"
11file\-sharing URIs and meta data. The names of the directory files must 11.\" A copy of the license is also available from the Free Software
12be passed as command\-line arguments to gnunet\-directory. 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.TP 13.\"
14\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 14.\" Alternately, this document is also available under the General
15configuration file to use (useless option since gnunet\-directory does not 15.\" Public License, version 3 or later, as published by the Free Software
16really depend on any configuration options) 16.\" Foundation. A copy of the license is included in the file
17.TP 17.\" ``GPL3''.
18\fB\-h\fR, \fB\-\-help\fR 18.\"
19print help page 19.\" A copy of the license is also available from the Free Software
20.TP 20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR 21.\"
22Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.TP 23.\"
24\fB\-v\fR, \fB\-\-version\fR 24.Dd February 25, 2012
25print the version number 25.Dt GNUNET-DIRECTORY 1
26.SH NOTES 26.Os
27.Sh NAME
28.Nm gnunet-directory
29.Nd
30display directories
31.Sh SYNOPSIS
32.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl h | \-help
35.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
36.Op Fl v | \-version
37.Ao Ar FILENAME Ac
38.Sh DESCRIPTION
39.Nm
40lists the contents of one or more GNUnet directories.
41A GNUnet directory is a binary file that contains a list of GNUnet file-sharing URIs and meta data.
42The names of the directory files must be passed as command-line arguments to gnunet-directory.
43The options are as follows:
44.Bl -tag -width Ds
45.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
46Configuration file to use.
47This option is useless, since gnunet-directory does not really depend on any configuration options.
48.It Fl h | \-help
49Print the help page.
50.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
51Change the loglevel.
52Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
53.It Fl v | \-version
54Print the version number.
55.El
56.Ss NOTES
27A GNUnet directory is a file containing a list of GNUnet URIs and meta data. 57A GNUnet directory is a file containing a list of GNUnet URIs and meta data.
28The keys can point to files, other directories or files in namespaces. In other 58The keys can point to files, other directories or files in namespaces.
29words, a GNUnet directory is similar to UNIX directories. The difference to tar 59In other words, a GNUnet directory is similar to UNIX directories.
30and zip is that GNUnet directory does not contain the actual files (except if 60The 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.
31they are really small, in which case they may be inlined), just symbolic (links), 61The 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).
32similar to directories with symbolic links in UNIX filesystems. The benefit is 62Directories can contain arbitrary meta data for each file.
33that the individual files can be retrieved separately (if desired) and if some 63.Pp
34of the files are inserted to another node in GNUnet, this just increases their 64If 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.
35availability but does not produce useless duplicates (for example, it is a 65Files 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.
36better idea to publish a collection of pictures or compressed sound files 66Respecting 32k boundaries where possible makes it easier for gnunet-directory (and other tools) to recover information from partially downloaded directory files.
37using a GNUnet directory instead of processing them with archivers such as 67.Pp
38tar or zip first). Directories can contain arbitrary meta data for each file. 68At the moment, directories can be created by
39.PP 69.Xr gnunet-fs-gtk 1 ,
40If a directory has missing blocks (for example, some blocks failed to download),
41GNUnet is typically able to retrieve information about other files in the
42directory. Files in a GNUnet directory have no particular order; the GNUnet
43code that generates a directory can reorder the entries in order to better
44fit the information about files into blocks of 32k. Respecting 32k boundaries
45where possible makes it easier for gnunet\-directory (and other tools) to
46recover information from partially downloaded directory files.
47.PP
48At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP
49and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be
50published in a namespace.
51.PP
52GNUnet directories use the (unregistered)
53mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal
54search results. The directory file can be downloaded to disk
55by \fBgnunet\-download\fP(1) for later processing or be handled more directly
56by \fBgnunet\-fs\-gtk\fP(1).
57
58.SH BUGS
59Report bugs by using mantis <https://bugs.gnunet.org/> or by sending
60electronic mail to <gnunet\-developers@gnu.org>
61.SH SEE ALSO
62\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
63\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1)
64The full documentation for
65.B gnunet
66is maintained as a Texinfo manual.
67If the
68.B info
69and 70and
70.B gnunet 71.Xr gnunet-publish 1 .
71programs are properly installed at your site, the command 72Just like ordinary files, a directory can be published in a namespace.
72.IP 73.Pp
73.B info gnunet 74GNUnet directories use the (unregistered) mimetype "application/gnunet-directory".
74.PP 75They can show up among normal search results.
76The directory file can be downloaded to disk by
77.Xr gnunet-download 1
78for later processing or be handled more directly by
79.Xr gnunet-fs-gtk 1 .
80.\".Sh EXAMPLES
81.Sh SEE ALSO
82.Xr gnunet-download 1 ,
83.Xr gnunet-fs-gtk 1 ,
84.Xr gnunet-publish 1 ,
85.Xr gnunet-search 1
86.sp
87The full documentation for gnunet is maintained as a Texinfo manual.
88If the
89.Xr info 1
90and gnunet programs are properly installed at your site, the command
91.Pp
92.Dl info gnunet
93.Pp
75should give you access to the complete handbook, 94should give you access to the complete handbook,
76.IP 95.Pp
77.B info gnunet-c-tutorial 96.Dl info gnunet-c-tutorial
78.PP 97.Pp
79will give you access to a tutorial for developers. 98will give you access to a tutorial for developers.
80.PP 99.sp
81Depending on your installation, this information is also 100Depending on your installation, this information is also available in
82available in 101.Xr gnunet 7 and
83\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 102.Xr gnunet-c-tutorial 7 .
103.\".Sh HISTORY
104.\".Sh AUTHORS
105.Sh BUGS
106Report bugs by using
107.Lk https://bugs.gnunet.org
108or by sending electronic mail to
109.Aq Mt gnunet-developers@gnu.org .
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-20 05:19:11 +0000