diff options
author | ng0 <ng0@infotropique.org> | 2017-10-26 13:23:24 +0000 |
---|---|---|
committer | ng0 <ng0@infotropique.org> | 2017-10-26 13:23:24 +0000 |
commit | 8a7db950118a53cfa9ed69eab2785fe7f71647c1 (patch) | |
tree | ffbb8d3f12fb529d833a3e7b7560b037f53dbcea /doc | |
parent | 732816be49f49ec4b3db669b73d817fe5f930803 (diff) | |
download | gnunet-8a7db950118a53cfa9ed69eab2785fe7f71647c1.tar.gz gnunet-8a7db950118a53cfa9ed69eab2785fe7f71647c1.zip |
user.texi: change @code{} -> @command{} for commands.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/documentation/chapters/user.texi | 56 |
1 files changed, 29 insertions, 27 deletions
diff --git a/doc/documentation/chapters/user.texi b/doc/documentation/chapters/user.texi index 6e339c697..395524a6d 100644 --- a/doc/documentation/chapters/user.texi +++ b/doc/documentation/chapters/user.texi | |||
@@ -9,11 +9,13 @@ Instead, we start by briefly checking that the installation works, and | |||
9 | then dive into simple, concrete practical things that can be done | 9 | then dive into simple, concrete practical things that can be done |
10 | with the network. | 10 | with the network. |
11 | 11 | ||
12 | This chapter documents how to use the various Peer-to-Peer applications | 12 | This chapter of the GNUnet Reference Documentation documents |
13 | of the GNUnet system. As GNUnet evolves, we will add new chapters for | 13 | how to use the various peer-to-peer applications of the |
14 | the various applications that are being created. | 14 | GNUnet system. |
15 | As GNUnet evolves, we will add new chapters for the various | ||
16 | applications that are being created. | ||
15 | 17 | ||
16 | Comments and extensions are always welcome. | 18 | Comments and extensions of this documentation are always welcome. |
17 | 19 | ||
18 | 20 | ||
19 | @menu | 21 | @menu |
@@ -31,7 +33,7 @@ Comments and extensions are always welcome. | |||
31 | @section Checking the Installation | 33 | @section Checking the Installation |
32 | @c %**end of header | 34 | @c %**end of header |
33 | 35 | ||
34 | This chapter describes a quick casual way to check if your GNUnet | 36 | This section describes a quick casual way to check if your GNUnet |
35 | installation works. However, if it does not, we do not cover | 37 | installation works. However, if it does not, we do not cover |
36 | steps for recovery --- for this, please study the installation and | 38 | steps for recovery --- for this, please study the installation and |
37 | configuration handbooks. | 39 | configuration handbooks. |
@@ -47,7 +49,7 @@ configuration handbooks. | |||
47 | @subsection gnunet-gtk | 49 | @subsection gnunet-gtk |
48 | @c %**end of header | 50 | @c %**end of header |
49 | 51 | ||
50 | First, you should launch @code{gnunet-gtk}, the graphical user | 52 | First, you should launch @command{gnunet-gtk}, the graphical user |
51 | interface for GNUnet which will be used for most of the tutorial. | 53 | interface for GNUnet which will be used for most of the tutorial. |
52 | You can do this from the command-line by typing | 54 | You can do this from the command-line by typing |
53 | 55 | ||
@@ -56,14 +58,14 @@ $ gnunet-gtk | |||
56 | @end example | 58 | @end example |
57 | 59 | ||
58 | (note that @code{$} represents the prompt of the shell for a normal user). | 60 | (note that @code{$} represents the prompt of the shell for a normal user). |
59 | Depending on your distribution, you may also find @code{gnunet-gtk} | 61 | Depending on your distribution, you may also find @command{gnunet-gtk} |
60 | in your menus. After starting @code{gnunet-gtk}, you should see the | 62 | in your menus. After starting @command{gnunet-gtk}, you should see the |
61 | following window: | 63 | following window: |
62 | 64 | ||
63 | @c @image{images/gnunet-gtk-0-10,5in,, picture of gnunet-gtk application} | 65 | @c @image{images/gnunet-gtk-0-10,5in,, picture of gnunet-gtk application} |
64 | 66 | ||
65 | The five images on top represent the five different graphical applications | 67 | The five images on top represent the five different graphical applications |
66 | that you can use within @code{gnunet-gtk}. They are (from left to right): | 68 | that you can use within @command{gnunet-gtk}. They are (from left to right): |
67 | 69 | ||
68 | @itemize @bullet | 70 | @itemize @bullet |
69 | @item Statistics | 71 | @item Statistics |
@@ -77,13 +79,13 @@ that you can use within @code{gnunet-gtk}. They are (from left to right): | |||
77 | @subsection Statistics | 79 | @subsection Statistics |
78 | @c %**end of header | 80 | @c %**end of header |
79 | 81 | ||
80 | When @code{gnunet-gtk} is started, the statistics area should be selected | 82 | When @command{gnunet-gtk} is started, the statistics area should be selected |
81 | at first. If your peer is running correctly, you should see a bunch of | 83 | at first. If your peer is running correctly, you should see a bunch of |
82 | lines, all of which should be "significantly" above zero (at least if your | 84 | lines, all of which should be "significantly" above zero (at least if your |
83 | peer has been running for a few seconds). The lines indicate how many other | 85 | peer has been running for a few seconds). The lines indicate how many other |
84 | peers your peer is connected to (via different mechanisms) and how large | 86 | peers your peer is connected to (via different mechanisms) and how large |
85 | the overall overlay network is currently estimated to be. The X-axis | 87 | the overall overlay network is currently estimated to be. The X-axis |
86 | represents time (in seconds since the start of @code{gnunet-gtk}). | 88 | represents time (in seconds since the start of @command{gnunet-gtk}). |
87 | 89 | ||
88 | You can click on "Traffic" to see information about the amount of | 90 | You can click on "Traffic" to see information about the amount of |
89 | bandwidth your peer has consumed, and on "Storage" to check the amount | 91 | bandwidth your peer has consumed, and on "Storage" to check the amount |
@@ -110,7 +112,7 @@ network configuration. | |||
110 | @c %**end of header | 112 | @c %**end of header |
111 | 113 | ||
112 | This chapter describes first steps for file-sharing with GNUnet. | 114 | This chapter describes first steps for file-sharing with GNUnet. |
113 | To start, you should launch @code{gnunet-gtk} and select the | 115 | To start, you should launch @command{gnunet-gtk} and select the |
114 | file-sharing tab (the one with the arrows between the three circles). | 116 | file-sharing tab (the one with the arrows between the three circles). |
115 | 117 | ||
116 | As we want to be sure that the network contains the data that we are | 118 | As we want to be sure that the network contains the data that we are |
@@ -262,7 +264,7 @@ That's it, you now know the basics for file-sharing with GNUnet! | |||
262 | @c %**end of header | 264 | @c %**end of header |
263 | 265 | ||
264 | First, we will check if the GNU Name System installation was | 266 | First, we will check if the GNU Name System installation was |
265 | completed normally. For this, we first start @code{gnunet-gtk} | 267 | completed normally. For this, we first start @command{gnunet-gtk} |
266 | and switch to the Identity Management tab by clicking on the image | 268 | and switch to the Identity Management tab by clicking on the image |
267 | in the top right corner with the three people in it. Identity management | 269 | in the top right corner with the three people in it. Identity management |
268 | is about managing our own identities --- GNUnet users are expected to | 270 | is about managing our own identities --- GNUnet users are expected to |
@@ -394,7 +396,7 @@ where @code{gnunet-bcd} is running a Web server! | |||
394 | 396 | ||
395 | First, you might want to fill in the "GNS Public Key" field by | 397 | First, you might want to fill in the "GNS Public Key" field by |
396 | right-clicking and selecting "Paste", filling in the public key | 398 | right-clicking and selecting "Paste", filling in the public key |
397 | from the copy you made in @code{gnunet-gtk}. Then, fill in all | 399 | from the copy you made in @command{gnunet-gtk}. Then, fill in all |
398 | of the other fields, including your GNS NICKname. Adding a | 400 | of the other fields, including your GNS NICKname. Adding a |
399 | GPG fingerprint is optional. Once finished, click "Submit Query". | 401 | GPG fingerprint is optional. Once finished, click "Submit Query". |
400 | If your @code{LaTeX} installation is incomplete, the result will be | 402 | If your @code{LaTeX} installation is incomplete, the result will be |
@@ -791,8 +793,8 @@ to install the NSS plugins in the proper location. | |||
791 | @subsection Exit configuration | 793 | @subsection Exit configuration |
792 | @c %**end of header | 794 | @c %**end of header |
793 | 795 | ||
794 | Stop your peer (as user @code{gnunet}, run @code{gnunet-arm -e}) and run | 796 | Stop your peer (as user @code{gnunet}, run @command{gnunet-arm -e}) and run |
795 | @code{gnunet-setup}. In @code{gnunet-setup}, make sure to activate the | 797 | @command{gnunet-setup}. In @command{gnunet-setup}, make sure to activate the |
796 | @strong{EXIT} and @strong{GNS} services in the General tab. Then select | 798 | @strong{EXIT} and @strong{GNS} services in the General tab. Then select |
797 | the Exit tab. Most of the defaults should be fine (but you should check | 799 | the Exit tab. Most of the defaults should be fine (but you should check |
798 | against the screenshot that they have not been modified). In the | 800 | against the screenshot that they have not been modified). In the |
@@ -800,26 +802,26 @@ bottom area, enter @code{bcd} under Identifier and change the | |||
800 | Destination to @code{169.254.86.1:8888} (if your server runs on a port | 802 | Destination to @code{169.254.86.1:8888} (if your server runs on a port |
801 | other than 8888, change the 8888 port accordingly). | 803 | other than 8888, change the 8888 port accordingly). |
802 | 804 | ||
803 | Now exit @code{gnunet-setup} and restart your peer (@code{gnunet-arm -s}). | 805 | Now exit @command{gnunet-setup} and restart your peer (@command{gnunet-arm -s}). |
804 | 806 | ||
805 | @node GNS configuration | 807 | @node GNS configuration |
806 | @subsection GNS configuration | 808 | @subsection GNS configuration |
807 | @c %**end of header | 809 | @c %**end of header |
808 | 810 | ||
809 | Now, using your normal user (not the @code{gnunet} system user), run | 811 | Now, using your normal user (not the @code{gnunet} system user), run |
810 | @code{gnunet-gtk}. Select the GNS icon and add a new label www in your | 812 | @command{gnunet-gtk}. Select the GNS icon and add a new label www in your |
811 | master zone. For the record type, select @code{VPN}. You should then | 813 | master zone. For the record type, select @code{VPN}. You should then |
812 | see the VPN dialog: | 814 | see the VPN dialog: |
813 | 815 | ||
814 | @c insert image | 816 | @c insert image |
815 | 817 | ||
816 | Under peer, you need to supply the peer identity of your own peer. You can | 818 | Under peer, you need to supply the peer identity of your own peer. You can |
817 | obtain the respective string by running @code{ $ gnunet-peerinfo -sq} | 819 | obtain the respective string by running @command{gnunet-peerinfo -sq} |
818 | as the @code{gnunet} user. For the Identifier, you need to supply the same | 820 | as the @code{gnunet} user. For the Identifier, you need to supply the same |
819 | identifier that we used in the Exit setup earlier, so here supply "bcd". | 821 | identifier that we used in the Exit setup earlier, so here supply "bcd". |
820 | If you want others to be able to use the service, you should probably make | 822 | If you want others to be able to use the service, you should probably make |
821 | the record public. For non-public services, you should use a passphrase | 823 | the record public. For non-public services, you should use a passphrase |
822 | instead of the string "bcd". Save the record and exit @code{gnunet-gtk}. | 824 | instead of the string "bcd". Save the record and exit @command{gnunet-gtk}. |
823 | 825 | ||
824 | @node Accessing the service | 826 | @node Accessing the service |
825 | @subsection Accessing the service | 827 | @subsection Accessing the service |
@@ -999,7 +1001,7 @@ Note that GNUnet differenciates between your pseudonyms (the identities | |||
999 | that you control) and namespaces. If you create a pseudonym, you will | 1001 | that you control) and namespaces. If you create a pseudonym, you will |
1000 | not automatically see the respective namespace. You first have to create | 1002 | not automatically see the respective namespace. You first have to create |
1001 | an advertisement for the namespace and find it using keyword | 1003 | an advertisement for the namespace and find it using keyword |
1002 | search --- even for your own namespaces. The @code{gnunet-pseudonym} | 1004 | search --- even for your own namespaces. The @command{gnunet-pseudonym} |
1003 | tool is currently responsible for both managing pseudonyms and namespaces. | 1005 | tool is currently responsible for both managing pseudonyms and namespaces. |
1004 | This will likely change in the future to reduce the potential for | 1006 | This will likely change in the future to reduce the potential for |
1005 | confusion. | 1007 | confusion. |
@@ -1050,7 +1052,7 @@ selection is simply random. | |||
1050 | @subsection File-sharing Publishing | 1052 | @subsection File-sharing Publishing |
1051 | @c %**end of header | 1053 | @c %**end of header |
1052 | 1054 | ||
1053 | The command @code{gnunet-publish} can be used to add content | 1055 | The command @command{gnunet-publish} can be used to add content |
1054 | to the network. The basic format of the command is | 1056 | to the network. The basic format of the command is |
1055 | 1057 | ||
1056 | @example | 1058 | @example |
@@ -1075,7 +1077,7 @@ retrieve the file. | |||
1075 | The -m option is used to specify meta-data, such as descriptions. | 1077 | The -m option is used to specify meta-data, such as descriptions. |
1076 | You can use -m multiple times. The TYPE passed must be from the | 1078 | You can use -m multiple times. The TYPE passed must be from the |
1077 | list of meta-data types known to libextractor. You can obtain this | 1079 | list of meta-data types known to libextractor. You can obtain this |
1078 | list by running @code{extract -L}. Use quotes around the entire | 1080 | list by running @command{extract -L}. Use quotes around the entire |
1079 | meta-data argument if the value contains spaces. The meta-data | 1081 | meta-data argument if the value contains spaces. The meta-data |
1080 | is displayed to other users when they select which files to | 1082 | is displayed to other users when they select which files to |
1081 | download. The meta-data and the keywords are optional and | 1083 | download. The meta-data and the keywords are optional and |
@@ -1111,7 +1113,7 @@ Thus indexing should be used for all files where the user will keep | |||
1111 | using this file (at the location given to gnunet-publish) and does | 1113 | using this file (at the location given to gnunet-publish) and does |
1112 | not want to retrieve it back from GNUnet each time. If you want to | 1114 | not want to retrieve it back from GNUnet each time. If you want to |
1113 | remove a file that you have indexed from the local peer, use the tool | 1115 | remove a file that you have indexed from the local peer, use the tool |
1114 | @code{gnunet-unindex} to un-index the file. | 1116 | @command{gnunet-unindex} to un-index the file. |
1115 | 1117 | ||
1116 | The option @code{-n} may be used if the user fears that the file might | 1118 | The option @code{-n} may be used if the user fears that the file might |
1117 | be found on their drive (assuming the computer comes under the control | 1119 | be found on their drive (assuming the computer comes under the control |
@@ -1124,7 +1126,7 @@ able to crack the encryption (e.g. by guessing the keyword. | |||
1124 | @subsection File-sharing Searching | 1126 | @subsection File-sharing Searching |
1125 | @c %**end of header | 1127 | @c %**end of header |
1126 | 1128 | ||
1127 | The command @code{gnunet-search} can be used to search | 1129 | The command @command{gnunet-search} can be used to search |
1128 | for content on GNUnet. The format is: | 1130 | for content on GNUnet. The format is: |
1129 | 1131 | ||
1130 | @example | 1132 | @example |
@@ -1181,8 +1183,8 @@ gnunet-publish on how to specify these). | |||
1181 | @c %**end of header | 1183 | @c %**end of header |
1182 | 1184 | ||
1183 | In order to download a file, you need the three values returned by | 1185 | In order to download a file, you need the three values returned by |
1184 | @code{gnunet-search}. | 1186 | @command{gnunet-search}. |
1185 | You can then use the tool @code{gnunet-download} to obtain the file: | 1187 | You can then use the tool @command{gnunet-download} to obtain the file: |
1186 | 1188 | ||
1187 | @example | 1189 | @example |
1188 | $ gnunet-download -o FILENAME --- GNUNETURL | 1190 | $ gnunet-download -o FILENAME --- GNUNETURL |