Mensaje de uso

En programación informática , un mensaje de uso o mensaje de ayuda es un mensaje breve que muestra un programa que utiliza una interfaz de línea de comandos para su ejecución. Este mensaje suele incluir el uso correcto de la línea de comandos para el programa e incluye una lista de los argumentos u opciones de línea de comandos correctos que son aceptables para dicho programa.

Los mensajes de uso se utilizan como una forma rápida para que un programa informe al usuario sobre la sintaxis adecuada del comando y no deben sustituir a los mensajes de error adecuados ni a la documentación detallada, como una página de manual .

En plataformas tipo Unix, los mensajes de uso suelen seguir el mismo patrón común:

• A menudo comienzan con "Uso:", el comando, seguido de una lista de argumentos .
• Para indicar argumentos opcionales, comúnmente se utilizan corchetes , y también se pueden utilizar para agrupar parámetros que deben especificarse juntos.
• Para indicar argumentos obligatorios, comúnmente se utilizan corchetes angulares , siguiendo las mismas convenciones de agrupación que los corchetes.
• Los parámetros exclusivos se pueden indicar separándolos con barras verticales dentro de los grupos.

A continuación se muestra un ejemplo basado en la guía de estilo del código fuente de NetBSD :

Uso: programa [-aDde] [-f | -g] [-n número] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]]

Esto indicaría que "programa" debe llamarse con:

• Opciones sin operandos: a, D, d, e (cualquiera de los cuales puede omitirse). Tenga en cuenta que en este caso algunos parámetros distinguen entre mayúsculas y minúsculas.
• Opciones exclusivas: f, g (indicadas por la barra vertical)
• opciones con operandos: n
• Opciones exclusivas con operandos: b, c
• argumentos obligatorios: req1, req2
• argumento opcional opt1, que puede usarse con o sin opt2 (marcado como opcional dentro del grupo mediante otro conjunto de corchetes)
• argumento opcional opt2, que requiere opt1

Para imprimir una declaración de uso en un script de shell , se podría escribir:

caso " $arg " en  
...
h ) printf 'Uso: %s parámetro1 parámetro2 ...\n' " $( nombrebase " $0 " ) " exit 0 ;;    
    
   
...
esac

Una declaración de uso no es un mensaje de error y, por lo tanto, generalmente solo se debe imprimir cuando lo solicite específicamente el usuario (a través de --help, o -h, o -?, o algún indicador o argumento similar). Se debe escribir en la salida estándar; ^{[1] [2]} si el usuario ha ingresado un comando incorrecto, el programa idealmente debería responder con un mensaje de error sucinto que describa el error exacto cometido por el usuario en lugar de imprimir la declaración de uso y requerir que el usuario averigüe cuál fue el error. Si el usuario no pasa la cantidad correcta de argumentos, por ejemplo, una sola línea que indique que falta un argumento es mucho más útil que varias páginas de salida que brinden un uso general.

• Interfaz de línea de comandos