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