1SHIGOFUMI(1) Manual for Shigofumi SHIGOFUMI(1)
2
6 shigofumi - ISDS client
7
9 shigofumi [-c FILE]
10 shigofumi [-c FILE] -e COMMANDS
12 shigofumi -V
14
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 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 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
31 -c FILE
32 Use configuration FILE instead of default one.
33 -e COMMANDS
35 Run shigofumi in batch mode: execute each command and terminate
36 then.
37 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 Example 1. Authorized Conversion from Shell
44 $ shigofumi -e ´convert /etc/passwd´
46 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 -V
53 Show program version and linked libraries details and exit.
54
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. String quotation is
61 not currently supported.
62 If argument type is file name, you can use tilde symbol (~) as abbrevi‐
64 ation for user´s home directory. Home directory is derived from HOME
65 environment variable.
66 Command names, file names and message identifiers can be completed by
68 pressing completion key (depends on readline configuration, Tab usual‐
69 ly). They are expanded only after commands expecting argument of appro‐
70 priate type.
71 Set of available commands changes with context. E.g. If a message is
73 loaded, commands for message operation like save to file will become
74 available. Also meaning of the same command can change. E.g. show com‐
75 mand will print list of incoming messages if such list is loaded; if a
76 message is loaded, prints the message. List of currently available com‐
77 mands can be obtained by help command.
78 Syntax help for a command is printed after calling command with invalid
80 option or by help command with interested command as first argument.
81 Command option -h is reserved as invalid option and shows always com‐
82 mand usage.
83
85 ISDS (Informační systém datových schránek / Data Box Information Sys‐
86 tem) is defined by Czech ISDS Act (300/2008 Coll.)[1] and implied docu‐
87 ments.
88 The system is designed to deliver messages between public authorities
90 (government, courts etc.) and other entities (corporations, persons,
91 other government or municipality offices) in reliable and traceable
92 way.
93 Shigofumi implements following ISDS operations: Log in by name and
95 password, Incoming and outgoing message listing, Accepting commercial
96 message, Retrieving incoming and outgoing message, Explicit marking a
97 message as read, Verifying message hash, Getting message hash stored in
98 ISDS, Retrieving delivery details, Sending a message to one or more re‐
99 cipients, Searching a box by any criteria, Getting a box status, Chang‐
100 ing user password, Getting user password expiration time, Getting de‐
101 tails about user´s box, Listing box users.
102 In addition, Shigofumi can save a message and delivery details into lo‐
104 cal file and load it later again. Program can save each document into
105 local file (except XML documents).
106
108 Czech government offers a document conversion from digital to analogue
109 form and vice versa preserving legal impacts. This is done at Czech
110 POINT meeting place (in government, municipality or post office usual‐
111 ly). Visit Czech POINT web site[2] for more details.
112 Shigofumi allows to submit a digital document (local file or document
114 delivered by an ISDS message) for authorized conversion into Czech
115 POINT deposit. If deposit accepts the document, it will return a docu‐
116 ment identifier that user is required to tell to an officer in a office
117 where he wants to obtain analogue version of his document.
118 Please note the deposit keeps submitted document for limited period on‐
120 ly. Old documents (30 days currently) are removed automatically. Note
121 also PDF documents with valid digital signature can be converted only.
122
124 ~/.shigofumirc
125 Default configuration file location.
126
128 shigofumirc(5)
129
131 Petr Písař
132 He's written Shigofumi and libisds.
133
135 1. Czech ISDS Act (300/2008 Coll.)
136 http://portal.gov.cz/zakon/300/2008
137 2. Czech POINT web site
139 https://www.czechpoint.cz/
140Shigofumi 06/27/2010 SHIGOFUMI(1)