diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/gnunet-scrypt.1 | 125 |
1 files changed, 39 insertions, 86 deletions
diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1 index ab1188348..3b11ca52e 100644 --- a/doc/man/gnunet-scrypt.1 +++ b/doc/man/gnunet-scrypt.1 | |||
@@ -1,91 +1,44 @@ | |||
1 | .\" This file is part of GNUnet. | 1 | .TH GNUNET\-SCRYPT 1 "Sep 13, 2014" "GNUnet" |
2 | .\" Copyright (C) 2001-2019 GNUnet e.V. | 2 | |
3 | .\" | 3 | .SH NAME |
4 | .\" Permission is granted to copy, distribute and/or modify this document | 4 | gnunet\-scrypt \- Manipulate GNUnet proof of work files. |
5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | 5 | |
6 | .\" any later version published by the Free Software Foundation; with no | 6 | .SH SYNOPSIS |
7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | 7 | .B gnunet\-scrypt |
8 | .\" copy of the license is included in the file | 8 | .RI [ options ] |
9 | .\" FDL-1.3. | 9 | .br |
10 | .\" | 10 | |
11 | .\" A copy of the license is also available from the Free Software | 11 | .SH DESCRIPTION |
12 | .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}. | 12 | \fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof of work files. |
13 | .\" | 13 | |
14 | .\" Alternately, this document is also available under the General | 14 | .SH OPTIONS |
15 | .\" Public License, version 3 or later, as published by the Free Software | 15 | .B |
16 | .\" Foundation. A copy of the license is included in the file | 16 | .IP "\-b BITS, \-\-bits=BITS" |
17 | .\" GPL3. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd September 13, 2014 | ||
25 | .Dt GNUNET-SCRYPT 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-scrypt | ||
29 | .Nd manipulate GNUnet proof of work files | ||
30 | .Sh SYNOPSIS | ||
31 | .Nm | ||
32 | .Op Fl b Ar BITS | Fl -bits= Ns Ar BITS | ||
33 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
34 | .Op Fl h | -help | ||
35 | .Op Fl k Ar FILENAME | Fl -keyfile= Ns Ar FILENAME | ||
36 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
37 | .Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME | ||
38 | .Op Fl o Ar FILENAME | Fl -outfile= Ns Ar FILENAME | ||
39 | .Op Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY | ||
40 | .Op Fl v | -version | ||
41 | .Sh DESCRIPTION | ||
42 | .Nm | ||
43 | is a command line tool to manipulate GNUnet proof of work files. | ||
44 | .Bl -tag -width indent | ||
45 | .It Fl b Ar BITS | Fl -bits= Ns Ar BITS | ||
46 | Number of bits to require for the proof of work. | 17 | Number of bits to require for the proof of work. |
47 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 18 | .B |
48 | Use the configuration file | 19 | .IP "\-c FILENAME, \-\-config=FILENAME" |
49 | .Ar FILENAME . | 20 | Use the configuration file FILENAME. |
50 | .It Fl h | -help | 21 | .B |
22 | .IP "\-h, \-\-help" | ||
51 | Print short help on options. | 23 | Print short help on options. |
52 | .It Fl k Ar FILENAME | Fl -keyfile= Ns Ar FILENAME | 24 | .B |
53 | Use | 25 | .IP "\-k FILE, \-\-keyfile=FILE" |
54 | .Ar FILENAME | 26 | File with private key, otherwise default is used. |
55 | as the file with private key, otherwise the default | 27 | .B |
56 | private key file is used. | 28 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
57 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 29 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. |
58 | Use LOGLEVEL for logging. | 30 | .B |
59 | Valid values are DEBUG, INFO, WARNING and ERROR. | 31 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" |
60 | .It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME | 32 | Configure logging to write logs to LOGFILE. |
61 | Configure logging to write logs to FILENAME. | 33 | .B |
62 | .It Fl o Ar FILENAME | Fl -outfile= Ns Ar FILENAME | 34 | .IP "\-o FILE, \-\-outfile=FILE" |
63 | File with proof of work, otherwise default is used. | 35 | File with proof of work, otherwise default is used. |
64 | .It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY | 36 | .B |
37 | .IP "\-t TIME, \-\-timeout=TIME" | ||
65 | Time to wait between calculations. | 38 | Time to wait between calculations. |
66 | .It Fl v | -version | 39 | .B |
40 | .IP "\-v, \-\-version" | ||
67 | Print GNUnet version number. | 41 | Print GNUnet version number. |
68 | .Sh SEE ALSO | 42 | |
69 | The full documentation for gnunet is maintained as a Texinfo manual. | 43 | .SH BUGS |
70 | If the | 44 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> |
71 | .Xr info 1 | ||
72 | and gnunet programs are properly installed at your site, the command | ||
73 | .Pp | ||
74 | .Dl info gnunet | ||
75 | .Pp | ||
76 | should give you access to the complete handbook, | ||
77 | .Pp | ||
78 | .Dl info gnunet-c-tutorial | ||
79 | .Pp | ||
80 | will give you access to a tutorial for developers. | ||
81 | .Pp | ||
82 | Depending on your installation, this information is also available in | ||
83 | .Xr gnunet 7 and | ||
84 | .Xr gnunet-c-tutorial 7 . | ||
85 | .\".Sh HISTORY | ||
86 | .\".Sh AUTHORS | ||
87 | .Sh BUGS | ||
88 | Report bugs by using | ||
89 | .Lk https://bugs.gnunet.org | ||
90 | or by sending electronic mail to | ||
91 | .Aq Mt gnunet-developers@gnu.org . | ||