{
  "id": "enwiki-001352272202",
  "slug": "usage-message",
  "title": "Usage message",
  "qid": "",
  "lead": "In computer programming, a usage message or help message is a brief message displayed by a program that utilizes a command-line interface for execution. This message usually consists of the correct command line usage for the program and includes a list of the correct command-line arguments or options acceptable to said program. Usage messages are utilized as a quick way for a program to inform the user of proper command syntax, and should not be substituted for proper error messages or for detailed documentation such as a man page.",
  "body": "In computer programming, a usage message or help message is a brief message displayed by a program that utilizes a command-line interface for execution. This message usually consists of the correct command line usage for the program and includes a list of the correct command-line arguments or options acceptable to said program. Usage messages are utilized as a quick way for a program to inform the user of proper command syntax, and should not be substituted for proper error messages or for detailed documentation such as a man page. ==Pattern== On Unix-like platforms, usage messages usually follow the same common pattern: They often begin with \"Usage:\", the command, followed by a list of arguments. To indicate optional arguments, square brackets are commonly used, and can also be used to group parameters that must be specified together. To indicate required arguments, angled brackets are commonly used, following the same grouping conventions as square brackets. Exclusive parameters can be indicated by separating them with vertical bars within groups. ==Examples== Here is an example based on the NetBSD source code style guide: Usage: program [-aDde] [-f | -g] [-n number] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]] This would indicate that \"program\" should be called with: options without operands: , , , (any of which may be omitted). Note that in this case some parameters are case-sensitive exclusive options: , (denoted by the vertical bar) options with operands: exclusive options with operands: , required arguments: , optional argument , which may be used with or without (marked optional within the group by using another set of square brackets) optional argument , which requires ==Implementation== To print a usage statement in a shell script, one might write: case \"$arg\" in ... h) printf 'Usage: %s parameter1 parameter2 ...\\n' \"$(basename \"$0\")\" exit 0 ;; ... esac ==See also== Command-line interface ==References==",
  "categories": [
    "110284642",
    "23493188",
    "23603337",
    "26220375",
    "37160764"
  ],
  "license": "CC BY-SA 4.0",
  "source_uri": "https://en.wikipedia.org/w/index.php?oldid=1352272202",
  "content_hash": "",
  "created_at": null,
  "updated_at": 1777780827.0,
  "claims": [],
  "contradictions": [],
  "confidence": 0.6,
  "csl": {
    "id": "enwiki-001352272202",
    "type": "webpage",
    "title": "Usage message",
    "author": [
      {
        "family": "Anticloud FZ LLE",
        "literal": "Anticloud FZ LLE"
      }
    ],
    "container-title": "encyclopegia.org",
    "publisher": "Anticloud FZ LLE",
    "publisher-place": "Dubai, United Arab Emirates",
    "URL": "https://encyclopegia.org/a/usage-message",
    "issued": {
      "date-parts": [
        [
          2026,
          11,
          18
        ]
      ]
    },
    "accessed": {
      "date-parts": [
        [
          2026,
          11,
          18
        ]
      ]
    },
    "license": "CC BY-SA 4.0",
    "DOI": "eo1:enwiki-001352272202",
    "isBasedOn": "https://en.wikipedia.org/w/index.php?oldid=1352272202",
    "note": "Immutable snapshot enwiki-001352272202"
  }
}