22
0
Fork 0

ajout de conventions

This commit is contained in:
gcolpart 2016-09-19 19:35:48 +02:00
parent 428b47570f
commit 3a2a3ec516
1 changed files with 26 additions and 1 deletions

View File

@ -31,7 +31,7 @@ Commandes Shell (avec output) :
~~~
$ dmesg
[8044916.823878] [IPTABLES DROP] : IN=eth0 OUT= MAC=00:00:00:28:71:00:00:54:00:8f:01:00:00:00 SRC=192.0.2.1 DST=192.0.2.2 LEN=52 TOS=0x00 PREC=0x00 TTL=64 ID=13872 DF PROTO=TCP SPT=52269 DPT=22 WINDOW=29200 RES=0x00 SYN URGP=0
[8044916.823878] [IPTABLES DROP] : IN=eth0 OUT= MAC=00:00:00:28:71:00:00:54:00:8f:01:00:00:00 SRC=192.0.2.1 [...]
~~~
Fichiers avec coloration syntaxique si disponible (voir ci-dessous) :
@ -51,6 +51,31 @@ Liens internes :
[HowtoFoo#name]()
[#name]()
## Conventions
Une commande lancée en root sera précédée de **#** ; en utilisateur elle sera précédée de **$**.
Dans la mesure du possible, le maximum de commande devra être lancée en tant qu'utilisateur.
~~~{.bash}
$ apt-cache search foo
# apt install foo
~~~
On évitera d'avoir des lignes trop longues dans les commandes Shell ou fichiers sur le wiki, car cela devient illisible en HTML.
On mettra ainsi les commandes Shell sur plusieurs lignes si besoin, on utilisera *[...]* si nécessaire, etc.
Si l'on doit utiliser un utilisateur quelconque, on utilisera le login **jdoe** (pour John Doe).
Si l'on doit utiliser un terme quelconque, on privilégiera **foo** et **bar**. Ainsi, pour un chemin quelconque, on utilisera par exemple *cp /foo/.gitignore /bar/*
Si l'on doit mentionner un mot de passe, on choisira **PASSWORD** (en majuscule).
Si l'on utilise des adresses IP, on utilisera des IPv4 en **192.0.2.0/24** [RFC5737](https://tools.ietf.org/html/rfc5737) et des IPv6 en **2001:db8::/32** [RFC3849](https://tools.ietf.org/html/rfc3849)
Les adresses IPv6 et les adresses MAC auront leurs caractères alphabétiques en minuscule.
Si l'on utilise des noms de domaine, on utilisera **example.com** [RFC2606](https://tools.ietf.org/html/rfc2606) notamment pour les emails, URLs ou serveurs à atteindre.
## Coloration syntaxique
~~~