[ceph.git] / ceph / src / test / cli / ceph-authtool / help.t

# TODO synchronize with man page
  $ ceph-authtool --help
  no command specified
  usage: ceph-authtool keyringfile [OPTIONS]...
  where the options are:
    -l, --list                    will list all keys and capabilities present in
                                  the keyring
    -p, --print-key               will print an encoded key for the specified
                                  entityname. This is suitable for the
                                  'mount -o secret=..' argument
    -C, --create-keyring          will create a new keyring, overwriting any
                                  existing keyringfile
    -g, --gen-key                 will generate a new secret key for the
                                  specified entityname
    --gen-print-key               will generate a new secret key without set it
                                  to the keyringfile, prints the secret to stdout
    --import-keyring FILE         will import the content of a given keyring
                                  into the keyringfile
    -n NAME, --name NAME          specify entityname to operate on
    -u AUID, --set-uid AUID       sets the auid (authenticated user id) for the
                                  specified entityname
    -a BASE64, --add-key BASE64   will add an encoded key to the keyring
    --cap SUBSYSTEM CAPABILITY    will set the capability for given subsystem
    --caps CAPSFILE               will set all of capabilities associated with a
                                  given key, for all subsystems
    --mode MODE                   will set the desired file mode to the keyring
                                  e.g: '0644', defaults to '0600'
  [1]
Commit	Line	Data
7c673cae FG	1	# TODO synchronize with man page
	2	$ ceph-authtool --help
	3	no command specified
	4	usage: ceph-authtool keyringfile [OPTIONS]...
	5	where the options are:
	6	-l, --list will list all keys and capabilities present in
	7	the keyring
	8	-p, --print-key will print an encoded key for the specified
	9	entityname. This is suitable for the
	10	'mount -o secret=..' argument
	11	-C, --create-keyring will create a new keyring, overwriting any
	12	existing keyringfile
	13	-g, --gen-key will generate a new secret key for the
	14	specified entityname
	15	--gen-print-key will generate a new secret key without set it
	16	to the keyringfile, prints the secret to stdout
	17	--import-keyring FILE will import the content of a given keyring
	18	into the keyringfile
	19	-n NAME, --name NAME specify entityname to operate on
	20	-u AUID, --set-uid AUID sets the auid (authenticated user id) for the
	21	specified entityname
	22	-a BASE64, --add-key BASE64 will add an encoded key to the keyring
	23	--cap SUBSYSTEM CAPABILITY will set the capability for given subsystem
	24	--caps CAPSFILE will set all of capabilities associated with a
	25	given key, for all subsystems
94b18763 FG	26	--mode MODE will set the desired file mode to the keyring
94b18763 FG	27	e.g: '0644', defaults to '0600'
7c673cae	28	[1]