From 9a4a3d183f7ceeef5fd7100869979fcc77bf5c41 Mon Sep 17 00:00:00 2001 From: Paul Ackersviller Date: Mon, 29 Oct 2007 19:25:58 +0000 Subject: Merge 22728 and 22734: $functrace parameter for function backtraces. --- Doc/Zsh/mod_parameter.yo | 55 +++++++++++++++++++++++++++++++----------------- 1 file changed, 36 insertions(+), 19 deletions(-) (limited to 'Doc') diff --git a/Doc/Zsh/mod_parameter.yo b/Doc/Zsh/mod_parameter.yo index 07e90ec21..529c65d33 100644 --- a/Doc/Zsh/mod_parameter.yo +++ b/Doc/Zsh/mod_parameter.yo @@ -28,7 +28,7 @@ hash table. ) vindex(functions) item(tt(functions))( -This association maps names of enabled functions to their +This associative array maps names of enabled functions to their definitions. Setting a key in it is like defining a function with the name given by the key and the body given by the value. Unsetting a key removes the definition for the function named by the key. @@ -39,7 +39,7 @@ Like tt(functions) but for disabled functions. ) vindex(builtins) item(tt(builtins))( -This association gives information about the builtin commands +This associative array gives information about the builtin commands currently enabled. The keys are the names of the builtin commands and the values are either `tt(undefined)' for builtin commands that will automatically be loaded from a module if invoked or `tt(defined)' for @@ -64,16 +64,24 @@ expansions. ) vindex(dis_aliases) item(tt(dis_aliases))( -Like tt(raliases) but for disabled regular aliases. +Like tt(aliases) but for disabled regular aliases. ) vindex(galiases) item(tt(galiases))( -Like tt(raliases), but for global aliases. +Like tt(aliases), but for global aliases. ) vindex(dis_galiases) item(tt(dis_galiases))( Like tt(galiases) but for disabled global aliases. ) +vindex(saliases) +item(tt(saliases))( +Like tt(raliases), but for suffix aliases. +) +vindex(dis_saliases) +item(tt(dis_saliases))( +Like tt(saliases) but for disabled suffix aliases. +) vindex(parameters) item(tt(parameters))( The keys in this associative array are the names of the parameters @@ -90,10 +98,11 @@ Setting or unsetting keys in this array is not possible. ) vindex(modules) item(tt(modules))( -An association giving information about module. The keys are the names -of the modules builtin, loaded, or registered to be autoloaded. The +An associative array giving information about modules. The keys are the names +of the modules loaded, registered to be autoloaded, or aliased. The value says which state the named module is in and is one of the -strings tt(builtin), tt(loaded), or tt(autoloaded). +strings `tt(loaded)', `tt(autoloaded)', or `tt(alias:)var(name)', +where var(name) is the name the module is aliased to. Setting or unsetting keys in this array is not possible. ) @@ -105,7 +114,7 @@ directory, the current working directory. ) vindex(history) item(tt(history))( -This association maps history event numbers to the full history lines. +This associative array maps history event numbers to the full history lines. ) vindex(historywords) item(tt(historywords))( @@ -113,33 +122,35 @@ A special array containing the words stored in the history. ) vindex(jobdirs) item(tt(jobdirs))( -This association maps job numbers to the directories from which the job was started (which may not be the current directory of the job). +This associative array maps job numbers to the directories from which the +job was started (which may not be the current directory of the job). ) vindex(jobtexts) item(tt(jobtexts))( -This association maps job numbers to the texts of the command lines +This associative array maps job numbers to the texts of the command lines that were used to start the jobs. ) vindex(jobstates) item(tt(jobstates))( -This association gives information about the states of the jobs +This associative array gives information about the states of the jobs currently known. The keys are the job numbers and the values are strings of the form -`var(job-state):var(pid)tt(=)var(state)tt(...)'. The var(job-state) -gives the state the whole job is currently in, one of `tt(running)', -`tt(suspended)', or `tt(done)'. This is follwed by one -`var(pid)tt(=)var(state)' for every process in the job. The var(pid)s -are, of course, the process IDs and the var(state) describes the state -of that process. +`var(job-state):var(mark):var(pid)tt(=)var(state)tt(...)'. The +var(job-state) gives the state the whole job is currently in, one of +`tt(running)', `tt(suspended)', or `tt(done)'. The var(mark) is +`tt(+)' for the current job, `tt(-)' for the previous job and empty +otherwise. This is followed by one `var(pid)tt(=)var(state)' for every +process in the job. The var(pid)s are, of course, the process IDs and +the var(state) describes the state of that process. ) vindex(nameddirs) item(tt(nameddirs))( -This association maps the names of named directories to the pathnames +This associative array maps the names of named directories to the pathnames they stand for. ) vindex(userdirs) item(tt(userdirs))( -This association maps user names to the pathnames of their home +This associative array maps user names to the pathnames of their home directories. ) vindex(funcstack) @@ -148,4 +159,10 @@ This array contains the names of the functions currently being executed. The first element is the name of the function using the parameter. ) +vindex(functrace) +item(tt(functrace))( +This array contains the names and line numbers of the callers +corresponding to the functions currently being executed. +The format of each element is name:lineno. +) enditem() -- cgit 1.4.1