diff options
author | David Sommerseth <dazo@users.sourceforge.net> | 2010-07-06 15:01:50 +0200 |
---|---|---|
committer | David Sommerseth <dazo@users.sourceforge.net> | 2010-07-30 11:02:55 +0200 |
commit | cc065a76ea0f4708843e8871275b976e6f49ddec (patch) | |
tree | 26f5682cd1a3458e36db8e1dfb9c32e00eeb75d9 /eurephiadm | |
parent | 512aa6466e2144feeea5bb8367229955dfcbc0ef (diff) | |
download | eurephia-cc065a76ea0f4708843e8871275b976e6f49ddec.tar.gz eurephia-cc065a76ea0f4708843e8871275b976e6f49ddec.tar.xz eurephia-cc065a76ea0f4708843e8871275b976e6f49ddec.zip |
Added man page for eurephiadm certs
Diffstat (limited to 'eurephiadm')
-rw-r--r-- | eurephiadm/man/eurephiadm-certs.7 | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/eurephiadm/man/eurephiadm-certs.7 b/eurephiadm/man/eurephiadm-certs.7 new file mode 100644 index 0000000..3bb0e5c --- /dev/null +++ b/eurephiadm/man/eurephiadm-certs.7 @@ -0,0 +1,108 @@ +.TH "eurephiadm certs" "7" "July 2010" "David Sommerseth" "" +.SH "NAME" +.B eurephiadm certs +\- Certificate management for +.B eurephia +.SH "DESCRIPTION" +Available modes for the certificate command are: +.TP +\fB\-A\fR | \fB\-\-add\fR +Register a new certificate +.TP +\fB\-D\fR | \fB\-\-delete\fR +Delete a registered certificate +.TP +\fB\-l\fR | \fB\-\-list\fR +List all registered certificates +.HP +\fB\-h\fR | \fB\-\-help\fR <mode> +.br +Help about a specific mode +.SH "LIST MODE" +The list mode will list all registered certificates. It accepts one parameter: +.TP +\fB\-S\fR | \fB\-\-sort\fR <sort key> +Decide the sort order of the certificate list +.PP +Available sort keys are: +.IP +.B certid + Numeric certificate ID +.IP +.B depth + Certificate depth +.IP +.B digest + Certificate SHA1 digest +.IP +.B cname + Certificate Common Name field +.IP +.B org + Certificate organisation field +.IP +.B email + Certificate e\-mail address field +.IP +.B registered + When the certificate was registered in eurephia. +.SH "ADD MODE" +The add mode will register a new certificate. +.TP +\fB\-d\fR | \fB\-\-depth\fR +Certificate depth, required. +.TP +\fB\-D\fR | \fB\-\-digest\fR +SHA1 fingerprint/digest of the new certificate +.TP +\fB\-C\fR | \fB\-\-common\-name\fR +Common name (CN) field of the certificate +.TP +\fB\-O\fR | \fB\-\-organisation\fR +Organisation (O) field of the certificate +.TP +\fB\-E\fR | \fB\-\-email\fR +e\-mail address (emailAddress) of the certificate +.PP +Usually the certificate depth value needs to be 0, if you are registering user +account certificates. CA certificates usually have a value bigger than 0. +.PP +If you have the certificate file available, you can use the following +options to retrieve the needed information directly from a certificate file. +.TP +\fB\-f\fR | \fB\-\-certfile\fR +File name of the certificate file. +.TP +\fB\-p\fR | \fB\-\-pkcs12\fR +If the file is in PKCS#12 format. +.PP +The default format is PEM format, unless \fB\-\-pkcs12\fR is given. These two options +cannot be used together with \fB\-D\fR, \fB\-C\fR, \fB\-O\fR or \fB\-E\fR. But the certificate depth must +be given to indicate the certificate depth. +.SH "DELETE MODE" +The delete mode will remove a certificate from the certificate database. +.TP +\fB\-i\fR | \fB\-\-certid\fR +Indicates a unique certificate ID +.TP +\fB\-d\fR | \fB\-\-digest\fR +A unique SHA1 fingerprint/digest value +.TP +\fB\-C\fR | \fB\-\-common\-name\fR +Common Name (CN) field of a certificate +.TP +\fB\-O\fR | \fB\-\-organisation\fR +Organisation (O) field of a certificate +.TP +\fB\-E\fR | \fB\-\-email\fR +e\-mail address (emailAddress) of a certificate +.PP +You can use any of these parameters to indicate a search criteria for the +certificate (or certificates) you want to delete. You will be provided with +a list over certificates which matches your search criteria and you will need +to approve the deletion of the matching certificate(s). +.SH "SEE ALSO" +\fBeurephiadm\-users\fR(7), +\fBeurephiadm\-usercerts\fR(7) +.SH "AUTHOR" +Copyright (C) 2008\-2010 David Sommerseth <dazo@users.sourceforge.net> |