diff options
author | Julius Bünger <buenger@mytum.de> | 2018-06-28 00:35:14 +0200 |
---|---|---|
committer | Julius Bünger <buenger@mytum.de> | 2018-06-28 00:35:14 +0200 |
commit | f425a18fa4556aa1f41397de0cb6605017e3f234 (patch) | |
tree | b2cb2dfad8d6de9a4766c2fd092e80262c2805de /doc/documentation | |
parent | ee31ad45010cce040432163b026a3d8c873dd63d (diff) | |
download | gnunet-f425a18fa4556aa1f41397de0cb6605017e3f234.tar.gz gnunet-f425a18fa4556aa1f41397de0cb6605017e3f234.zip |
polish/update user documentation - first steps
Diffstat (limited to 'doc/documentation')
-rw-r--r-- | doc/documentation/chapters/user.texi | 42 |
1 files changed, 20 insertions, 22 deletions
diff --git a/doc/documentation/chapters/user.texi b/doc/documentation/chapters/user.texi index 7bb277421..2dd6cbcb5 100644 --- a/doc/documentation/chapters/user.texi +++ b/doc/documentation/chapters/user.texi | |||
@@ -35,7 +35,7 @@ always welcome. | |||
35 | @node Start and stop GNUnet | 35 | @node Start and stop GNUnet |
36 | @section Start and stop GNUnet | 36 | @section Start and stop GNUnet |
37 | 37 | ||
38 | To start GNUnet: | 38 | Previous to use any GNUnet-based application, one has to start a node: |
39 | 39 | ||
40 | @example | 40 | @example |
41 | $ gnunet-arm -s -l gnunet.log | 41 | $ gnunet-arm -s -l gnunet.log |
@@ -699,9 +699,9 @@ the searcher/downloader specify "no anonymity", non-anonymous | |||
699 | file-sharing is used. If either user specifies some desired degree | 699 | file-sharing is used. If either user specifies some desired degree |
700 | of anonymity, anonymous file-sharing will be used. | 700 | of anonymity, anonymous file-sharing will be used. |
701 | 701 | ||
702 | In this chapter, we will first look at the various concepts in GNUnet's | 702 | After a short introduction, we will first look at the various concepts in |
703 | file-sharing implementation. Then, we will discuss specifics as to | 703 | GNUnet's file-sharing implementation. Then, we will discuss specifics as to how |
704 | how they impact users that publish, search or download files. | 704 | they impact users that publish, search or download files. |
705 | 705 | ||
706 | 706 | ||
707 | @menu | 707 | @menu |
@@ -758,32 +758,28 @@ Search results are printed by gnunet-search like this: | |||
758 | @c it will be better the avoid the ellipsis altogether because I don't | 758 | @c it will be better the avoid the ellipsis altogether because I don't |
759 | @c understand the explanation below that | 759 | @c understand the explanation below that |
760 | @example | 760 | @example |
761 | $ gnunet-download -o "COPYING" --- gnunet://fs/chk/N8...C92.17992 | 761 | #15: |
762 | => The GNU Public License <= (mimetype: text/plain) | 762 | gnunet-download -o "COPYING" gnunet://fs/chk/PGK8M...3EK130.75446 |
763 | |||
763 | @end example | 764 | @end example |
764 | 765 | ||
765 | @noindent | 766 | @noindent |
766 | The first line is the command you would have to enter to download | 767 | The whole line is the command you would have to enter to download |
767 | the file. The argument passed to @code{-o} is the suggested | 768 | the file. The argument passed to @code{-o} is the suggested |
768 | filename (you may change it to whatever you like). | 769 | filename (you may change it to whatever you like). |
769 | @c except it's triple dash in the above example --- | 770 | It is followed by the key for decrypting the file, the query for searching the |
770 | The @code{--} is followed by key for decrypting the file, | 771 | file, a checksum (in hexadecimal) finally the size of the file in bytes. |
771 | the query for searching the file, a checksum (in hexadecimal) | ||
772 | finally the size of the file in bytes. | ||
773 | The second line contains the description of the file; here this is | ||
774 | "The GNU Public License" and the mime-type (see the options for | ||
775 | gnunet-publish on how to specify these). | ||
776 | 772 | ||
777 | @node fs-Downloading | 773 | @node fs-Downloading |
778 | @subsection Downloading | 774 | @subsection Downloading |
779 | @c %**end of header | 775 | @c %**end of header |
780 | 776 | ||
781 | In order to download a file, you need the three values returned by | 777 | In order to download a file, you need the whole line returned by |
782 | @command{gnunet-search}. | 778 | @command{gnunet-search}. |
783 | You can then use the tool @command{gnunet-download} to obtain the file: | 779 | You can then use the tool @command{gnunet-download} to obtain the file: |
784 | 780 | ||
785 | @example | 781 | @example |
786 | $ gnunet-download -o FILENAME --- GNUNETURL | 782 | $ gnunet-download -o <FILENAME> <GNUNET-URL> |
787 | @end example | 783 | @end example |
788 | 784 | ||
789 | @noindent | 785 | @noindent |
@@ -797,7 +793,7 @@ If you want to download the GPL from the previous example, | |||
797 | you do the following: | 793 | you do the following: |
798 | 794 | ||
799 | @example | 795 | @example |
800 | $ gnunet-download -o "COPYING" --- gnunet://fs/chk/N8...92.17992 | 796 | $ gnunet-download -o "COPYING" gnunet://fs/chk/PGK8M...3EK130.75446 |
801 | @end example | 797 | @end example |
802 | 798 | ||
803 | @noindent | 799 | @noindent |
@@ -809,11 +805,9 @@ already present. | |||
809 | GNUnet's file-encoding mechanism will ensure file integrity, even if the | 805 | GNUnet's file-encoding mechanism will ensure file integrity, even if the |
810 | existing file was not downloaded from GNUnet in the first place. | 806 | existing file was not downloaded from GNUnet in the first place. |
811 | 807 | ||
812 | You may want to use the @command{-V} switch (must be added before | 808 | You may want to use the @command{-V} switch to turn on verbose reporting. In |
813 | @c Same as above it's triple dash | 809 | this case, @command{gnunet-download} will print the current number of bytes |
814 | the @command{--}) to turn on verbose reporting. In this case, | 810 | downloaded whenever new data was received. |
815 | @command{gnunet-download} will print the current number of | ||
816 | bytes downloaded whenever new data was received. | ||
817 | 811 | ||
818 | @node fs-Publishing | 812 | @node fs-Publishing |
819 | @subsection Publishing | 813 | @subsection Publishing |
@@ -826,6 +820,10 @@ to the network. The basic format of the command is | |||
826 | $ gnunet-publish [-n] [-k KEYWORDS]* [-m TYPE:VALUE] FILENAME | 820 | $ gnunet-publish [-n] [-k KEYWORDS]* [-m TYPE:VALUE] FILENAME |
827 | @end example | 821 | @end example |
828 | 822 | ||
823 | For example | ||
824 | @example | ||
825 | $ gnunet-publish -m "description:GNU License" -k gpl -k test -m "mimetype:text/plain" COPYING | ||
826 | @end example | ||
829 | 827 | ||
830 | @menu | 828 | @menu |
831 | * Important command-line options:: | 829 | * Important command-line options:: |