manpages written in mdoc and added a manpage for the configuration file. Also makefile installs the manpages

master
qorg11 2022-06-09 19:11:47 +02:00
parent dbb3038f8f
commit 3945bbcdcb
3 changed files with 114 additions and 1 deletions

View File

@ -1,6 +1,6 @@
PROG = sakisafecli
SRCS += funcs.c sakisafecli.c
MAN = sakisafecli.1
MAN = sakisafecli.1 sakisafeclirc.5
LDADD = -lssl -lz -lpthread -lnghttp2 -lcurl -lconfig -lcrypto -L/usr/local/lib
CPPFLAGS = -I/usr/local/include
BINDIR=/usr/local/bin

47
sakisafecli/sakisafecli.1 Normal file
View File

@ -0,0 +1,47 @@
.Dd $Mdocdate$
.Dt sakisafecli 1
.Os
.Sh sakisafecli
.Nm sakisafecli
.Nd file uploader
.Sh SYPNOSIS
sakisafecli https://sakisafe.tld FILE
.Sh DESCRIPTION
sakisafecli is a file uploader. Intended for sakisafe, but also works
for 0x0.st, 0xff.i2p, i.kalli.st and probably others.
.Sh OPTIONS
.Sy --http_proxy
Use an HTTP Proxy to make the request to the server.
.Sy --socks_proxy
Use a SOCKS Proxy to make the request to the server.
.Sy --server
Specify which server to use to upload the given file.
.Sy -4
Force an IPv4 connection.
.Sy -6
Force an IPv6 connection.
.Sh BUGS
Of course.
.Sh HISTORY
First commit to
.Sy lainsafe
was made in 2020-04-19.
.Sy clainsafecli
first commit was made in 2021-02-01.
.Sy clainsafecli
was rebranded to
.Sy sakisafecli
in 2022-05-05
.Sh AUTHORS
qorg11 <teru-sama at riseup dot net>
.Sh SEE ALSO
sakisafeclirc(5)

View File

@ -0,0 +1,66 @@
.Dd $Mdocdate$
.Dt sakisafeclirc 5
.Os
.Sh sakisafeclirc
.Nm sakisafeclirc
.Nd sakisafecli runtime configuration
.Sh DESCRIPTION
The sakisafecli(1) utility supports a configuration file. Which is by
default in $HOME/.sakisafeclirc. This configuration file allows to
change the default behaviour of sakisafecli(1) Lines that begin with
.Sy #
are ignored.
The files uses a simple
.Sy key=value
format. This are the possible keys:
.Sy server (string)
Specify the server to upload the file.
.Sy http_proxy (string)
Specify the HTTP proxy address.
.Sy socks_proxy (string)
Specify the SOCKS proxy address.
.Sy use_socks_sproxy (boolean)
Specify whether to use or not the SOCKS Proxy specified with
.Sy socks_proxy
.Sy use_http_proxy (boolean)
Specify whether to use or not the HTTP proxy specified with
.Sy http_proxy
.Sy force_ipv6 (boolean)
Force an IPv6 connection. Cannot be used with
.Sy force_ipv4
.Sy force_ipv4 (boolean)
Force an IPv4 connection. Cannot be used with
.Sy force_ipv6
.Sh FILES
.Bl -tag -width $HOME/.sakisafeclirc -compact
.It Pa $HOME/.sakisafeclirc
configuration file.
.Sh EXAMPLE
This example sets the default server to
.Em https://ls.qorg11.net. Forcing
.Em IPv6 connection
and with the
.Em socks_proxy
127.0.0.1:9050
.Bd -literal -offset indent;
server="https://ls.qorg11.net"
socks_proxy="127.0.0.1:9050"
force_ipv4=true
use_socks_proxy=true
.Ed
.Sh AUTHORS
qorg11 <teru-sama at riseup dot net>
.Sh SEE ALSO
sakisafecli(1)