usage-message

Une définition du Jargon Français.
(Redirigé depuis usage)
Aller à : Navigation, rechercher

Dr enus.png nom  [commande] Message qui indique comment une commande ou un programme en ligne de commande peut être utilisé.

Ce message peut être explicitement demandé par l'utilisateur qui souhaite obtenir ainsi une documentation concise. Sur la ligne de commande il utilisera pour cela l'argument « --help » ou sa version abrégée « -h ».

Beaucoup de programmes produisent ce message en réponse à une commande mal composée (par exemple un argument inconnu).

Exemple de usage-message issu par le MUA « Mutt » :

utilisateur@machine:~$ mutt -h
Mutt 1.5.24+54 (df42596d08fe) (2015-08-30)
usage: mutt [<options>] [-z] [-f <file> | -yZ]
       mutt [<options>] [-x] [-Hi <file>] [-s <subj>] [-bc <addr>] [-a <file> [...] --] <addr> [...]
       mutt [<options>] [-x] [-s <subj>] [-bc <addr>] [-a <file> [...] --] <addr> [...] < message
       mutt [<options>] -p
       mutt [<options>] -A <alias> [...]
       mutt [<options>] -Q <query> [...]
       mutt [<options>] -D
       mutt -v[v]

options:
  -A <alias>	expand the given alias
  -a <file> [...] --	attach file(s) to the message
		the list of files must be terminated with the "--" sequence

(...)