web-dev-qa-db-fra.com

Comment éditer une page de manuel?

Je veux savoir si une page de manuel peut être modifiée. Si oui comment? (Si possible en changeant dans gedit).

P.S.- Je veux savoir si une page de manuel déjà écrite peut être modifiée (juste pour le plaisir).

command-linemanpage
4
bha159

Installez gmanedit .

Gtk + Manpages Editor est un éditeur de pages de manuel fonctionnant sous X avec GTK +.

Gmanedit est une application permettant d’éditer des pages de manuel (man) sur des systèmes Linux/Unix.

C'est comme la plupart des éditeurs HTML courants mais plus facile. Vous devez connaître le format des pages de manuel.

5
Rinzwind

Oui, vous pouvez, mais ce n'est pas recommandé. La meilleure approche serait probablement quelque chose comme l'outil suggéré par Rinzwind, mais oui, vous pouvez aussi le faire manuellement. Je vais utiliser la page man pour grep à titre d'exemple.

  1. Les pages de manuel sont des fichiers compressés. Vous devez donc utiliser un véritable éditeur, tel que emacs, capable de lire/écrire des fichiers compressés, ou vous devez d'abord le décompresser:

    Sudo gunzip /usr/share/man/man1/grep.1.gz

  2. Éditer:

    Sudo gedit /usr/share/man/man1/grep.1

    Maintenant, le format est un n peu bizarre . Toutefois, si vous souhaitez uniquement modifier des éléments simples, vous pouvez ignorer la mise en forme et modifier uniquement le texte brut. Par exemple, je peux changer la description de grep assez facilement. Voici à quoi ressemblent les premières lignes lorsque vous ouvrez le fichier dans gedit (ou tout autre éditeur):

    .\" GNU grep man page
.if !\n(.g \{\
.   if !\w|\*(lq| \{\
.       ds lq ``
.       if \w'\(lq' .ds lq "\(lq
.   \}
.   if !\w|\*(rq| \{\
.       ds rq ''
.       if \w'\(rq' .ds rq "\(rq
.   \}
.\}
.
.ie \n[.g] .mso www.tmac
.el \{\
. de MTO
\\$2 \(laemail: \\$1 \(ra\\$3
..
. de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.\}
.
.TH GREP 1 \*(Dt "GNU grep 2.25" "User Commands"
.hy 0
.
.SH NAME
grep, egrep, fgrep \- print lines matching a pattern
.
.SH SYNOPSIS
.B grep
.RI [ OPTIONS ]
.I PATTERN
.RI [ FILE .\|.\|.]
.br
.B grep
.RI [ OPTIONS ]
.RB [ \-e
.I PATTERN
|
.B \-f
.IR FILE ]
.RI [ FILE .\|.\|.]
.
.SH DESCRIPTION
.B grep
searches the named input
.IR FILE s
for lines containing a match to the given
.IR PATTERN .
If no files are specified, or if the file
.RB "\*(lq" \- "\*(rq"
is given,
.B grep
searches standard input.
By default,
.B grep
prints the matching lines.
.PP
In addition, the variant programs

    Donc, pour changer la description, je pourrais changer cela en (faites défiler jusqu'à la section "DESCRIPTION"):

    .\" GNU grep man page
.if !\n(.g \{\
.   if !\w|\*(lq| \{\
.       ds lq ``
.       if \w'\(lq' .ds lq "\(lq
.   \}
.   if !\w|\*(rq| \{\
.       ds rq ''
.       if \w'\(rq' .ds rq "\(rq
.   \}
.\}
.
.ie \n[.g] .mso www.tmac
.el \{\
. de MTO
\\$2 \(laemail: \\$1 \(ra\\$3
..
. de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.\}
.
.TH GREP 1 \*(Dt "GNU grep 2.25" "User Commands"
.hy 0
.
.SH NAME
grep, egrep, fgrep \- print lines matching a pattern
.
.SH SYNOPSIS
.B grep
.RI [ OPTIONS ]
.I PATTERN
.RI [ FILE .\|.\|.]
.br
.B grep
.RI [ OPTIONS ]
.RB [ \-e
.I PATTERN
|
.B \-f
.IR FILE ]
.RI [ FILE .\|.\|.]
.
.SH DESCRIPTION
.B grep
searches for and destroys all the unicorns on your system.
.PP
In addition, the variant programs

  3. Enregistrez le fichier, quittez gedit puis recompressez-le (ce n'est pas vraiment nécessaire, man grep fonctionne déjà, mais il vaut mieux être rangé):

    Sudo gzip /usr/share/man/man1/grep.1

Maintenant, lancez man grep et vous verrez:

GREP(1)

NAME
       grep, egrep, fgrep - print lines matching a pattern

SYNOPSIS
       grep [OPTIONS] PATTERN [FILE...]
       grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

DESCRIPTION
       grep searches for and destroys all the unicorns on your system.

       In addition, the variant programs egrep and fgrep are the same as grep -E and grep -F, respectively.  These variants are deprecated, but are provided
       for backward compatibility.
4
terdon

Comme cela a déjà été discuté, il n’est pas recommandé de le faire - l’autre billet explique également que c’est néanmoins possible.

J'aimerais mentionner quelques alternatives - des projets logiciels offrant une sorte de aide-mémoire éditable par l'utilisateur

La plupart d'entre eux viennent avec un bon préréglage de feuilles de triche, que vous améliorez ensuite à la demande.

2
dufte