Linux/Unix man page syntax conventions

by

Square Brackets [ ]

The square brackets ( [ ] ) indicate that the enclosed element (parameter, value, or information) is optional. You can choose one or more items or no items. Do not type the square brackets themselves in the command line.

Example: [global options], [source arguments], [destination arguments]

Angle Brackets < >

The angle brackets ( < > ) indicate that the enclosed element (parameter, value, or information) is mandatory. You are required to replace the text within the angle brackets with the appropriate information. Do not type the angle brackets themselves in the command line.

Example: -f [set the File Name variable], -printer <printer name>, -repeat <months> <days> <hours> <minutes>, date access <mm/dd/yyyy>

In Unix-like systems, the ASCII hyphen–minus is commonly used to specify options. The character is usually followed by one or more letters. An argument that is a single hyphen–minus by itself without any letters usually specifies that a program should handle data coming from the standard input or send data to the standard output. Two hyphen–minus characters ( — ) are used on some programs to specify “long options” where more descriptive option names are used. This is a common feature of GNU software.

Just do ‘ls –help’ and look at the options, it should be obvious to you.

 -A, --almost-all           do not list implied . and ..
     --author               with -l, print the author of each file
 -b, --escape               print octal escapes for nongraphic characters
     --block-size=SIZE      use SIZE-byte blocks
 -B, --ignore-backups       do not list implied entries ending with ~
 -c                         with -lt: sort by, and show, ctime (time of last
                              modification of file status information)
                              with -l: show ctime and sort by name
                              otherwise: sort by ctime'
 -C                         list entries by columns
     --color[=WHEN]

More Related Contents:

  1. What does the number in parentheses shown after Unix command names in manpages mean?
  2. What do you think about the new Debian release cycle?
  3. How do I recursively grep all directories and subdirectories?
  4. Where can I set environment variables that crontab will use?
  5. How do I write standard error to a file while using “tee” with a pipe?
  6. Is it possible to use “/” in a filename?
  7. What is the meaning of “POSIX”?
  8. What does $@ mean in a shell script?
  9. How to convert DOS/Windows newline (CRLF) to Unix newline (LF)
  10. What is the difference between “#!/usr/bin/env bash” and “#!/usr/bin/bash”?
  11. How do you find the original user through multiple sudo and su commands?
  12. How can I remove the last character of a file in unix?
  13. Managing log files created by cron jobs
  14. How to run a shell script on a Unix console or Mac terminal?
  15. How do I escape spaces in path for scp copy in Linux?
  16. What is a .pid file and what does it contain?
  17. Should PATH contain directories or full paths to binaries?
  18. Execute a command without keeping it in history [closed]
  19. How do I set up cron to run a file just once at a specific time? [closed]
  20. How can I pipe initial input into process which will then be interactive?
  21. Restarting cron after changing crontab file? [closed]
  22. How can I copy the output of a command directly into my clipboard?
  23. How do I get the path of a process in Unix / Linux?
  24. How to convert \uXXXX unicode to UTF-8 using console tools in *nix
  25. Running shell script in parallel
  26. Difference between shell and environment variables
  27. Why crontab uses OR when both day of month and day of week specified?
  28. What’s the point of eval/bash -c as opposed to just evaluating a variable?
  29. How can I use xargs to copy files that have spaces and quotes in their names?
  30. Find all files with name containing string [closed]

Leave a Comment