Bonsoir
Créer et installer des pages de manuel n'est pas très compliqué.
Les fichiers décrivant les pages peuvent être fabriquées directement à l'aide d'un simple éditeur de texte (je le fais avec TextEdit, en format texte brut). Il suffit de respecter une syntaxe particulière.
Tu trouveras une partie de la syntaxe traditionnelle de « man » en tapant :
dans Terminal, en lisant les rubriques « USAGE » et suivantes.
Par exemple, un fichier contenant :
Bloc de code:
[B].TH[/B] ALSENDME 1
[B].SH[/B] NAME
alsendme - modify the default address for the ALS system
[B].SH[/B] SYNOPSIS
[B].B[/B] alsendme
[ address ... ]
[B].SH[/B] DESCRIPTION
The
[B].I[/B] alsendme
command specifies a new address for the ALS client previously defined by the
[B].I[/B] alsetup
command. This address won't be used by the ALS distant server until the next session.
[B].SH[/B] "SEE ALSO"
ALS(1), alsetup(1)
donnera :
Bloc de code:
ALSENDME(1) ALSENDME(1)
[B]NAME[/B]
alsendme - modify the default address for the ALS system
[B]SYNOPSIS[/B]
[B]alsendme[/B] [ address ... ]
[B]DESCRIPTION[/B]
The [U]alsendme[/U] command specifies a new address for the ALS client previ-
ously defined by the [U]alsetup[/U] command. This address won't be used by the
ALS distant server until the next session.
[B]SEE ALSO[/B]
ALS(1), alsetup(1)
ALSENDME(1)
À ces éléments de syntaxe s'en ajoutent d'autres, comme par exemple :
\" : commentaire
\fB : caractères gras
\fI : caractères italiques
\fR : caractères Roman
\fP : retour au précédent type de caractères
qui sont utilisables à l'intérieur d'une ligne.
Pour visualiser le résultat produit par le fichier créé, on peut utiliser la commande :
Bloc de code:
groff -Tascii -[B]man[/B] [I][COLOR="DarkOrange"]nom_du_fichier[/COLOR][/I] | more
Pour installer le fichier, on se contente le plus souvent de lui donner une extension « .1 » puis de le copier dans le dossier
/usr/share/man/man1. On le teste ensuite à l'aide de la commande « man ».
Mais c'est généralement la syntaxe « mdoc » qui est utilisée sous BSD, et c'est celle qu'on retrouve le plus souvent sur Mac. Les informations la concernant peuvent être trouvées en tapant :
et :
dans Terminal.
Pour visualiser le résultat produit par un tel fichier, on peut utiliser la commande :
Bloc de code:
groff -Tascii -[B]mdoc[/B] [I][COLOR="DarkOrange"]nom_du_fichier[/COLOR][/I] | more
Je te conseille de lire le contenu des fichiers de manuel déjà installés sur ton Mac, notamment ceux présents dans le dossier
/usr/share/man/man1 et portant l'extension « .1 ».
Le fichier
AppleFileServer.1 qui correspond à la commande « AppleFileServer » en est un exemple. Il contient :
Bloc de code:
[B].\"[/B][COLOR="DimGray"]Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.[/COLOR]
[B].\"[/B][COLOR="DimGray"]See Also:[/COLOR]
[B].\"[/B][COLOR="DimGray"]man mdoc.samples for a complete listing of options[/COLOR]
[B].\"[/B][COLOR="DimGray"]man mdoc for the short list of editing options[/COLOR]
[B].\"[/B][COLOR="DimGray"]/usr/share/misc/mdoc.template[/COLOR]
[B].Dd[/B] August 28, 2002 [B]\"[/B] [COLOR="DimGray"]DATE[/COLOR]
[B].Dt[/B] AppleFileServer [B]\"[/B] [COLOR="DimGray"]Program name and manual section number[/COLOR]
[B].Os[/B] Mac OS X [B]\"[/B] [COLOR="DimGray"]OS - 'Mac OS X' if it requires Mac OS X features else 'Darwin'[/COLOR]
[B].Sh[/B] NAME [B]\"[/B] [COLOR="DimGray"]Section Header - required - don't modify[/COLOR]
[B].Nm[/B] AppleFileServer
[B].\"[/B] [COLOR="DimGray"]Use .Nm macro to designate other names for the documented program.[/COLOR]
[B].Nd[/B] Apple File Protocol server.
[B].Sh[/B] SYNOPSIS [B]\"[/B] [COLOR="DimGray"]Section Header - required - don't modify[/COLOR]
[B].Nm[/B]
[B].Sh[/B] DESCRIPTION [B]\"[/B] [COLOR="DimGray"]Section Header - required - don't modify[/COLOR]
[B].Pp[/B]
How to run the AppleFileServer
[B].Bl -tag -width -indent
.It[/B] Running on MacOS X Desktop
[B].Pp[/B]
The AppleFileServer is typically launched using the Sharing Preference. Launch System Preferences. Select Sharing. Select the Services tab. Select Personal File Sharing and click start.
[B].It[/B] Running on MacOS X Server
[B].Pp[/B]
Please refer to Server help
[B].It[/B] The AppleFileServer can also be launched from the terminal (this must be done as root user). This is done by typing:
[B].Pp[/B]
AppleFileServer [-d]
[B].Pp[/B]
The -d option will prevent daemonization.
[B].It[/B] The AppleFileServer version can be got by typing in terminal:
[B].Pp[/B]
AppleFileServer -v
[B].El[/B] [B]\"[/B] [COLOR="DimGray"]Ends the list[/COLOR]
et il donne :
Bloc de code:
AppleFileServer LOCAL AppleFileServer
[B]NAME
AppleFileServer[/B] -- Apple File Protocol server.
[B]SYNOPSIS
AppleFileServer
DESCRIPTION[/B]
How to run the AppleFileServer
Running on MacOS X Desktop
The AppleFileServer is typically launched using the Sharing
Preference. Launch System Preferences. Select Sharing. Select
the Services tab. Select Personal File Sharing and click start.
Running on MacOS X Server
Please refer to Server help
The AppleFileServer can also be launched from the terminal (this must be
done as root user). This is done by typing:
AppleFileServer [-d]
The -d option will prevent daemonization.
The AppleFileServer version can be got by typing in terminal:
AppleFileServer -v
Mac OS August 28, 2002 Mac OS
