summary refs log tree commit diff
path: root/Doc/Zsh
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2005-07-20 16:08:12 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2005-07-20 16:08:12 +0000
commite3c5dd2dd9abc3d9fe1fee4c4054c4c2a7f11395 (patch)
tree0088cf78f6694d0c7f7fe5c8380298936dac36d3 /Doc/Zsh
parenteb86b42f304ec29a885a047ef5c681ec2ab40d1d (diff)
downloadzsh-e3c5dd2dd9abc3d9fe1fee4c4054c4c2a7f11395.tar.gz
zsh-e3c5dd2dd9abc3d9fe1fee4c4054c4c2a7f11395.tar.xz
zsh-e3c5dd2dd9abc3d9fe1fee4c4054c4c2a7f11395.zip
21498: Add zsh/newuser module
Diffstat (limited to 'Doc/Zsh')
-rw-r--r--Doc/Zsh/mod_newuser.yo37
1 files changed, 37 insertions, 0 deletions
diff --git a/Doc/Zsh/mod_newuser.yo b/Doc/Zsh/mod_newuser.yo
new file mode 100644
index 000000000..202fb90e8
--- /dev/null
+++ b/Doc/Zsh/mod_newuser.yo
@@ -0,0 +1,37 @@
+COMMENT(!MOD!zsh/newuser
+Arrange for files for new users to be installed.
+!MOD!)
+The tt(zsh/newuser) module is loaded at boot if it is
+available, the tt(RCS) option is set, and the tt(PRIVILEGED) option is not
+set (all three are true by default).  This takes
+place immediately after commands in the global tt(zshenv) file (typically
+tt(/etc/zshenv)), if any, have been executed.  If the module is not
+available it is silently ignored by the shell; the module may safely be
+removed from tt($MODULE_PATH) by the administrator if it is not required.
+
+On loading, the module tests if any of the start-up files tt(.zshenv),
+tt(.zprofile), tt(.zshrc) or tt(.zlogin) exist in the directory given by
+the environment variable tt(ZDOTDIR), or the user's home directory if that
+is not set.
+
+If none of the start-up files were found, the module then looks for the
+file tt(newuser) first in a sitewide directory, usually the parent
+directory of the tt(site-functions) directory, and if that is not found the
+module searches in a version-specific directory, usually the parent of the
+tt(functions) directory containing version-specific functions.  (These
+directories can be configured when zsh is built using the
+tt(--enable-site-scriptdir=)var(dir) and tt(--enable-scriptdir=)var(dir)
+flags to tt(configure), respectively; the defaults are
+var(prefix)tt(/share/zsh) and var(prefix)tt(/share/zsh/$ZSH_VERSION) where
+the default var(prefix) is tt(/usr/local).)
+
+If the file tt(newuser) is found, it is then sourced in the same manner as
+a start-up file.  The file is expected to contain code to install start-up
+files for the user, however any valid shell code will be executed.
+
+The tt(zsh/newuser) module is then unconditionally unloaded.
+
+Note that it is possible to achieve exactly the same effect as the
+tt(zsh/newuser) module by adding code to tt(/etc/zshenv).  The module
+exists simply to allow the shell to make arrangements for new users without
+the need for invervention by package maintainers and system administrators.