source: code/trunk/suwako.conf.5@ 27

Last change on this file since 27 was 27, checked in by yakumo.izuru, 18 months ago

Documentation update and relicense as Beerware

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>
File size: 642 bytes
Line 
1.Dd $Mdocdate$
2.Dt SUWAKO.CONF 5
3.Os
4.Sh NAME
5.Nm suwako.conf
6.Nd INI-style configuration file for
7.Xr suwako 1
8.Sh DESCRIPTION
9The
10.Nm
11file specifies the instance address,
12including the API path and the
13translation engine to be used on
14the
15.Xr suwako 1
16command.
17.Sh OPTIONS
18.Bl -tag -width 11n -compact
19.It instance
20Contains the HTTPS URI to the
21server's up to the
22.Sy /api/translate
23endpoint.
24.It engine
25For most use cases, the
26.Em google
27engine should be enough,
28though some endpoints
29support more translation
30engines.
31.El
32.Sh FILES
33.Pa ~/.suwako/suwako.conf
34path to this file
35.Sh AUTHORS
36.An Izuru Yakumo Aq Mt yakumo.izuru@chaotic.ninja
Note: See TracBrowser for help on using the repository browser.