getopt is a command line utility that is used to parse command line arguments passed to a program. It is typically used in Unix-like operating systems and is available on Linux, macOS and other Unix-like systems.
getopt is useful when you want to write a program that accepts various options and arguments from the command line. It can be used to parse both short and long options (options that start with one or two dashes, respectively) and to handle options that take arguments. The syntax for using getopt is as follows:
# getopt options [argument ...]
where options is a string containing the list of options that the program accepts, and argument is the list of arguments passed to the program.
The options string is a list of characters that represent the short options that the program accepts. Each character is followed by a colon if the option takes an argument. For example, if a program accepts the options -a, -b and -c which takes arguments, options string will be “abc:”
For Long options, the options string is a list of characters that represent the short options that the program accepts, each character can be followed by colon if the option takes an argument.
The getopt command returns the next option character in the option string each time it is called. The program can then process the option and its argument (if it takes one). The getopt command also keeps track of the position in the argument list, so that the program can access the non-option arguments after all the options have been processed.
If you encounter the below error while running the command getopt:
getopt: command not found
you may try installing the below package as per your choice of distribution:
| Distribution | Command |
|---|---|
| Debian | apt-get install util-linux |
| Ubuntu | apt-get install util-linux |
| Alpine | apk add util-linux |
| Arch Linux | pacman -S util-linux |
| Kali Linux | apt-get install util-linux |
| CentOS | yum install util-linux |
| Fedora | dnf install util-linux |
| OS X | brew install util-linux |
| Raspbian | apt-get install util-linux |
getopt Command Examples
1. Parse optional `verbose`/`version` flags with shorthands:
# getopt --options vV --longoptions verbose,version -- --version --verbose
2. Add a `–file` option with a required argument with shorthand `-f`:
# getopt --options f: --longoptions file: -- --file=somefile
3. Add a `–verbose` option with an optional argument with shorthand `-v`, and pass a non-option parameter `arg`:
# getopt --options v:: --longoptions verbose:: -- --verbose arg
4. Accept a `-r` and `–verbose` flag, a `–accept` option with an optional argument and add a `–target` with a required argument option with shorthands:
# getopt --options rv::s::t: --longoptions verbose,source::,target: -- -v --target target