Dot (command)

From Wikipedia, the free encyclopedia
  (Redirected from Source (command))
Jump to navigation Jump to search

In a Unix shell, the full stop called the dot command (.) is a command that evaluates commands in a computer file in the current execution context.[1] In C Shell, a similar functionality is provided as the source command,[2] and this name is seen in "extended" POSIX shells as well.[3][4]

The dot command is not to be confused with a dot file, which is a dot-prefixed hidden file or hidden directory. Nor is it to be confused with the ./scriptfile notation for running commands, which is simply a relative path pointing to the current directory (notated in Unix as a '.' character, and typically outside of the Path variable).

Arguments[edit]

The filename is the dot command's first argument. When this argument does not contain a slash, the shell will search for the file in all directories defined in the PATH environment variable. Unlike normal commands which are also found in PATH, the file to source does not have to be executable. Otherwise the filename is considered as a simple path to the file.[1]

In several "extended" shells including bash,[3] zsh[4] and ksh,[5] one may specify parameters in a second argument. If no parameters are specified, the sourced file will receive the set of positional parameters available in the current context. If parameters are specified, the sourced file will receive only the specified parameters. In any case, parameter $0 will be the $0 of the current context.

Usages[edit]

Since the execution of the source file is done in the invoking context, environment[note 1] changed within apply to the current process or the current shell. This is very different from scripts run directly by shebang or as sh foo.sh, which are run in a new, separate process space, with a separate environment.

Therefore, the dot command can be used for splitting a big script into smaller pieces, potentially enabling modular design. Sourcing is also often done by the shell on session startup for user profile files like .bashrc and .profile.

Source[edit]

source is a shell-builtin command that evaluates the file following the command, as a list of commands, executed in the current context.[6] Frequently the "current context" is a terminal window into which the user is typing commands during an interactive session.

The source command can be abbreviated as just a dot (.) in Bash and similar POSIX-ish shells. However, this is not acceptable in C shell, where the command first appeared.

Some Bash scripts should be run using the source your-script syntax rather than run as an executable command, e.g., if they contain a change directory (cd) command and the user intends that they be left in that directory after the script is complete, or they contain an export command and the user wants to modify the environment of the current shell. Another usage situation is when a script file does not have the "execute" permission. Passing the script filename to the desired shell will run the script in a subshell, not the current context.

Notes[edit]

  1. ^ See Shell Execution Environment in POSIX.1:2013.

References[edit]

  1. ^ a b "POSIX.1:2013 Shell Command Language § dot". Retrieved 23 May 2016.
  2. ^ "Csh man page#command". Retrieved 23 May 2016.
  3. ^ a b "Bash Reference Manual § Bourne Shell Builtins". Retrieved 23 May 2016.
  4. ^ a b "ZSH Shell Builtin Commands". Retrieved 23 May 2016.
  5. ^ "ksh man page". Oracle. Retrieved 23 May 2016. + . name [arg ...]
  6. ^ "BASH BUILTIN COMMANDS", the (GNU) Linux man page for "source" in Bash-3.0. 2004 Apr 20

External links[edit]