Added man page for eurephiadm usercert

1 files changed, 90 insertions, 0 deletions

diff --git a/eurephiadm/man/eurephiadm-usercerts.7 b/eurephiadm/man/eurephiadm-usercerts.7
new file mode 100644
index 0000000..66ea881
--- /dev/null
+++ b/eurephiadm/man/eurephiadm-usercerts.7
@@ -0,0 +1,90 @@
+.TH "eurephiadm usercerts" "7" "July 2010" "David Sommerseth" ""
+.SH "NAME"
+.B eurephiadm usercerts
+ \- Managing user accounts and certificate relations
+.SH "DESCRIPTION"
+For a user to connect to a eurephia enabled OpenVPN server, a user account must have been created and activated and an SSL certificate available to the user must have been registered.  The user account and certificate the user may use must then be linked together, and this linking the \fBeurephiadm usercert\fR command takes care of.
+
+It is also this relation which gives you the option to control which network resources the VPN clients may access, by assigning a firewall profile to such user\-certificate links.
+
+Available modes for the \fBusercerts\fR command are:
+.TP
+\fB\-A\fR | \fB\-\-add\fR
+Register a new certificate and user\-cert link
+.TP
+\fB\-D\fR | \fB\-\-delete\fR
+Delete a certificate and user\-cert link
+.TP
+\fB\-S\fR | \fB\-\-set\-fwprofile\fR
+Sets the firewall access profile for a user\-cert link
+.TP
+\fB\-l\fR | \fB\-\-list\fR
+List all registered user\-cert links
+.TP
+\fB\-h\fR | \fB\-\-help\fR <mode>
+Help about a specific mode
+.PP
+The list mode will list all registered links between user accounts and certificates.
+.SH "LIST MODE"
+The list mode will show all registered user\-certificate links
+.TP
+\fB\-S\fR | \fB\-\-sort\fR <sort keys>
+Define the sorting of the list
+
+Valid sort keys are:
+.IP
+.B uid
+ Nummeric User ID
+.IP
+.B certid
+ Nummeric Certificate ID
+.IP
+.B accessprofile
+ Nummeric firewall profile ID
+.IP
+.B registered
+ According to when the user\-cert was registered
+.IP
+.B uicid
+ Nummeric user\-cert link ID
+.SH "SET FW PROFILE MODE"
+The set\-fwprofile mode will update the firewall access profile for a given user\-cert link
+.PP
+Options: (both required)
+.TP
+\fB\-n\fR | \fB\-\-uicid\fR
+Unique record id of certificate and user account link
+.TP
+\fB\-a\fR | \fB\-\-accessprofile\fR
+Firewall profile ID
+.SH "ADD MODE"
+The add mode will register a new link between a user account and a certificate.
+.TP
+\fB\-c\fR | \fB\-\-certid\fR
+Required \- Certificate ID
+.TP
+\fB\-i\fR | \fB\-\-uid\fR
+Required \- User account ID
+.TP
+\fB\-a\fR | \fB\-\-accessprofile\fR
+Firewall profile ID to use for this access
+.SH "DELETE MODE"
+The delete mode will delete a link between a user account and a certificate.
+.TP
+\fB\-c\fR | \fB\-\-certid\fR
+Certificate ID
+.TP
+\fB\-i\fR | \fB\-\-uid\fR
+User account ID
+.TP
+\fB\-n\fR | \fB\-\-uicid\fR
+Unique record id of certificate and user account link
+.TP
+\fB\-a\fR | \fB\-\-accessprofile\fR
+Firewall profile ID
+.SH "SEE ALSO"
+\fBeurephiadm\-users\fR(7),
+\fBeurephiadm\-certs\fR(7),
+\fBeurephiadm\-fwprofiles\fR(7)
+.SH "AUTHOR"
+Copyright (C) 2008\-2010  David Sommerseth <dazo@users.sourceforge.net>