summaryrefslogtreecommitdiff
path: root/plugins/wd/README.md
diff options
context:
space:
mode:
authorMarkus Faerevaag <mafaer@gmail.com>2014-07-15 17:42:30 +0200
committerMarkus Faerevaag <mafaer@gmail.com>2014-07-15 17:44:23 +0200
commit346f6b7d24d6021efa8c5167088f98c10f00ad3f (patch)
tree646b95ad7cc1a339d73e101593ac821c7f3f516b /plugins/wd/README.md
parentc925aabea9b8b0578735fab4c75bec86e4d20f16 (diff)
downloadzsh-346f6b7d24d6021efa8c5167088f98c10f00ad3f.tar.gz
zsh-346f6b7d24d6021efa8c5167088f98c10f00ad3f.tar.bz2
zsh-346f6b7d24d6021efa8c5167088f98c10f00ad3f.zip
[wd] v0.3.1: Improved completion and bug fixes
Diffstat (limited to 'plugins/wd/README.md')
-rw-r--r--plugins/wd/README.md26
1 files changed, 14 insertions, 12 deletions
diff --git a/plugins/wd/README.md b/plugins/wd/README.md
index f9f4e7ac1..bc0ebe334 100644
--- a/plugins/wd/README.md
+++ b/plugins/wd/README.md
@@ -2,37 +2,39 @@
**Maintainer:** [mfaerevaag](https://github.com/mfaerevaag)
-`wd` (warp directory) lets you jump to custom directories in zsh, without using cd. Why? Because cd seems ineffecient when the folder is frequently visited or has a long path. [Source](https://github.com/mfaerevaag/wd)
+`wd` (*warp directory*) lets you jump to custom directories in zsh, without using `cd`. Why? Because `cd` seems ineffecient when the folder is frequently visited or has a long path. [Source](https://github.com/mfaerevaag/wd)
### Usage
* Add warp point to current working directory:
- wd add test
+ $ wd add foo
If a warp point with the same name exists, use `add!` to overwrite it.
- * From an other directory, warp to test with:
+ Note, a warp point cannot contain colons, or only consist of only spaces and dots. The first will conflict in how `wd` stores the warp points, and the second will conflict other features, as below.
- wd test
+ * From an other directory (not necessarily), warp to `foo` with:
- * You can warp back to previous directory, and so on, with the puncticulation syntax:
+ $ wd foo
- wd ..
- wd ...
+ * You can warp back to previous directory, and so on, with this dot syntax:
+
+ $ wd ..
+ $ wd ...
This is a wrapper for the zsh `dirs` function.
* Remove warp point test point:
- wd rm test
+ $ wd rm foo
- * List warp points to current directory (stored in `~/.warprc`):
+ * List all warp points (stored in `~/.warprc`):
- wd show
+ $ wd ls
- * List all warp points (stored in `~/.warprc`):
+ * List warp points to current directory
- wd ls
+ $ wd show
* Print usage with no opts or the `help` argument.