Documentation update and relicense as Beerware

Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>

git-svn-id: file:///srv/svn/repo/suwako/trunk@27 0b558ee1-521d-8b46-a41b-40029c97c055
This commit is contained in:
yakumo.izuru
2023-12-16 23:04:17 +00:00
parent ba24061ff5
commit 040b11054c
7 changed files with 67 additions and 34 deletions

36
suwako.conf.5 Normal file
View File

@@ -0,0 +1,36 @@
.Dd $Mdocdate$
.Dt SUWAKO.CONF 5
.Os
.Sh NAME
.Nm suwako.conf
.Nd INI-style configuration file for
.Xr suwako 1
.Sh DESCRIPTION
The
.Nm
file specifies the instance address,
including the API path and the
translation engine to be used on
the
.Xr suwako 1
command.
.Sh OPTIONS
.Bl -tag -width 11n -compact
.It instance
Contains the HTTPS URI to the
server's up to the
.Sy /api/translate
endpoint.
.It engine
For most use cases, the
.Em google
engine should be enough,
though some endpoints
support more translation
engines.
.El
.Sh FILES
.Pa ~/.suwako/suwako.conf
path to this file
.Sh AUTHORS
.An Izuru Yakumo Aq Mt yakumo.izuru@chaotic.ninja