Lint man page

$ mandoc -T lint sbotc.1
main
Charles E. Lehner 4 years ago
parent cec6448afd
commit f621b1c1a8
Signed by: cel
GPG Key ID: C28D95BB012367EA

@ -1,6 +1,6 @@
.Dd 2017-06-03 .Dd January 30, 2021
.Dt SBOTC 1 .Dt SBOTC 1
.Os SSBC .Os
.ds REPO ssb://%133ulDgs/oC1DXjoK04vDFy6DgVBB/Zok15YJmuhD5Q=.sha256 .ds REPO ssb://%133ulDgs/oC1DXjoK04vDFy6DgVBB/Zok15YJmuhD5Q=.sha256
.Sh NAME .Sh NAME
.Nm sbotc .Nm sbotc
@ -46,24 +46,30 @@
Connect to a scuttlebot/secret-stack server, and call a method on it, with Connect to a scuttlebot/secret-stack server, and call a method on it, with
standard I/O. standard I/O.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag .Bl -tag -width Ds
.It Fl j .It Fl j
Send stdin data as JSON. Send stdin data as JSON.
.It Fl l .It Fl l
Don't output newlines after string or JSON packets. Don't output newlines after string or JSON packets.
.It Fl r .It Fl r
Raw mode. Disables stdin line buffering/editing and echoing. Implies Raw mode.
Disables stdin line buffering/editing and echoing.
Implies
.Fl l . .Fl l .
.It Fl e .It Fl e
Encode arguments as strings, rather than expecting them to be JSON-encoded. Encode arguments as strings, rather than expecting them to be JSON-encoded.
.It Fl T .It Fl T
Test using shs1-testsuite protocol. Instead of connecting to a peer and calling a RPC method, connect to stdio. On successful handshake, output concatenation of Test using shs1-testsuite protocol.
Instead of connecting to a peer and calling a RPC method, connect to stdio.
On successful handshake, output concatenation of
the encryption key, encryption nonce, decryption key and decryption nonce. the encryption key, encryption nonce, decryption key and decryption nonce.
.It Fl a .It Fl a
Passthrough mode. Instead of making a muxrpc call, pass through the box-stream Passthrough mode.
Instead of making a muxrpc call, pass through the box-stream
to stdio. to stdio.
.It Fl n .It Fl n
Noauth mode. Skip secret-handshake authentication and box-stream encryption. Noauth mode.
Skip secret-handshake authentication and box-stream encryption.
This option makes the This option makes the
.Fl k , .Fl k ,
.Fl K , .Fl K ,
@ -77,31 +83,37 @@ Connect to server over IPv6 only.
.It Fl d .It Fl d
Listen for an incoming connection instead of making an outgoing connection. Listen for an incoming connection instead of making an outgoing connection.
.It Fl c Ar cap .It Fl c Ar cap
Capability key for secret-handshake. Default is SSB's capability key, Capability key for secret-handshake.
Default is SSB's capability key,
.Li 1KHLiKZvAvjbY1ziZEHMXawbCEIM6qwjCDm3VYRan/s= . .Li 1KHLiKZvAvjbY1ziZEHMXawbCEIM6qwjCDm3VYRan/s= .
.It Fl s Ar host .It Fl s Ar host
The hostname to connect to. Default is localhost. If set to localhost and connection to localhost fails, The hostname to connect to.
Default is localhost.
If set to localhost and connection to localhost fails,
.Nm .Nm
may attempt to connect to other local interface addresses. may attempt to connect to other local interface addresses.
.It Fl p Ar port .It Fl p Ar port
The port to connect to. Default is 8008. The port to connect to.
Default is 8008.
.It Fl u Ar socket_path .It Fl u Ar socket_path
Unix socket path to connect to, instead of TCP socket. Conflicts with Unix socket path to connect to, instead of TCP socket.
Conflicts with
.Fl p .Fl p
and and
.Fl s . .Fl s .
.It Fl k Ar key .It Fl k Ar key
The key to connect to. Default is your public key, as read from your The key to connect to.
private key file or the Default is your public key, as read from your private key file or the
.Fl K .Fl K
option. In listen mode ( option.
In listen mode (
.Fl d .Fl d
), if ), if
.Fl k .Fl k
is specified, only a connection from the given key is accepted; otherwise a connection from any key is accepted. is specified, only a connection from the given key is accepted; otherwise a connection from any key is accepted.
.It Fl K Ar keypair .It Fl K Ar keypair
Private key or private key seed to use for secret-handshake. Default is to use the private key Private key or private key seed to use for secret-handshake.
from your Default is to use the private key from your
.Pa ~/.ssb/secret .Pa ~/.ssb/secret
file or other secret file according to the environmental variables described in file or other secret file according to the environmental variables described in
.Sx ENVIRONMENT . .Sx ENVIRONMENT .
@ -117,22 +129,26 @@ Default is to look up the method in
.It Ar method .It Ar method
Method name. Method name.
.It Op Ar argument ... .It Op Ar argument ...
Arguments to pass to the method call. Each argument must be JSON-encoded, unless the Arguments to pass to the method call.
Each argument must be JSON-encoded, unless the
.Fl e .Fl e
option is used, in which the arguments are treated as strings. option is used, in which the arguments are treated as strings.
.El .El
.Sh ENVIRONMENT .Sh ENVIRONMENT
.Bl -tag .Bl -tag -width Ds
.It Ev ssb_appname .It Ev ssb_appname
Name of the app. Default is Name of the app.
Default is
.Dq ssb . .Dq ssb .
Used to construct the app's directory if Used to construct the app's directory if
.Ev ssb_path .Ev ssb_path
is not present. is not present.
.It Ev ssb_path .It Ev ssb_path
Path to the app's directory. Default is to use Path to the app's directory.
.Ev ssb_appname to construct the path as Default is to use
.Dq ~/.<ssb_appname> .Ev ssb_appname
to construct the path as
.Dq ~/.<ssb_appname> .
.El .El
.Sh FILES .Sh FILES
.Bl -tag -width -indent .Bl -tag -width -indent
@ -164,8 +180,8 @@ or
.Fl T .Fl T
are specified, are specified,
.Nm .Nm
will attempt to connect in noauth mode to this socket file. If the socket file will attempt to connect in noauth mode to this socket file.
is not present or the connection fails, If the socket file is not present or the connection fails,
.Nm .Nm
will fall back to connecting with TCP and secret-handshake according to the will fall back to connecting with TCP and secret-handshake according to the
config file - unless the config file - unless the
@ -193,6 +209,5 @@ The command completed with an error.
was written by was written by
.An cel Aq @f/6sQ6d2CMxRUhLpspgGIulDxDCwYD7DzFzPNr7u5AU=.ed25519 . .An cel Aq @f/6sQ6d2CMxRUhLpspgGIulDxDCwYD7DzFzPNr7u5AU=.ed25519 .
.Sh BUGS .Sh BUGS
.Pp
Please report any bugs by making a post on SSB mentioning the repo, Please report any bugs by making a post on SSB mentioning the repo,
.Lk \*[REPO] .Lk \*[REPO]

Loading…
Cancel
Save