Skip to content

Commit

Permalink
update longopts message to use '--opt=val'
Browse files Browse the repository at this point in the history 
this helps parsing bash completion with the equal sign for options that require a value, it is more explicit which ones require a value
  • Loading branch information
@nyxnor
nyxnor committed Aug 22, 2022
1 parent c6741d4 commit 9a00d26
Show file tree
Hide file tree
Showing 17 changed files with 384 additions and 289 deletions.
49 changes: 25 additions & 24 deletions auto-generated-man-pages/onionjuggler-cli-auth-client.8
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "ONIONJUGGLER-CLI-AUTH-CLIENT" "8" "2022-08-21" "onionjuggler-cli-auth-client 0.0.1" "Tor's System Manager Manual"
.TH "ONIONJUGGLER-CLI-AUTH-CLIENT" "8" "2022-08-22" "onionjuggler-cli-auth-client 0.0.1" "Tor's System Manager Manual"
.hy
.SH NAME
.PP
Expand All @@ -17,41 +17,42 @@ authorization
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-client [--getopt]\f[R] [\f[B]--service\f[R]
<\f[I]SERVICE\f[R]>]
\f[B]onionjuggler-cli-auth-client [--getopt]\f[R]
[\f[B]--client\f[R]=<\f[I]CLIENT\f[R]>]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-client\f[R] [\f[B]--on\f[R]]
[\f[B]--client-priv-file\f[R] <\f[I]CLIENT_PRIV_FILE\f[R]>]
[\f[B]--client-priv-file\f[R]=<\f[I]CLIENT_PRIV_FILE\f[R]>]
[\f[B]--replace-file\f[R]]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-client\f[R] [\f[B]--on\f[R]]
[\f[B]--client\f[R] <\f[I]CLIENT\f[R]>] [\f[B]--client-priv-config\f[R]
<\f[I]CLIENT_PRIV_CONFIG\f[R]>] [\f[B]--replace-file\f[R]]
[\f[B]--client\f[R]=<\f[I]CLIENT\f[R]>]
[\f[B]--client-priv-config\f[R]=<\f[I]CLIENT_PRIV_CONFIG\f[R]>]
[\f[B]--replace-file\f[R]]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-client\f[R] [\f[B]--on\f[R]]
[\f[B]--client\f[R] <\f[I]CLIENT\f[R]>] [\f[B]--client-priv-key\f[R]
<\f[I]CLIENT_PRIV_KEY\f[R]>] [\f[B]--onion\f[R] <\f[I]ONION\f[R]>]
[\f[B]--replace-file\f[R]]
[\f[B]--client\f[R]=<\f[I]CLIENT\f[R]>]
[\f[B]--client-priv-key\f[R]=<\f[I]CLIENT_PRIV_KEY\f[R]>]
[\f[B]--onion\f[R]=<\f[I]ONION\f[R]>] [\f[B]--replace-file\f[R]]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-client\f[R] [\f[B]--off\f[R]]
[\f[B]--client\f[R] <\f[I]CLIENT\f[R]>]
[\f[B]--client\f[R]=<\f[I]CLIENT\f[R]>]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-client\f[R] [\f[B]--list\f[R]]
.PD 0
.P
.PD
\f[B]onionjuggler-cli\f[R] [\f[B]--signal\f[R]
<\f[I]reload\f[R]|\f[I]restart\f[R]|\f[I]none\f[R]>]
\f[B]onionjuggler-cli\f[R]
[\f[B]--signal\f[R]=<\f[I]reload\f[R]|\f[I]restart\f[R]|\f[I]none\f[R]>]
.PD 0
.P
.PD
Expand All @@ -67,19 +68,19 @@ authorization
authorizations.
.SH OPTIONS
.PP
\f[B]--on\f[R] \f[B]--client-priv-file\f[R] <\f[I]CLIENT_PRIV_FILE\f[R]>
\f[B]--on\f[R] \f[B]--client-priv-file\f[R]=<\f[I]CLIENT_PRIV_FILE\f[R]>
\f[B]--replace-file\f[R]
.PD 0
.P
.PD
\f[B]--on\f[R] \f[B]--client\f[R] <\f[I]CLIENT\f[R]>
\f[B]--client-priv-config\f[R] <\f[I]CLIENT_PRIV_CONFIG\f[R]>
\f[B]--on\f[R] \f[B]--client\f[R]=<\f[I]CLIENT\f[R]>
\f[B]--client-priv-config\f[R]=<\f[I]CLIENT_PRIV_CONFIG\f[R]>
\f[B]--replace-file\f[R]
.PD 0
.P
.PD
.TP
\f[B]--on\f[R] \f[B]--client\f[R] <\f[I]CLIENT\f[R]> \f[B]--onion\f[R] <\f[I]ONION\f[R]> \f[B]--client-priv-key\f[R] <\f[I]CLIENT_PRIV_KEY\f[R]> \f[B]--replace-file\f[R]
\f[B]--on\f[R] \f[B]--client\f[R]=<\f[I]CLIENT\f[R]> \f[B]--onion\f[R]=<\f[I]ONION\f[R]> \f[B]--client-priv-key\f[R]=<\f[I]CLIENT_PRIV_KEY\f[R]> \f[B]--replace-file\f[R]
Authenticate as a client to an onion serivce.
If the client private keys is not provided, a new key pair of public and
private keys will be generated, keys are sent to stdout and you should
Expand All @@ -90,24 +91,24 @@ File(s) modified: ClientOnionAuthDir.
.IP
.nf
\f[C]
onionjuggler-cli-auth-client --on --client-priv-file /home/user/alice.auth_private
onionjuggler-cli-auth-client --on --client alice --client-priv-config fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd:descriptor:x25519:UBVCL52FL6IRYIOLEAYUVTZY3AIOM
onionjuggler-cli-auth-client --on --client alice --onion fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd.onion --client-priv-key UBVCL52FL6IRYIOLEAYUVTZY3AIOMDI3AIFBAALZ7HJOHIJFVBIQ
onionjuggler-cli-auth-client --on --client alice --onion fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd.onion
onionjuggler-cli-auth-client --on --client-priv-file=/home/user/alice.auth_private
onionjuggler-cli-auth-client --on --client=alice --client-priv-config=fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd:descriptor:x25519:UBVCL52FL6IRYIOLEAYUVTZY3AIOM
onionjuggler-cli-auth-client --on --client=alice --onion=fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd.onion --client-priv-key=UBVCL52FL6IRYIOLEAYUVTZY3AIOMDI3AIFBAALZ7HJOHIJFVBIQ
onionjuggler-cli-auth-client --on --client=alice --onion=fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd.onion
\f[R]
.fi
.RE
.TP
\f[B]--off\f[R] \f[B]--client\f[R] <\f[I]CLIENT1,CLIENT2,...\f[R]>
\f[B]--off\f[R] \f[B]--client\f[R]=<\f[I]CLIENT1,CLIENT2,...\f[R]>
Deauthenticate from a remote onion serivce.
Remove the $ONION.auth_private file from ClientOnionAuthDir.
File(s) modified: ClientOnionAuthDir/.
.RS
.IP
.nf
\f[C]
onionjuggler-cli-auth-client --off --onion fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd.onion
onionjuggler-cli-auth-client --off --onion fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd.onion,yyyzxhjk6psc6ul5jnfwloamhtyh7si74b47a3k2q3pskwwxrzhsxmad.onion
onionjuggler-cli-auth-client --off --onion=fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd.onion
onionjuggler-cli-auth-client --off --onion=fe4avn4qtxht5wighyii62n2nw72spfabzv6dyqilokzltet4b2r4wqd.onion,yyyzxhjk6psc6ul5jnfwloamhtyh7si74b47a3k2q3pskwwxrzhsxmad.onion
\f[R]
.fi
.RE
Expand Down Expand Up @@ -135,7 +136,7 @@ Print configuration in the format \f[B]key\f[R]=\[dq]\f[I]val\f[R]\[dq].
\f[B]--getopt\f[R]
Print option parsing results.
.TP
\f[B]--signal\f[R] <\f[I]reload\f[R]|\f[I]hup\f[R]|\f[I]restart\f[R]|\f[I]int\f[R]|\f[I]no\f[R]|\f[I]none\f[R]>
\f[B]--signal\f[R]=<\f[I]reload\f[R]|\f[I]hup\f[R]|\f[I]restart\f[R]|\f[I]int\f[R]|\f[I]no\f[R]|\f[I]none\f[R]>
Send specific signal commands to the tor daemon.
Sending the \f[I]restart|int\f[R] signal is useful for correcting a
previously broken tor configuration.
Expand Down
84 changes: 41 additions & 43 deletions auto-generated-man-pages/onionjuggler-cli-auth-server.8
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "ONIONJUGGLER-CLI-AUTH0-SERVER" "8" "2022-08-21" "onionjuggler-cli-auth-server 0.0.1" "Tor's System Manager Manual"
.TH "ONIONJUGGLER-CLI-AUTH0-SERVER" "8" "2022-08-22" "onionjuggler-cli-auth-server 0.0.1" "Tor's System Manager Manual"
.hy
.SH NAME
.PP
Expand All @@ -14,50 +14,47 @@ authorization
.P
.PD
\f[B]onionjuggler-cli-auth-server\f[R] [\f[B]--on\f[R]]
[\f[B]--service\f[R] <\f[I]SERVICE\f[R]>] [\f[B]--client-pub-file\f[R]
<\f[I]CLIENT_PUB_FILE\f[R]>]
[\f[B]--service\f[R]=<\f[I]SERVICE\f[R]>]
[\f[B]--client-pub-file\f[R]=<\f[I]CLIENT_PUB_FILE\f[R]>]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-server\f[R] [\f[B]--on\f[R]]
[\f[B]--service\f[R] <\f[I]SERVICE\f[R]>] [\f[B]--client\f[R]
<\f[I]CLIENT\f[R]>] [\f[B]--client-pub-config\f[R]
<\f[I]CLIENT_PUB_CONFIG\f[R]>]
[\f[B]--service\f[R]=<\f[I]SERVICE\f[R]>]
[\f[B]--client\f[R]=<\f[I]CLIENT\f[R]>]
[\f[B]--client-pub-config\f[R]=<\f[I]CLIENT_PUB_CONFIG\f[R]>]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-server\f[R] [\f[B]--on\f[R]]
[\f[B]--service\f[R] <\f[I]SERVICE\f[R]>] [\f[B]--client\f[R]
<\f[I]CLIENT\f[R]>] [\f[B]--client-pub-key\f[R]
<\f[I]CLIENT_PUB_KEY\f[R]>]
[\f[B]--service\f[R]=<\f[I]SERVICE\f[R]>]
[\f[B]--client\f[R]=<\f[I]CLIENT\f[R]>]
[\f[B]--client-pub-key\f[R]=<\f[I]CLIENT_PUB_KEY\f[R]>]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-server\f[R] [\f[B]--off\f[R]]
[\f[B]--service\f[R]
<\f[I]\[at]all\f[R]|\f[I]SERV1\f[R],\f[I]SERV2\f[R],\f[I]...\f[R]>]
[\f[B]--client\f[R]
<\f[I]\[at]all\f[R]|\f[I]CLIENT1\f[R],\f[I]CLIENT2\f[R],\f[I]...\f[R]>]
[\f[B]--service\f[R]=<\f[I]\[at]all\f[R]|\f[I]SERV1\f[R],\f[I]SERV2\f[R],\f[I]...\f[R]>]
[\f[B]--client\f[R]=<\f[I]\[at]all\f[R]|\f[I]CLIENT1\f[R],\f[I]CLIENT2\f[R],\f[I]...\f[R]>]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-server\f[R] [\f[B]--list\f[R]]
[\f[B]--service\f[R]
<\f[I]\[at]all\f[R]|\f[I]SERV1\f[R],\f[I]SERV2\f[R],\f[I]...\f[R]>]
[\f[B]--service\f[R]=<\f[I]\[at]all\f[R]|\f[I]SERV1\f[R],\f[I]SERV2\f[R],\f[I]...\f[R]>]
.PD 0
.P
.PD
\f[B]onionjuggler-cli\f[R] [\f[B]--signal\f[R]
<\f[I]reload\f[R]|\f[I]restart\f[R]|\f[I]none\f[R]>]
\f[B]onionjuggler-cli\f[R]
[\f[B]--signal\f[R]=<\f[I]reload\f[R]|\f[I]restart\f[R]|\f[I]none\f[R]>]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-server [--getconf]\f[R]
.PD 0
.P
.PD
\f[B]onionjuggler-cli-auth-server [--getopt]\f[R] [\f[B]--service\f[R]
<\f[I]SERVICE\f[R]>]
\f[B]onionjuggler-cli-auth-server [--getopt]\f[R]
[\f[B]--service\f[R]=<\f[I]SERVICE\f[R]>]
.PD 0
.P
.PD
Expand All @@ -73,26 +70,27 @@ authorization
authorization.
.SH OPTIONS
.PP
\f[B]--on\f[R] \f[B]--service\f[R] <\f[I]SERVICE\f[R]>
\f[B]--client-pub-file\f[R] <\f[I]CLIENT_PUB_FILE\f[R]>
\f[B]--on\f[R] \f[B]--service\f[R]=<\f[I]SERVICE\f[R]>
\f[B]--client-pub-file\f[R]=<\f[I]CLIENT_PUB_FILE\f[R]>
\f[B]--replace-file\f[R]
.PD 0
.P
.PD
\f[B]--on\f[R] \f[B]--service\f[R] <\f[I]SERVICE\f[R]>
\f[B]--client-pub-config\f[R] <\f[I]CLIENT_PUB_CONFIG\f[R]>
\f[B]--on\f[R] \f[B]--service\f[R]=<\f[I]SERVICE\f[R]>
\f[B]--client-pub-config\f[R]=<\f[I]CLIENT_PUB_CONFIG\f[R]>
\f[B]--client\f[R] \f[B]--replace-file\f[R]
.PD 0
.P
.PD
\f[B]--on\f[R] \f[B]--service\f[R] <\f[I]SERVICE\f[R]>
\f[B]--client\f[R] <\f[I]CLIENT\f[R]> \f[B]--client-pub-key\f[R]
<\f[I]CLIENT_PUB_KEY\f[R]> \f[B]--replace-file\f[R]
\f[B]--on\f[R] \f[B]--service\f[R]=<\f[I]SERVICE\f[R]>
\f[B]--client\f[R]=<\f[I]CLIENT\f[R]>
\f[B]--client-pub-key\f[R]=<\f[I]CLIENT_PUB_KEY\f[R]>
\f[B]--replace-file\f[R]
.PD 0
.P
.PD
.TP
\f[B]--on\f[R] \f[B]--service\f[R] <\f[I]SERVICE\f[R]> \f[B]--client\f[R] <\f[I]CLIENT\f[R]>
\f[B]--on\f[R] \f[B]--service\f[R]=<\f[I]SERVICE\f[R]> \f[B]--client\f[R]=<\f[I]CLIENT\f[R]>
Authorize a client to your service.
A key pair of public and private keys will be generated, keys are sent
to stdout and you should send to the client.
Expand All @@ -104,43 +102,43 @@ modified: HiddenServiceDir/authorized_clients/
.IP
.nf
\f[C]
onionjuggler-cli-auth-server --on --service ssh --client-pub-file /home/user/bob.auth
onionjuggler-cli-auth-server --on --service ssh --client bob --client-pub-config descriptor:x25519:UQYM2MJ4CKZU25JABR3Z5L2QP3552EH2BUOIZC2XVULY2QRGXUVQ
onionjuggler-cli-auth-server --on --service ssh --client bob --client-pub-key UQYM2MJ4CKZU25JABR3Z5L2QP3552EH2BUOIZC2XVULY2QRGXUVQ
onionjuggler-cli-auth-server --on --service ssh --client bob
onionjuggler-cli-auth-server --on --service=ssh --client-pub-file=/home/user/bob.auth
onionjuggler-cli-auth-server --on --service=ssh --client=bob --client-pub-config=descriptor:x25519:UQYM2MJ4CKZU25JABR3Z5L2QP3552EH2BUOIZC2XVULY2QRGXUVQ
onionjuggler-cli-auth-server --on --service=ssh --client=bob --client-pub-key=UQYM2MJ4CKZU25JABR3Z5L2QP3552EH2BUOIZC2XVULY2QRGXUVQ
onionjuggler-cli-auth-server --on --service=ssh --client=bob
\f[R]
.fi
.RE
.TP
\f[B]--off\f[R] \f[B]--service\f[R] <\f[I]\[at]all\f[R]|\f[I]SERV1\f[R],\f[I]SERV2\f[R],\f[I]...\f[R]> \f[B]--client\f[R] <\f[I]\[at]all\f[R]|\f[I]CLIENT1\f[R],\f[I]CLIENT2\f[R],\f[I]...\f[R]>
\f[B]--off\f[R] \f[B]--service\f[R]=<\f[I]\[at]all\f[R]|\f[I]SERV1\f[R],\f[I]SERV2\f[R],\f[I]...\f[R]> \f[B]--client\f[R]=<\f[I]\[at]all\f[R]|\f[I]CLIENT1\f[R],\f[I]CLIENT2\f[R],\f[I]...\f[R]>
Deauthorize from your service a client that is inside
HiddenServiceDir/authorized_clients folder.
File(s) modified: HiddenServiceDir/authorized_clients/
.RS
.IP
.nf
\f[C]
onionjuggler-cli-auth-server --off --service ssh --client alice
onionjuggler-cli-auth-server --off --service ssh --client alice,bob
onionjuggler-cli-auth-server --off --service ssh,xmpp --client alice
onionjuggler-cli-auth-server --off --service ssh,xmpp --client alice,bob
onionjuggler-cli-auth-server --off --service \[at]all --client alice,bob
onionjuggler-cli-auth-server --off --service \[at]all --client \[at]all
onionjuggler-cli-auth-server --off --service=ssh --client=alice
onionjuggler-cli-auth-server --off --service=ssh --client=alice,bob
onionjuggler-cli-auth-server --off --service=ssh,xmpp --client=alice
onionjuggler-cli-auth-server --off --service=ssh,xmpp --client=alice,bob
onionjuggler-cli-auth-server --off --service=\[at]all --client=alice,bob
onionjuggler-cli-auth-server --off --service=\[at]all --client=\[at]all
\f[R]
.fi
.RE
.TP
\f[B]--list\f[R] \f[B]--service\f[R] <\f[I]\[at]all\f[R]|\f[I]SERV1\f[R],\f[I]SERV2\f[R],\f[I]...\f[R]>
\f[B]--list\f[R] \f[B]--service\f[R]=<\f[I]\[at]all\f[R]|\f[I]SERV1\f[R],\f[I]SERV2\f[R],\f[I]...\f[R]>
List authorized clients and the respective public keys that are inside
HiddenServiceDir/authorized_clients folder.
File(s) modified: none
.RS
.IP
.nf
\f[C]
onionjuggler-cli-auth-server --list --service ssh
onionjuggler-cli-auth-server --list --service ssh,xmpp
onionjuggler-cli-auth-server --list --service \[at]all
onionjuggler-cli-auth-server --list --service=ssh
onionjuggler-cli-auth-server --list --service=ssh,xmpp
onionjuggler-cli-auth-server --list --service=\[at]all
\f[R]
.fi
.RE
Expand All @@ -154,7 +152,7 @@ Print configuration in the format \f[B]key\f[R]=\[dq]\f[I]val\f[R]\[dq].
\f[B]--getopt\f[R]
Print option parsing results.
.TP
\f[B]--signal\f[R] <\f[I]reload\f[R]|\f[I]hup\f[R]|\f[I]restart\f[R]|\f[I]int\f[R]|\f[I]no\f[R]|\f[I]none\f[R]>
\f[B]--signal\f[R]=<\f[I]reload\f[R]|\f[I]hup\f[R]|\f[I]restart\f[R]|\f[I]int\f[R]|\f[I]no\f[R]|\f[I]none\f[R]>
Send specific signal commands to the tor daemon.
Sending the \f[I]restart|int\f[R] signal is useful for correcting a
previously broken tor configuration.
Expand Down
Loading

0 comments on commit 9a00d26

Please sign in to comment.