diff --git a/sbotc.1 b/sbotc.1 index e2bbfe2..738e3d1 100644 --- a/sbotc.1 +++ b/sbotc.1 @@ -1,6 +1,6 @@ -.Dd 2017-06-03 +.Dd January 30, 2021 .Dt SBOTC 1 -.Os SSBC +.Os .ds REPO ssb://%133ulDgs/oC1DXjoK04vDFy6DgVBB/Zok15YJmuhD5Q=.sha256 .Sh NAME .Nm sbotc @@ -46,24 +46,30 @@ Connect to a scuttlebot/secret-stack server, and call a method on it, with standard I/O. .Sh OPTIONS -.Bl -tag +.Bl -tag -width Ds .It Fl j Send stdin data as JSON. .It Fl l Don't output newlines after string or JSON packets. .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 . .It Fl e Encode arguments as strings, rather than expecting them to be JSON-encoded. .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. .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. .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 .Fl k , .Fl K , @@ -77,31 +83,37 @@ Connect to server over IPv6 only. .It Fl d Listen for an incoming connection instead of making an outgoing connection. .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= . .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 may attempt to connect to other local interface addresses. .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 -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 and .Fl s . .It Fl k Ar key -The key to connect to. Default is your public key, as read from your -private key file or the +The key to connect to. +Default is your public key, as read from your private key file or the .Fl K -option. In listen mode ( +option. +In listen mode ( .Fl d ), if .Fl k is specified, only a connection from the given key is accepted; otherwise a connection from any key is accepted. .It Fl K Ar keypair -Private key or private key seed to use for secret-handshake. Default is to use the private key -from your +Private key or private key seed to use for secret-handshake. +Default is to use the private key from your .Pa ~/.ssb/secret file or other secret file according to the environmental variables described in .Sx ENVIRONMENT . @@ -117,22 +129,26 @@ Default is to look up the method in .It Ar method Method name. .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 option is used, in which the arguments are treated as strings. .El .Sh ENVIRONMENT -.Bl -tag +.Bl -tag -width Ds .It Ev ssb_appname -Name of the app. Default is +Name of the app. +Default is .Dq ssb . Used to construct the app's directory if .Ev ssb_path is not present. .It Ev ssb_path -Path to the app's directory. Default is to use -.Ev ssb_appname to construct the path as -.Dq ~/. +Path to the app's directory. +Default is to use +.Ev ssb_appname +to construct the path as +.Dq ~/. . .El .Sh FILES .Bl -tag -width -indent @@ -164,8 +180,8 @@ or .Fl T are specified, .Nm -will attempt to connect in noauth mode to this socket file. If the socket file -is not present or the connection fails, +will attempt to connect in noauth mode to this socket file. +If the socket file is not present or the connection fails, .Nm will fall back to connecting with TCP and secret-handshake according to the config file - unless the @@ -193,6 +209,5 @@ The command completed with an error. was written by .An cel Aq @f/6sQ6d2CMxRUhLpspgGIulDxDCwYD7DzFzPNr7u5AU=.ed25519 . .Sh BUGS -.Pp Please report any bugs by making a post on SSB mentioning the repo, .Lk \*[REPO]