Windows PowerShell command on Get-command zshbuiltins

Manual Pages for UNIX Operating System command usage for man zshbuiltins

User Commands ZSHBUILTINS(1)

NAME

zshbuiltins - zsh built-in commands

SHELL BUILTIN COMMANDS

- simple command

See the section `Precommand Modifiers'. . file [ arg ... ] Read commands from file and execute them in the current shell environment.

If file does not contain a slash, or if PATH_DIRS is

set, the shell looks in the components of $path to find

the directory containing file. Files in the current directory are not read unless `.' appears somewhere in

$path. If a file named `file.zwc' is found, is newer

than file, and is the compiled form (created with the zcompile builtin) of file, then commands are read from that file instead of file.

If any arguments arg are given, they become the posi-

tional parameters; the old positional parameters are restored when the file is done executing. The exit status is the exit status of the last command executed. : [ arg ... ] This command does nothing, although normal argument expansions is performed which may have effects on shell parameters. A zero exit status is returned.

alias [ {+|-}gmrsL ] [ name[=value] ... ]

For each name with a corresponding value, define an alias with that value. A trailing space in value causes the next word to be checked for alias expansion.

If the -g flag is present, define a global alias; glo-

bal aliases are expanded even if they do not occur in command position.

If the -s flags is present, define a suffix alias: if

the command word on a command line is in the form

`text.name', where text is any non-empty string, it is

replaced by the text `value text.name'. Note that name is treated as a literal string, not a pattern. A trailing space in value is not special in this case. For example,

alias -s ps=gv

will cause the command `*.ps' to be expanded to `gv *.ps'. As alias expansion is carried out earlier than globbing, the `*.ps' will then be expanded. Suffix aliases constitute a different name space from other zsh 4.3.10 Last change: June 1, 2009 1 User Commands ZSHBUILTINS(1) aliases (so in the above example it is still possible to create an alias for the command ps) and the two sets are never listed together. For each name with no value, print the value of name, if any. With no arguments, print all currently defined

aliases other than suffix aliases. If the -m flag is

given the arguments are taken as patterns (they should be quoted to preserve them from being interpreted as glob patterns), and the aliases matching these patterns

are printed. When printing aliases and one of the -g,

-r or -s flags is present, restrict the printing to

global, regular or suffix aliases, respectively; a reg-

ular alias is one which is neither a global nor a suf-

fix alias. Using `+' instead of `-', or ending the

option list with a single `+', prevents the values of the aliases from being printed.

If the -L flag is present, then print each alias in a

manner suitable for putting in a startup script. The exit status is nonzero if a name (with no value) is given for which no alias has been defined. For more on aliases, include common problems, see the section ALIASING in zshmisc(1).

autoload [ {+|-}UXktz ] [ -w ] [ name ... ]

Equivalent to functions -u, with the exception of -X/+X

and -w.

The flag -X may be used only inside a shell function,

and may not be followed by a name. It causes the cal-

ling function to be marked for autoloading and then immediately loaded and executed, with the current array of positional parameters as arguments. This replaces

the previous definition of the function. If no func-

tion definition is found, an error is printed and the function remains undefined and marked for autoloading. The flag +X attempts to load each name as an autoloaded function, but does not execute it. The exit status is zero (success) if the function was not previously defined and a definition for it was found. This does not replace any existing definition of the function. The exit status is nonzero (failure) if the function was already defined or when no definition was found. In the latter case the function remains undefined and

marked for autoloading. If ksh-style autoloading is

enabled, the function created will contain the contents of the file plus a call to the function itself appended to it, thus giving normal ksh autoloading behaviour on the first call to the function. zsh 4.3.10 Last change: June 1, 2009 2 User Commands ZSHBUILTINS(1)

With the -w flag, the names are taken as names of files

compiled with the zcompile builtin, and all functions defined in them are marked for autoloading.

The flags -z and -k mark the function to be autoloaded

in native or ksh emulation, as if the option

KSH_AUTOLOAD were unset or were set, respectively. The

flags override the setting of the option at the time the function is loaded. bg [ job ... ] job ... & Put each specified job in the background, or the current job if none is specified. bindkey See the section `Zle Builtins' in zshzle(1). break [ n ] Exit from an enclosing for, while, until, select or repeat loop. If n is specified, then break n levels instead of just one. builtin name [ args ... ] Executes the builtin name, with the given args. bye Same as exit. cap See the section `The zsh/cap Module' in zshmodules(1).

cd [ -qsLP ] [ arg ]

cd [ -qsLP ] old new

cd [ -qsLP ] {+|-}n

Change the current directory. In the first form, change the current directory to arg, or to the value of

$HOME if arg is not specified. If arg is `-', change

to the value of $OLDPWD, the previous directory.

Otherwise, if arg begins with a slash, attempt to change to the directory given by arg. If arg does not begin with a slash, the behaviour depends on whether the current directory `.' occurs in

the list of directories contained in the shell parame-

ter cdpath. If it does not, first attempt to change to the directory arg under the current directory, and if that fails but cdpath is set and contains at least one element attempt to change to the directory arg under each component of cdpath in turn until successful. If `.' occurs in cdpath, then cdpath is searched strictly in order so that `.' is only tried at the appropriate point. zsh 4.3.10 Last change: June 1, 2009 3 User Commands ZSHBUILTINS(1)

If no directory is found, the option CDABLE_VARS is

set, and a parameter named arg exists whose value begins with a slash, treat its value as the directory. In that case, the parameter is added to the named directory hash table. The second form of cd substitutes the string new for the string old in the name of the current directory, and tries to change to this new directory.

The third form of cd extracts an entry from the direc-

tory stack, and changes to that directory. An argument of the form `+n' identifies a stack entry by counting from the left of the list shown by the dirs command,

starting with zero. An argument of the form `-n'

counts from the right. If the PUSHD_MINUS option is

set, the meanings of `+' and `-' in this context are

swapped.

If the -q (quiet) option is specified, the hook func-

tion chpwd and the functions in the array

chpwd_functions are not called. This is useful for

calls to cd that do not change the environment seen by an interactive user.

If the -s option is specified, cd refuses to change the

current directory if the given pathname contains sym-

links. If the -P option is given or the CHASE_LINKS

option is set, symbolic links are resolved to their

true values. If the -L option is given symbolic links

are retained in the directory (and not resolved)

regardless of the state of the CHASE_LINKS option.

chdir Same as cd. clone

See the section `The zsh/clone Module' in zshmo-

dules(1).

command [ -pvV ] simple command

The simple command argument is taken as an external

command instead of a function or builtin and is exe-

cuted. If the POSIX_BUILTINS option is set, builtins

will also be executed but certain special properties of

them are suppressed. The -p flag causes a default path

to be searched instead of that in $path. With the -v

flag, command is similar to whence and with -V, it is

equivalent to whence -v.

See also the section `Precommand Modifiers'. zsh 4.3.10 Last change: June 1, 2009 4 User Commands ZSHBUILTINS(1) comparguments