syntax
[oweals/gnunet.git] / doc / man / gnunet-scrypt.1
1 .Dd September 13, 2014
2 .Dt GNUNET-SCRYPT 1
3 .Os
4 .Sh NAME
5 .Nm gnunet-scrypt
6 .Nd
7 manipulate GNUnet proof of work files
8 .Sh SYNOPSIS
9 .Nm
10 .Op Fl b Ar BITS | Fl \-bits= Ns Ar BITS
11 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
12 .Op Fl h | \-help
13 .Op Fl k Ar FILENAME | Fl \-keyfile= Ns Ar FILENAME
14 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
15 .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
16 .Op Fl o Ar FILENAME | Fl \-outfile= Ns Ar FILENAME
17 .Op Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY
18 .Op Fl v | \-version
19 .Sh DESCRIPTION
20 .Nm
21 is a command line tool to manipulate GNUnet proof of work files.
22 .Bl -tag -width Ds
23 .It Fl b Ar BITS | Fl \-bits= Ns Ar BITS
24 Number of bits to require for the proof of work.
25 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
26 Use the configuration file FILENAME.
27 .It Fl h | \-help
28 Print short help on options.
29 .It Fl k Ar FILENAME | Fl \-keyfile= Ns Ar FILENAME
30 File with private key, otherwise default is used.
31 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
32 Use LOGLEVEL for logging.
33 Valid values are DEBUG, INFO, WARNING and ERROR.
34 .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
35 Configure logging to write logs to FILENAME.
36 .It Fl o Ar FILENAME | Fl \-outfile= Ns Ar FILENAME
37 File with proof of work, otherwise default is used.
38 .It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY
39 Time to wait between calculations.
40 .It Fl v | \-version
41 Print GNUnet version number.
42 .Sh SEE ALSO
43 The full documentation for gnunet is maintained as a Texinfo manual.
44 If the
45 .Xr info 1
46 and gnunet programs are properly installed at your site, the command
47 .Pp
48 .Dl info gnunet
49 .Pp
50 should give you access to the complete handbook,
51 .Pp
52 .Dl info gnunet-c-tutorial
53 .Pp
54 will give you access to a tutorial for developers.
55 .sp
56 Depending on your installation, this information is also available in
57 .Xr gnunet 7 and
58 .Xr gnunet-c-tutorial 7 .
59 .\".Sh HISTORY
60 .\".Sh AUTHORS
61 .Sh BUGS
62 Report bugs by using
63 .Lk https://bugs.gnunet.org
64 or by sending electronic mail to
65 .Aq Mt gnunet-developers@gnu.org .