Add.
[shishi.git] / src / shishi.ggo
blobda2ed287553ed57d3ee4f865bbd48ba24443ab0a
1 ## Process this file with gengetopt to produce shishi_cmd.*
2 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 Simon Josefsson.
4 # This file is part of Shishi.
6 # Shishi is free software; you can redistribute it and/or modify it
7 # under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # Shishi is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with Shishi; if not, see http://www.gnu.org/licenses or write
18 # to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
19 # Floor, Boston, MA 02110-1301, USA.
21 package "shishi"
23 purpose "Shishi command line client.  If no command is given, Shishi
24 acquire or list a valid ticket for you, identified by CLIENT (if
25 empty, default username in default realm), for the service SERVER (if
26 empty, ticket granting ticket for client realm)."
28 section "Commands"
30 option "destroy" d "Destroy tickets in local cache, limited by any --client-name or --server-name." flag off
31 option "list" l "List tickets in local cache, limited by any --client-name and --server-name." flag off
32 option "renew" r "Renew ticket.  Use --server-name to specify ticket, default is the most recent renewable ticket granting ticket for the default realm." flag off
34 section "Flags"
35 option "forwardable" - "Get a forwardable ticket, i.e., one that can be used to get forwarded tickets." flag off
36 option "forwarded" - "Get a forwarded ticket." flag off
37 option "proxiable" - "Get a proxiable ticket, i.e., one that can be used to get proxy tickets." flag off
38 option "proxy" - "Get a proxy ticket." flag off
39 option "renewable" - "Get a renewable ticket." flag off
41 section "Options"
42 option "client-name" - "Client name. Default is login username." string typestr="NAME" no
43 option "encryption-type" E "Encryption types to use.  ETYPE is either registered name or integer.  Valid values include 'aes128', 'aes256', 'aes' (same as 'aes256'), '3des', 'des-md5', 'des-md4', 'des-crc', 'des' (same as 'des-md5'), and 'arcfour'." string typestr="ETYPE,[ETYPE...]" no
44 option "endtime" e "Specify when ticket validity should expire.  The time syntax may be relative (to the start time), such as '20 hours', or absolute, such as '2001-02-03 04:05:06 CET'. The default is 8 hours after the start time." string typestr="STRING" no
45 option "realm" - "Set default realm." string typestr="STRING" no
46 option "renew-till" - "Specify renewable life of ticket.  Implies --renewable.  Accepts same time syntax as --endtime.  If --renewable is specified, the default is 1 week after the start time." string typestr="STRING" no
47 option "server-name" - "Server name. Default is 'krbtgt/REALM' where REALM is client realm." string typestr="NAME" no
48 option "starttime" s "Specify when ticket should start to be valid.  Accepts same time syntax as --endtime. The default is to become valid immediately." string typestr="STRING" no
49 option "ticket-granter" - "Service name in ticket to use for authenticating request. Only for TGS. Defaults to 'krbtgt/REALM@REALM' where REALM is client realm." string typestr="NAME" no
51 section "Other options"
53 option "configuration-file" - "Read user configuration from FILE." string typestr="FILE" no
54 option "ticket-file" c "Read tickets from FILE." string typestr="FILE" no
55 option "library-options" o "Parse STRING as a configuration file statement." string typestr="STRING" no
56 option "quiet" q "Don't produce any diagnostic output.\n" flag off
57 option "system-configuration-file" - "Read system configuration from FILE." string typestr="FILE" no
58 option "ticket-write-file" - "Write tickets from FILE.  Default is to write them back to where they were read from." string typestr="FILE" no
59 option "verbose" v "Produce verbose output.\nUse multiple times to increase amount of information." no multiple