Extend manual
[shigofumi.git] / README
bloba885990753af5d1db64db3ad9f993001837678ae
1 This is Shigofumi, an ISDS (Informační systém datových schránek / Data Box
2 Information System) client.
4 Copyright (C) 2010  Petr Písař <petr.pisar@atlas.cz>
6 This program is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13 FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
14 details.
17 This code written in ISO99 C language and requires >=libisds-0.2, readline,
18 confuse, and magic (package `file').
20 It has been tested on GNU/Linux (Linux 2.6.33, glibc-2.10.1) with libisds GIT
21 snapshot after 0.2.1 release, readline-6.1, confuse-2.6 and file-5.03.
23 Latest code can be obtained from GIT repository
24 <http://repo.or.cz/w/shigofumi.git> (web interface).
27 This client is in development and not all planed features are implemented, nor
28 not complete, nor flawless. Any feature, mainly user interface (list of
29 commands and their syntax and semantics) can change without prior notice.
30 USAGE CAN LEAD TO PERVERT TALKS OR WORLD DOOM.
32 Currently default configuration file is searched in $HOME/.shigorumirc or in
33 value of `-c' argument. Run `shigofumi -h' for more details.
35 Configuration file example (credentials are invalid):
37 base_url = "https://www.czebox.cz/"
38 username = 1s79vd
39 password = XY123456
40 verify_server = true
41 ca_file = /etc/ssl/certs/ca-certificates.crt
42 ca_directory = /etc/ssl/certs
43 crl_file = /etc/ssl/crl