From 7e33943a348b82eea9a1b0a754a243a4eb1a294f Mon Sep 17 00:00:00 2001 From: Colin Hebert Date: Sat, 14 Apr 2012 11:10:55 +0100 Subject: [PATCH] Add directory documentation --- modules/directory/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 modules/directory/README.md diff --git a/modules/directory/README.md b/modules/directory/README.md new file mode 100644 index 00000000..8f25561d --- /dev/null +++ b/modules/directory/README.md @@ -0,0 +1,32 @@ +Directory +========= +Sets directory options and defines directory aliases. + +Options +------- + + - `AUTO_CD`, Auto cd to a directory without typing `cd`. + - `AUTO_PUSHD`, Push the old directory onto the stack on `cd`. + - `PUSHD_IGNORE_DUPS`, Don't store duplicates in the stack. + - `PUSHD_SILENT`, Do not print the directory stack after `pushd` or `popd`. + - `PUSHD_TO_HOME`, Push to home directory when no argument is given. + - `CDABLE_VARS`, Change directory to a path stored in a variable. + - `AUTO_NAME_DIRS`, Auto add variable-stored paths to `~` list. + - `MULTIOS`, Write to multiple descriptors. + - `EXTENDED_GLOB`, Use extended globbing syntax. + - `CLOBBER`, Don't overwrite existing files with `>` and `>>`. Use `>!` and +`>>!` to bypass. + +Aliases +------- + + - `d`, Print the contents of the `directory` stack. + - `1` to `9`, Change directory to the `n` previous one. + +Authors +------- + +*The authors of this module should be contacted via the github bug tracker.* + + - [James Cox](/imajes) + - [Sorin Ionescu](/sorin-ionescu)