From 25a1a70e9d3e8076df3e74f573ebfe800aa6ee88 Mon Sep 17 00:00:00 2001 From: Sergio Durigan Junior Date: Mon, 12 May 2014 03:08:38 -0300 Subject: [PATCH] Create manpages for the project This commit creates the manpages for the project. There are two versions implemented here: the en_US, and the pt_BR. Along with the manpages, I am also modifying and creating Makefile.am files needed to properly handle/install the manpages. It is worth making some notes here: - We have to keep an eye in order to sync the manpages every time one of them is modified. - We also have to be careful to update the manpages every time a new option is added to the program. --- Makefile.am | 2 + configure.ac | 5 +- doc/Makefile.am | 16 ++++++ doc/man/Makefile.am | 18 +++++++ doc/man/pt_BR/Makefile.am | 18 +++++++ doc/man/pt_BR/rnetclient.1 | 102 +++++++++++++++++++++++++++++++++++++ doc/man/rnetclient.1 | 101 ++++++++++++++++++++++++++++++++++++ 7 files changed, 261 insertions(+), 1 deletion(-) create mode 100644 doc/Makefile.am create mode 100644 doc/man/Makefile.am create mode 100644 doc/man/pt_BR/Makefile.am create mode 100644 doc/man/pt_BR/rnetclient.1 create mode 100644 doc/man/rnetclient.1 diff --git a/Makefile.am b/Makefile.am index 20fe476..2b45a72 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,3 +1,5 @@ +SUBDIRS = doc + bin_PROGRAMS = rnetclient rnetclient_SOURCES = rnetclient.c decfile.c decfile.h pmhash.c pmhash.h \ rnet_message.c rnet_message.h rnet_encode.c rnet_encode.h diff --git a/configure.ac b/configure.ac index 0aa6155..993a250 100644 --- a/configure.ac +++ b/configure.ac @@ -51,4 +51,7 @@ $CFLAGS" dnl Outputting the necessary files for the build. AC_CONFIG_HEADERS([config.h]) -AC_OUTPUT(Makefile) +AC_OUTPUT([Makefile] + [doc/Makefile] + [doc/man/Makefile] + [doc/man/pt_BR/Makefile]) diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..edfbf29 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,16 @@ +# Copyright (C) 2014 Sergio Durigan Junior . + +SUBDIRS = man diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am new file mode 100644 index 0000000..08d8371 --- /dev/null +++ b/doc/man/Makefile.am @@ -0,0 +1,18 @@ +# Copyright (C) 2014 Sergio Durigan Junior . + +SUBDIRS = pt_BR + +dist_man_MANS = rnetclient.1 diff --git a/doc/man/pt_BR/Makefile.am b/doc/man/pt_BR/Makefile.am new file mode 100644 index 0000000..2cf0127 --- /dev/null +++ b/doc/man/pt_BR/Makefile.am @@ -0,0 +1,18 @@ +# Copyright (C) 2014 Sergio Durigan Junior . + +mandir = @mandir@/pt_BR + +dist_man_MANS = rnetclient.1 diff --git a/doc/man/pt_BR/rnetclient.1 b/doc/man/pt_BR/rnetclient.1 new file mode 100644 index 0000000..648a90f --- /dev/null +++ b/doc/man/pt_BR/rnetclient.1 @@ -0,0 +1,102 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" Copyright (C) 2014 Sergio Durigan Junior +.\" +.\" This document is dual-licensed. You may distribute and/or modify +.\" it under the terms of either of the following licenses: +.\" +.\" * The GNU General Public License, as published by the Free +.\" Software Foundation, version 3 or (at your option) any later +.\" version. You should have received a copy of the GNU General +.\" Public License along with this program. If not, see +.\" . +.\" +.\" * The GNU Free Documentation License, as published by the Free +.\" Software Foundation, version 1.2 or (at your option) any later +.\" version, with no Invariant Sections, no Front-Cover Texts, and +.\" no Back-Cover Texts. You should have received a copy of the GNU +.\" Free Documentation License along with this program. If not, see +.\" . +.\" +.\" $Id$ +.TH RNETCLIENT 1 "versão 2014.1" "Abril de 2014" +.\" Por favor, ajuste a data sempre que revisar esta página de manual. +.\" + +.SH NOME + +rnetclient \- Envia a Declaração de Imposto de Renda para a Receita +Federal + +.SH SINÓPSE +.B rnetclient +[\-d|\-\-declaration] [\-o |\-\-output-dir=] +.br + +.SH DESCRIÇÃO + +\fBrnetclient\fP é utilizado para enviar a Declaração de Imposto de +Renda para a Receita Federal. Ele comunica-se com o servidor oficial +da Receita Federal, garante que uma conexão segura está estabelecida, +e envia o arquivo. O programa é o produto de uma engenharia reversa +no ReceitaNet, que é a versão proprietária e não-livre do software que +realiza a mesma tarefa que o \fBrnetclient\fP. + +.SH OPÇÕES + +.\" --declaration +.TP +.B \-d , \-\-declaration= +Fornece o nome do arquivo da declaração que será enviado à Receita +Federal. Este argumento é obrigatório. Por razões históricas, o +usuário também pode fornecer o nome do arquivo de declaração sem +especificar o modificador \fB\-d\fP. + +.\" --output-dir +.TP +.B \-o , \-\-output\-dir= +Especifica o diretório de saída onde o recibo será salvo. Este +argumento é opcional; se nenhum diretório de saída for especificado, +então o recibo será salvo no diretório corrente (CWD). + +.\" --version +.TP +.B \-V, \-\-version +Imprime a versão do programa e termina a execução. + + +.SH HISTÓRIA E MOTIVAÇÃO + +Não há como falar sobre o rnetclient sem mencionar o IRPF-Livre, que é +um projeto mais antigo iniciado e mantido por Alexandre Oliva. Este +projeto existe porque a Receita Federal não disponibiliza o +código-fonte do software utilizado para preencher a Declaração de +Imposto de Renda. O Alexandre ainda luta para fazer com que a Receita +Federal disponibilize este programa como Software Livre, mas ele +também decidiu produzir e lançar uma versão Livre deste software. No +entanto, ainda havia mais um software de código fechado necessário +para que fosse possível cumprir suas obrigações com o governo +Brasileiro: o programa utilizado para submeter a declaração para a +Receita Federal. Foi assim que o rnetclient nasceu. + +O programa começou como um projeto pessoal de Thadeu Lima de Souza +Cascardo. Ele teve que fazer engenharia reversa no software +proprietário de maneira a conseguir replicar sua funcionalidade, e fez +o primeiro lançamento do programa em 2013. Em 2014, Alexandre Oliva e +Sergio Durigan Junior juntaram-se ao projeto e ajudaram na +disponibilização da segunda versão. + +.SH PROBLEMAS + +Problemas deverão ser reportados para \fB\fP. + +.SH PÁGINA NA INTERNET + +\fB\fP + +.SH AUTORES + +Thadeu Lima de Souza Cascardo +.br +Sergio Durigan Junior +.br +Alexandre Oliva diff --git a/doc/man/rnetclient.1 b/doc/man/rnetclient.1 new file mode 100644 index 0000000..fd7313f --- /dev/null +++ b/doc/man/rnetclient.1 @@ -0,0 +1,101 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" Copyright (C) 2014 Sergio Durigan Junior +.\" +.\" This document is dual-licensed. You may distribute and/or modify +.\" it under the terms of either of the following licenses: +.\" +.\" * The GNU General Public License, as published by the Free +.\" Software Foundation, version 3 or (at your option) any later +.\" version. You should have received a copy of the GNU General +.\" Public License along with this program. If not, see +.\" . +.\" +.\" * The GNU Free Documentation License, as published by the Free +.\" Software Foundation, version 1.2 or (at your option) any later +.\" version, with no Invariant Sections, no Front-Cover Texts, and +.\" no Back-Cover Texts. You should have received a copy of the GNU +.\" Free Documentation License along with this program. If not, see +.\" . +.\" +.\" $Id$ +.TH RNETCLIENT 1 "version 2014.1" "April 2014" +.\" Please adjust this date whenever revising the manpage. +.\" + +.SH NAME + +rnetclient \- Submit the Brazilian Income Tax Report to the Brazilian +Tax Authority + +.SH SYNOPSIS +.B rnetclient +[\-d|\-\-declaration] [\-o |\-\-output-dir=] +.br + +.SH DESCRIPTION + +\fBrnetclient\fP is used to send Brazilian tax income reports to +Receita Federal, Braziliam Tax Authority. It communicates with the +official server from Receita Federal, ensures a secure connection is +established, and submits the file. It is the product of +reverse-engineering ReceitaNet, which is the proprietary, non-free +version of the software that does the same thing as \fBrnetclient\fP. + +.SH OPTIONS + +.\" --declaration +.TP +.B \-d , \-\-declaration= +Provide the declaration (report) filename to be sent to Receita +Federal. This argument is mandatory. For historical reasons, the +user can also provide the declaration filename without specifying the +\fB\-d\fP modifier. + +.\" --output-dir +.TP +.B \-o , \-\-output\-dir= +Specify the output directory where the receipt will be saved. This +argument is optional; if no output directory is specified, then the +receipt will be saved in the current working directory (CWD). + +.\" --version +.TP +.B \-V, \-\-version +Print the program version and exit. + + +.SH HISTORY AND MOTIVATION + +There is no way to talk about rnetclient without mentioning +IRPF-Livre, which is an older project started and maintained by +Alexandre Oliva. This project exists because Receita Federal, the +Brazilian Tax Authority, does not release the source code for the +software used to fill the Brazilian Tax Income Report. Alexandre +still fights to make Receita Federal release this program as Free +Software, but he also decided to produce and release a Free version of +the program. However, there was still another closed source software +needed to fully be able to do your duties with the Brazilian +government: the program used to submit the report to Receita Federal. +That is how rnetclient was born. + +The program began as a personal project from Thadeu Lima de Souza +Cascardo. He had to reverse engineer the proprietary software in +order to replicate the functionality, and made the first release on +2013. In 2014, Alexandre Oliva and Sergio Durigan Junior joined +efforts and helped in the release of the second version. + +.SH BUGS + +Bugs should be reported to \fB\fP. + +.SH HOMEPAGE + +\fB\fP + +.SH AUTHORS + +Thadeu Lima de Souza Cascardo +.br +Sergio Durigan Junior +.br +Alexandre Oliva -- 2.20.1