Man
| Man | ||
|---|---|---|
| Les pages de man on une syntaxes et une utilsiation particulière en voici les astuces: |
| Racourcis | ||
|---|---|---|
| man [commande] | pour l'utiliser il suffi de faire man suivi de la commande souhaitée. Les pages de man se trouvent dans /usr/share/man | |
| / suivi de <mot> | permet de rechercher un "mot", apres avoir trouver la première occurence il faut appuyer sur la touche "n" pour passer automatiquement à l'occurence suivante | |
| q | pour quiter la page de man | |
| Syntaxe d'une page man |
|---|
| Syntaxe de police | ||
|---|---|---|
| .B | Gras. | |
| .BI | un mot sur deux en gras et un mot sur deux souligné. | |
| .BR | Un mot sur deux en gras. | |
| .I | souligné. | |
| .IB | un mot sur deux souligné et un mot sur deux en gras. | |
| .IR | un mot sur deux souligné. | |
| .RB | En gras un mot sur deux. | |
| .RI | un mot sur deux et souligné. | |
| .SB | ecriture Romane (plus besoin d'echapper les espaces) et met en gras. | |
| .SM | ecriture romane (plus besoin d'echapper les espaces) et met en petit (inutile pour les acronimes). | |
| Syntaxe de paragraphe | ||
|---|---|---|
| .LP | Identique à .PP (commence un nouveau paragraphe). Same as .PP (begin a new paragraph). | |
| .P | Identique à .PP (commence un nouveau paragraphe). Same as .PP (begin a new paragraph). | |
| .PP | Commencez un nouveau paragraphe et réinitialisez le retrait dominant. | |
| Syntaxe de marge et d'indentation | ||
|---|---|---|
| .RS i | Commencer le retrait relatif de la marge : déplace la marge gauche i vers la droite (si i est omis, la valeur de retrait prédominante est utilisée).Un nouveau retrait dominant est défini sur 0,5 pouce. Par conséquent, tous les paragraphes suivants seront mis en retrait jusqu'au .RE correspondant. | |
| .RE | Marge relative de fin, indent et restaure la valeur précédente de l'indentation en vigueur. | |
| .HP i | Commencer le paragraphe par un retrait négatif (la première ligne du paragraphe est à lamarge gauche des paragraphes normaux et le reste des lignes du paragraphe est en retrait). | |
| .IP x i | Paragraphe en retrait avec étiquette volante facultative. Si la balise x est omise, tout le paragraphe suivant est indenté par i. Si la balise x est fournie, elle est accrochée à la marge de gauche avant le paragraphe en retrait suivant (c'est comme .TP sauf que la balise est incluse avec la commande au lieu d'être sur la ligne suivante). Si la balise est trop longue, le texte après la balise sera déplacé vers la ligne suivante (le texte ne sera pas perdu ou brouillé). Pour les listes à puces, utilisez cette macro avec \(bu (puce) ou \(em (em tiret) comme balise, et pour les listes numérotées, utilisez le chiffre ou la lettre suivi d'un point comme étiquette ; cela simplifie la traduction vers d'autres formats. | |
| .TP i | Commencez le paragraphe avec une étiquette volante. La balise est donnée sur la ligne suivante, mais ses résultats sont similaires à ceux de la commande .IP. | |
| Macros diverses | ||
|---|---|---|
| .DT | Réinitialiser les onglets aux valeurs d'onglet par défaut (tous les 0,5 pouces) ; ne provoque pas de rupture. | |
| .PD d | Définissez la distance verticale inter-paragraphes sur d (si omis, d=0.4v); ne provoque pas de rupture. | |
| .SS t | Sous-titre t (comme .SH, mais utilisé pour une sous-section à l'intérieur d'une section). | |
| chaines de caractère pré-définies | ||
|---|---|---|
| \*R | Symbole pré-enregistré: ® | |
| \*S | Passer à la taille de police par défaut | |
| \*(Tm | Symboles trademark : â„¢ | |
| \*(lq | Guillemets doubles à angle gauche : " | |
| \*(rq | Guillemets doubles à angle droit : " | |
| chaines particulières | ||
|---|---|---|
| echappement | D'autres séquences que vous pouvez utiliser, où x ou xx sont n'importe quel caractère et N est n'importe quel chiffre, incluent | \', \', \-, \., \", \%, \*x, \*(xx, \( xx, \$N, \nx, \n(xx, \fx et \f(xx |
| Exemple de syntaxe | ||
|---|---|---|
.\" DO NOT MODIFY THIS FILE! It was created by schnellbach .TH manpage_exemple "1" "March 2020" .SH NAME manpage_exemple \- juste un exemple de page man cree manuellement .SH SYNTAXE .B manpage_exemple [\foption1\ Option2\fR,\fIOption3\fR] ... [\fIOptionN(S)\fR]... .br .SH DESCRIPTION .PP Cette Page de manuel est une pseudo-man page. .PP Une page de manuel possede une syntaxe tres particuliere : .TP \fB\-arg1\fR,\fB--arguement1\fR Ce que fait l arguement1 .TP \fB\-arg2\fR,\fB--arguement2\fR Ce que fait l arguement2 .TP .B par default -arg1 est automatiquement utilisee. .SH OPTIONS .PP Nous voici aux options de cette pseudo-Page de pseudo-manuel de man. .TP \fB\-r\fR, \fB\-\-recursively\fR recursivement, en general l option -r permet de faire quelque chose recursivement. .TP \fB\-c\fR,\fB\-\-complete\fR en regle generale les options ont toujours un racourci -c et le terme complet avec deux -\- comme ici -\-complete .PP .TP \fB Exit status: \fR .TP \fB\-0\fR si tout s est bien passee, .TP \fB\-1\fR if s il y a eu un probleme (e.g., le programme mange un chilli con carnee et a oubliee de finir), fin des truc du genre. .SH EXAMPLES D UTILISATION .TP Man [\ \fImanpage_exemple\fR\ ] (default command) .TP man manpage_exemple \/usr\/ domotrix\/ \-c \-\-recursively .SH AUTHOR .PP Written by \fB Schnellbach Tanguy \fR .SH SEE ALSO .PP La ocumentation complete est dans le fichier 'README.txt' du meme pacquet ou sur 'https://i-am-root.fr'. |