Improved man pages.

This commit is contained in:
Christian P. MOMON 2018-01-14 00:43:24 +01:00
parent 259061f2c0
commit 751a8bafa3
2 changed files with 35 additions and 13 deletions

View File

@ -1,19 +1,41 @@
.\" Manpage for hebdobot. .\" Manpage pour hebdobot (https://www.april.org/).
.\" Contact cmomon@april.org to correct errors or typos. .\" Contact cmomon@april.org to correct errors or typos.
.TH man 1 "11 December 2017" "2.0" "Hebdobot man page" .TH man 1 "11 December 2017" "2.0" "Hebdobot man page"
.SH NAME .SH NAME
hebdobot \- Bot to manage the weekly April.org review Hebdobot \- Bot managing the weekly review bot of the April association.
.SH SYNOPSIS .SH SYNOPSIS
hebdobot [USERNAME] hebdobot [-h | -help | --help] [-c config-file] [-version]
.SH DESCRIPTION .SH DESCRIPTION
hebdobot is a free software bot to manage the weekly April.org review. Hebdobot is a free software bot to manage the weekly April.org review.
.SH OPTIONS .SH OPTIONS
The hebdobot does not take any options. However, you can supply username. .IP "-h, -help, --help"
Display help about the Hebdobot command.
.IP "-c fichier-configuration"
Use the config file set. By default, the command search
.B hebdobot.conf
in the work directory.
.B -version
Display the version of Hebdobot.
.SH SEE ALSO .SH SEE ALSO
useradd(8), passwd(5), nuseradd.debian(8) The association
.B April
(https://www.april.org/)
.SH BUGS .SH BUGS
No known bugs. No known bugs.
.SH AUTHOR .SH AUTHOR
The April.org
Nicolas VINOT (aeris@imirhil.fr) Nicolas VINOT (aeris@imirhil.fr)
Christian Pierre MOMON (cmomon@april.org) Christian Pierre MOMON (cmomon@april.org)
.SH COPYING
Hebdobot is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

View File

@ -3,13 +3,13 @@
.TH man 1 "11 December 2017" "2.0" "Hebdobot man page" .TH man 1 "11 December 2017" "2.0" "Hebdobot man page"
.SH NAME .SH NAME
hebdobot \- Robot de la revue hebdomadaire de l'April Hebdobot \- Robot de la revue hebdomadaire de l'April
.SH SYNOPSIS .SH SYNOPSIS
hebdobot [-h | -help | --help] [-c fichier-configuration] [-debug] hebdobot [-h | -help | --help] [-c fichier-configuration] [-version]
.SH DESCRIPTION .SH DESCRIPTION
hebdobot est un logiciel libre de robot pour la gestion des revues hebdomadaires de l'association April (https://www.april.org/). Hebdobot est un logiciel libre de robot pour la gestion des revues hebdomadaires de l'association April (https://www.april.org/).
.SH OPTIONS .SH OPTIONS
.IP "-h, -help, --help" .IP "-h, -help, --help"
@ -18,8 +18,8 @@ Affiche l'aide de la commande.
Utilise le fichier de configuration indiqué. Par défaut, cherche Utilise le fichier de configuration indiqué. Par défaut, cherche
.B hebdobot.conf .B hebdobot.conf
dans le répertoire de lancement. dans le répertoire de lancement.
.B -debug .B -version
Sélectionne le niveau « debug » dans les logs. Affiche la version d'Hebdobot.
.SH SEE ALSO .SH SEE ALSO
L'association L'association
@ -38,4 +38,4 @@ Christian Pierre MOMON (cmomon@april.org)
Hebdobot is free software: you can redistribute it and/or modify Hebdobot is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. (at your option) any later version.