aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-08-06 20:46:22 +0000
committerChristian Grothoff <christian@grothoff.org>2013-08-06 20:46:22 +0000
commit303ab4dafbc680b1b362f95df5b12dae831b1593 (patch)
tree8b2f411b0b31e500ce2988404b2501db03bed945 /doc/man
parent1360f8a1e5877a8796dc8e7d0c55d78481382e80 (diff)
downloadgnunet-303ab4dafbc680b1b362f95df5b12dae831b1593.tar.gz
gnunet-303ab4dafbc680b1b362f95df5b12dae831b1593.zip
-fixing main FS build, updating man page of gnunet-pseudonym
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/gnunet-pseudonym.131
1 files changed, 13 insertions, 18 deletions
diff --git a/doc/man/gnunet-pseudonym.1 b/doc/man/gnunet-pseudonym.1
index 1e6de87af..6254283ad 100644
--- a/doc/man/gnunet-pseudonym.1
+++ b/doc/man/gnunet-pseudonym.1
@@ -1,18 +1,18 @@
1.TH GNUNET-PSEUDONYM "1" "25 Feb 2012" "GNUnet" 1.TH GNUNET-PSEUDONYM "1" "6 Aug 2013" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-pseudonym \- create, delete or list pseudonyms 3gnunet\-pseudonym \- advertise or list pseudonyms
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B gnunet\-pseudonym 5.B gnunet\-pseudonym
6[options] 6[options]
7.SH DESCRIPTION 7.SH DESCRIPTION
8.PP 8.PP
9gnunet\-pseudonym is a tool for managing pseudonyms and namespaces. A pseudonym is the persona that controls a namespace. As such, it is identical to a public\-private RSA key pair. A namespace is a collection of files that have been signed by the corresponding private RSA key. A namespace is typically associated with a nickname and other metadata. 9gnunet\-pseudonym is a tool for advertising pseudonyms. A pseudonym is the persona that controls a namespace. As such, it is identical to a public\-private ECC key pair. A namespace is a collection of files that have been signed by the corresponding private ECC key. A namespace is typically associated with a nickname and other metadata.
10 10
11Namespaces are an important tool for providing assurances about content integrity and authenticity in GNUnet. Since all of the content in the namespace must have been provided by the same entity, users can form an opinion about that entity and learn to search (or avoid) certain namespaces. 11Namespaces are an important tool for providing assurances about content integrity and authenticity in GNUnet. Since all of the content in the namespace must have been provided by the same entity, users can form an opinion about that entity and learn to search (or avoid) certain namespaces.
12 12
13gnunet\-pseudonym can be used to list all of the pseudonyms that were created locally, to create new pseudonyms, to delete existing pseudonyms (the namespace will continue to exist, but it will be impossible to add additional data to it) and to list all of the namespaces (with their meta-data) known to the local user. By default, gnunet\-pseudonym lists all pseudonyms that were discovered so far. 13gnunet\-pseudonym can be used to list all of the pseudonyms that were created locally, to advertise namespaces to other users, and to list all of the namespaces (with their meta\-data) known to the local user. By default, gnunet\-pseudonym lists all pseudonyms that were discovered so far.
14 14
15Creating a new pseudonym requires using the \-C option together with a nickname that is to be used for the namespace. Nicknames must be unique for each user, global uniqueness is desirable but not necessary. If two namespaces in GNUnet use the same nickname all GNUnet tools will display the nickname together with a number which ensures that the name becomes locally unique to avoid ambiguity. Additional options can be passed together with the \-C option to provide additional meta\-data that describes the namespace. Possible meta\-data includes the 'realname' of the person controlling the namespace, a description, the mime\-type for content in the namespace (useful if the namespace is dedicated to some specific type of content) and contact information. One important piece of meta\-data that can be specified is the identifier of a document root, that is the name of a file in the namespace that is a portal to the rest of the content. This is useful to help users find this root in the absence of conventions. Note that all of this meta\-data is optional and should never be trusted blindly. 15Advertising a pseudonym requires using the \-A option together with the name of the pseudonym. Names for pseudonyms controlled by the user must be unique. However, names for namespaces of other users may not be globally unique. If two foreign namespaces in GNUnet use the same nickname, all GNUnet tools will display the nickname together with a number which ensures that the name becomes locally unique to avoid ambiguity. Additional options can be passed together with the \-A option to provide additional meta\-data that describes the namespace. Possible meta\-data includes the 'realname' of the person controlling the namespace, a description, the mime\-type for content in the namespace (useful if the namespace is dedicated to some specific type of content) and contact information. One important piece of meta\-data that can be specified is the identifier of a document root, that is the name of a file in the namespace that is a portal to the rest of the content. This is useful to help users find this root in the absence of conventions. Note that all of this meta\-data is optional and should never be trusted blindly.
16 16
17As mentioned before, by default, gnunet\-pseudonym simply lists the meta\-data available for other namespaces. Namespaces can be discovered whenever the peer obtains the namespace advertisement. Namespace advertisements can be found using ordinary keyword\-based searches (by default gnunet\-pseudonym publishes the namespace advertisement under the keyword 'namespace', but the \-k option can be used to specify other keywords) and under the 'empty' identifier of the respective namespace (using a namespace\-search if the namespace ID is already known). 17As mentioned before, by default, gnunet\-pseudonym simply lists the meta\-data available for other namespaces. Namespaces can be discovered whenever the peer obtains the namespace advertisement. Namespace advertisements can be found using ordinary keyword\-based searches (by default gnunet\-pseudonym publishes the namespace advertisement under the keyword 'namespace', but the \-k option can be used to specify other keywords) and under the 'empty' identifier of the respective namespace (using a namespace\-search if the namespace ID is already known).
18 18
@@ -23,12 +23,8 @@ For more details about GNUnet namespaces and content encoding please read the 'E
23set desired level of sender anonymity. Default is 1. 23set desired level of sender anonymity. Default is 1.
24 24
25.TP 25.TP
26\fB\-C NAME\fR, \fB\-\-create=NAME\fR 26\fB\-A NAME\fR, \fB\-\-advertise=NAME\fR
27Creates a new pseudonym with the given NAME or creates a new advertisement for the pseudonym with the given NAME (if the pseudonym already exists). 27Advertise namespace of the pseudonym with the given NAME.
28
29.TP
30\fB\-D NAME\fR, \fB\-\-delete=NAME\fR
31Delete the pseudonym with the given NAME.
32 28
33.TP 29.TP
34\fB\-h\fR, \fB\-\-help\fR 30\fB\-h\fR, \fB\-\-help\fR
@@ -43,10 +39,6 @@ Publish a namespace advertisement under the keyword 'KEYWORD'. Default is 'name
43For the main file (or directory), set the metadata of the given TYPE to the given VALUE. Note that this will not add the respective VALUE to the set of keywords under which the file can be found. 39For the main file (or directory), set the metadata of the given TYPE to the given VALUE. Note that this will not add the respective VALUE to the set of keywords under which the file can be found.
44 40
45.TP 41.TP
46\fB\-o\fR, \fB\-\-only\-local\fR
47display names of local namespaces (those that we can extend with content because we created them)
48
49.TP
50\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR 42\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR
51Set the priority of the namespace advertisement (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 inserted content in favor of content that migrates from other peers. 43Set the priority of the namespace advertisement (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 inserted content in favor of content that migrates from other peers.
52 44
@@ -68,10 +60,13 @@ Change the rating for the namespace identified by ID by VALUE. For example, "\-
68 60
69.SH FILES 61.SH FILES
70.TP 62.TP
71~/.gnunet/data/pseudonyms/ 63~/.gnunet/data/pseudonym/
72Directory where the pseudonyms are stored 64Directory where information about non-local pseudonyms is stored
65.TP
66~/.gnunet/fs/updates/
67Directory where information about possible updates to local pseudonyms is stored
73 68
74.SH "REPORTING BUGS" 69.SH "REPORTING BUGS"
75Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 70Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
76.SH "SEE ALSO" 71.SH "SEE ALSO"
77\fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1) 72\fBgnunet\-identity\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1)