1SHIGOFUMI(1)                 Manual for Shigofumi                 SHIGOFUMI(1)
2
3
4

NAME

6       shigofumi - ISDS client
7

SYNOPSIS

9       shigofumi [-c FILE]
10
11       shigofumi [-c FILE] -e COMMANDS
12
13       shigofumi -V
14

DESCRIPTION

16       Shigofumi  is  an  ISDS client based on libisds library. The client can
17       access ISDS, processes local message and delivery details,  and  submit
18       file to authorized conversion.
19
20       Shigofumi is command line oriented program. Once you start it, use help
21       to get list of embedded commands. Use help COMMAND to get details about
22       selected  COMMAND.  Be  ware that command listing changes contextually.
23       User can use casual readline shortcuts for line editing (like tab  com‐
24       pleting).
25
26       While  transmitting data over Internet, a progress-bar is updated. User
27       can cancel current network operation by emitting SIGINT signal  (Ctrl+C
28       usually).
29

OPTIONS

31       -c FILE
32           Use configuration FILE instead of default one.
33
34       -e COMMANDS
35           Run  shigofumi  in  batch  mode: execute each command and terminate
36           then.
37
38           Commands are delimited by new line  (\n  or  \r).  If  any  command
39           fails, other commands will not be processed and shigofumi will quit
40           immediately with non-zero  exit  code.  If  all  commands  succeed,
41           shigofumi will return zero code.
42
43           Example 1. Authorized Conversion from Shell
44
45               $ shigofumi -e 'convert /etc/passwd'
46
47           The  command submits /etc/passwd file to authorized conversion. Al‐
48           though it's syntactically correct, it will fail because plain  text
49           files  are not allowed to be converted. Check always return code in
50           your scripts.
51
52       -V
53           Show program version and linked libraries details and exit.
54

SHIGOFUMI COMMAND LANGUAGE

56       The language is straightforward. Each command  is  one  case  sensitive
57       word  followed  by (empty) sequence of arguments. Command and arguments
58       are separated by one or more white spaces. If you need to  embed  white
59       space  into  argument,  use  backslash (\) to escape it. If you need to
60       write backslash, escape it with backslash again. Also quotation is sup‐
61       ported  with double quotes ("). White space and pipe symbol loose their
62       delimiting properties until next  double  quotes.  Backslash  is  still
63       meta-character  inside quoted string and it can be used to embed double
64       quotes into quoted string.
65
66       The argument list can be terminated  prematurely  with  pipe  character
67       (|).  In  that  case,  the rest of the line will be considered as shell
68       command and output of preceding shigofumi command  will  be  passed  to
69       standard input of the shell command.
70
71       If argument type is file name, you can use tilde symbol (~) as abbrevi‐
72       ation for user's home directory. Home directory is  derived  from  HOME
73       environment variable.
74
75       Command  names,  file names and message identifiers can be completed by
76       pressing completion key (depends on readline configuration, Tab  usual‐
77       ly). They are expanded only after commands expecting argument of appro‐
78       priate type.
79
80       Set of available commands changes with context. E.g. If  a  message  is
81       loaded,  commands  for  message operation like save to file will become
82       available. Also meaning of the same command can change. E.g. show  com‐
83       mand  will print list of incoming messages if such list is loaded; if a
84       message is loaded, it will print the message. List of currently  avail‐
85       able commands can be obtained by help command.
86
87       Syntax help for a command is printed after calling command with invalid
88       option or by help command with interested command  as  first  argument.
89       Command  option  -h is reserved as invalid option and shows always com‐
90       mand usage.
91

ISDS

93       ISDS (Informační systém datových schránek / Data Box  Information  Sys‐
94       tem) is defined by Czech ISDS Act (300/2008 Coll.)[1] and implied docu‐
95       ments. Current implementation details are  described  in  Provozní  řád
96       that can be downloaded from Dokumenty ke stažení section of ISDS Infor‐
97       mation Portal[2].
98
99       The system is designed to deliver messages between  public  authorities
100       (government,  courts  etc.)  and other entities (corporations, persons,
101       other government or municipality offices)  in  reliable  and  traceable
102       way.
103
104       Shigofumi  implements  following  ISDS  operations:  Log in by name and
105       password, Log in by name and password and one-time pasword, Log  in  by
106       name  and/or  password  and/or  X.509 certificate, Listing incoming and
107       outgoing message, Accepting commercial message, Retrieving incoming and
108       outgoing message, Explicit marking a message as read, Verifying message
109       hash, Getting message hash stored in ISDS, Verifying message authentic‐
110       ity,  Retrieving delivery details, Getting message sender name, Sending
111       a message to one or more recipients, Searching a box by  any  criteria,
112       Searching a box by full-text, Getting a box status, Changing user pass‐
113       word, Getting user password expiration time, Getting details about  us‐
114       er's  box,  Listing  box users, Getting archive with list of all boxes,
115       Re-signing message or delivery datails, Getting  details  about  credit
116       for sending commercial messages.
117
118       In addition, Shigofumi can save a message and delivery details into lo‐
119       cal file and load it later again. Program can save each  document  into
120       local file.
121

AUTHORIZED CONVERSION

123       Czech  government offers a document conversion from digital to analogue
124       form and vice versa preserving legal impacts. This  is  done  at  Czech
125       POINT  meeting place (in government, municipality or post office usual‐
126       ly). Visit Czech POINT web site[3] for more details.
127
128       Shigofumi allows to submit a digital document (local file  or  document
129       delivered  by  an  ISDS  message)  for authorized conversion into Czech
130       POINT deposit. If deposit accepts the document, it will return a  docu‐
131       ment identifier that user is required to tell to an officer in a office
132       where he wants to obtain analogue version of his document.
133
134       Please note the deposit keeps submitted document for limited period on‐
135       ly.  Old  documents (30 days currently) are removed automatically. Note
136       also PDF documents with valid digital signature can be converted only.
137

ENVIRONMENT

139       EDITOR
140           Text editor to use if VISUAL is not set.
141
142       VISUAL
143           Text editor to use.
144

FILES

146       ~/.shigofumirc
147           Default configuration file location.
148

SEE ALSO

150       shigofumirc(5)
151

AUTHOR

153       Petr Písař
154           He's written Shigofumi and libisds.
155

NOTES

157        1. Czech
158                     ISDS Act (300/2008 Coll.)
159           http://portal.gov.cz/zakon/300/2008
160
161        2. Dokumenty ke stažení section of
162                     ISDS Information Portal
163           http://www.datoveschranky.info/ke-stazeni
164
165        3. Czech POINT web site
166           https://www.czechpoint.cz/
167
168
169
170Shigofumi                         08/18/2015                      SHIGOFUMI(1)
Impressum