Create manpages for the project
[cascardo/rnetclient.git] / doc / man / rnetclient.1
1 .\" Hey, EMACS: -*- nroff -*-
2 .\" Copyright (C) 2014 Sergio Durigan Junior <sergiodj@sergiodj.net>
3 .\"
4 .\" This document is dual-licensed.  You may distribute and/or modify
5 .\" it under the terms of either of the following licenses:
6 .\"
7 .\" * The GNU General Public License, as published by the Free
8 .\"   Software Foundation, version 3 or (at your option) any later
9 .\"   version.  You should have received a copy of the GNU General
10 .\"   Public License along with this program.  If not, see
11 .\"   <http://www.gnu.org/licenses/>.
12 .\"
13 .\" * The GNU Free Documentation License, as published by the Free
14 .\"   Software Foundation, version 1.2 or (at your option) any later
15 .\"   version, with no Invariant Sections, no Front-Cover Texts, and
16 .\"   no Back-Cover Texts.  You should have received a copy of the GNU
17 .\"   Free Documentation License along with this program.  If not, see
18 .\"   <http://www.gnu.org/licenses/>.
19 .\"
20 .\" $Id$
21 .TH RNETCLIENT 1 "version 2014.1" "April 2014"
22 .\" Please adjust this date whenever revising the manpage.
23 .\"
24
25 .SH NAME
26
27 rnetclient \- Submit the Brazilian Income Tax Report to the Brazilian
28 Tax Authority
29
30 .SH SYNOPSIS
31 .B rnetclient
32 [\-d|\-\-declaration] <FILE> [\-o <DIRECTORY>|\-\-output-dir=<DIRECTORY>]
33 .br
34
35 .SH DESCRIPTION
36
37 \fBrnetclient\fP is used to send Brazilian tax income reports to
38 Receita Federal, Braziliam Tax Authority.  It communicates with the
39 official server from Receita Federal, ensures a secure connection is
40 established, and submits the file.  It is the product of
41 reverse-engineering ReceitaNet, which is the proprietary, non-free
42 version of the software that does the same thing as \fBrnetclient\fP.
43
44 .SH OPTIONS
45
46 .\" --declaration
47 .TP
48 .B \-d <FILE>, \-\-declaration=<FILE>
49 Provide the declaration (report) filename to be sent to Receita
50 Federal.  This argument is mandatory.  For historical reasons, the
51 user can also provide the declaration filename without specifying the
52 \fB\-d\fP modifier.
53
54 .\" --output-dir
55 .TP
56 .B \-o <DIRECTORY>, \-\-output\-dir=<DIRECTORY>
57 Specify the output directory where the receipt will be saved.  This
58 argument is optional; if no output directory is specified, then the
59 receipt will be saved in the current working directory (CWD).
60
61 .\" --version
62 .TP
63 .B \-V, \-\-version
64 Print the program version and exit.
65
66
67 .SH HISTORY AND MOTIVATION
68
69 There is no way to talk about rnetclient without mentioning
70 IRPF-Livre, which is an older project started and maintained by
71 Alexandre Oliva.  This project exists because Receita Federal, the
72 Brazilian Tax Authority, does not release the source code for the
73 software used to fill the Brazilian Tax Income Report.  Alexandre
74 still fights to make Receita Federal release this program as Free
75 Software, but he also decided to produce and release a Free version of
76 the program.  However, there was still another closed source software
77 needed to fully be able to do your duties with the Brazilian
78 government: the program used to submit the report to Receita Federal.
79 That is how rnetclient was born.
80
81 The program began as a personal project from Thadeu Lima de Souza
82 Cascardo.  He had to reverse engineer the proprietary software in
83 order to replicate the functionality, and made the first release on
84 2013.  In 2014, Alexandre Oliva and Sergio Durigan Junior joined
85 efforts and helped in the release of the second version.
86
87 .SH BUGS
88
89 Bugs should be reported to \fB<softwares-impostos@fsfla.org>\fP.
90
91 .SH HOMEPAGE
92
93 \fB<http://wiki.libreplanetbr.org/rnetclient>\fP
94
95 .SH AUTHORS
96
97 Thadeu Lima de Souza Cascardo  <cascardo (at) cascardo (dot) info>
98 .br
99 Sergio Durigan Junior  <sergiodj (at) sergiodj (dot) net>
100 .br
101 Alexandre Oliva  <lxoliva (at) fsfla (dot) org>