man/produce_html: use shlib
[oweals/gnunet.git] / doc / man / gnunet-reclaim.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 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 http://www.gnu.org/licenses/gpl.html
21 .\"
22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23 .\"
24 .Dd May 12, 2019
25 .Dt GNUNET-RECLAIM 1
26 .Os
27 .Sh NAME
28 .Nm gnunet-reclaim
29 .Nd Command-line tools for re:claimID subsystem
30 .Sh SYNOPSIS
31 .Nm
32 .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
33 .Op Fl h | -help
34 .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
35 .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
36 .Op Fl e Ar EGO | Fl -ego= Ns Ar EGO
37 .Op Fl a Ar NAME | Fl -add= Ns Ar NAME
38 .Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE
39 .Op Fl d Ar ID | Fl -delete= Ns Ar ID
40 .Op Fl r Ar RP | Fl -rp= Ns Ar RP
41 .Op Fl D | -dump
42 .Op Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,...
43 .Op Fl C Ar TICKET | Fl -consume= Ns Ar TICKET
44 .Op Fl R Ar TICKET | Fl -revoke= Ns Ar TICKET
45 .Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
46 .Op Fl T | -tickets
47 .Op Fl E Ar INTERVAL | Fl -expiration= Ns Ar INTERVAL
48 .Op Fl v | -version
49 .Sh DESCRIPTION
50 .Nm
51 allows you to manage identity attributes and manage authorizations.
52 .Bl -tag -width indent
53 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
54 Use the configuration file FILENAME.
55 .It Fl h | -help
56 Print short help on options.
57 .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
58 Use LOGLEVEL for logging.
59 Valid values are DEBUG, INFO, WARNING and ERROR.
60 .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
61 Configure logging to write logs to LOGFILE.
62 .It Fl e Ar EGO | Fl -ego= Ns Ar EGO
63 Specify identity to use. Always required.
64 .It Fl a Ar NAME | Fl -add= Ns Ar NAME
65 Add an attribute with NAME. Must be used in conjunction with -V
66 .It Fl V Ar VALUE | Fl -value= Ns Ar VALUE
67 Specify value of attribute to add.
68 .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
69 Specify type of attribute to add (Default: STRING)
70 .It Fl d Ar ID | Fl -delete= Ns Ar ID
71 Delete an attribute with ID.
72 .It Fl E Ar INTERVAL | Fl -expiration= Ns Ar INTERVAL
73 Specify relative expiration interval (freshness) of attribute.
74 .It Fl D | -dump
75 List all attributes for given identity.
76 .It Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,...
77 Authorize a relying party to access a set of attributes. Must be
78 used in conjunction with -r. Returns a TICKET.
79 .It Fl r Ar RP | Fl -rp= Ns Ar RP
80 The relying party to authorize (see -i). RP is a PKEY of the entity.
81 .It Fl C Ar TICKET | Fl -consume= Ns Ar TICKET
82 Consume TICKET and retrieve shared attributes. To be used by RP.
83 .It Fl R Ar TICKET | Fl -revoke= Ns Ar TICKET
84 Revoke TICKET. To be used by identity which issued TICKET.
85 .It Fl T | -tickets
86 List issued tickets.
87 .It Fl v | -version
88 Print GNUnet version number.
89 .El
90 .\".Sh EXAMPLES
91 .Sh SEE ALSO
92 The full documentation for gnunet is maintained as a Texinfo manual.
93 If the
94 .Xr info 1
95 and gnunet programs are properly installed at your site, the command
96 .Pp
97 .Dl info gnunet
98 .Pp
99 should give you access to the complete handbook,
100 .Pp
101 .Dl info gnunet-c-tutorial
102 .Pp
103 will give you access to a tutorial for developers.
104 .sp
105 Depending on your installation, this information is also available in
106 .Xr gnunet 7 and
107 .Xr gnunet-c-tutorial 7 .
108 .\".Sh HISTORY
109 .\".Sh AUTHORS
110 .Sh BUGS
111 Report bugs by using
112 .Lk https://bugs.gnunet.org
113 or by sending electronic mail to
114 .Aq Mt gnunet-developers@gnu.org .