[Fix #109] Add documentation for pacman

modules/pacman/README.md

@@ -0,0 +1,65 @@
+Pacman
+======
+
+Provides aliases and functions for the [Pacman][1] package manager and
+frontends.
+
+Settings
+--------
+
+To enable a Pacman frontend, for example, [Yaourt][2], add the following line to
+*zshrc*:
+
+    zstyle ':omz:module:pacman' frontend 'yaourt'
+
+If you have enabled color globally in *zshrc*, you may disable it for certain
+commands.
+
+To disable `yaourt` highlighting, add the following line to *zshrc*:
+
+    zstyle ':omz:module:pacman:yaourt' color 'no'
+
+Aliases
+-------
+
+### Pacman
+
+  - `paci` installs packages from repositories.
+  - `pacI` installs packages from files.
+  - `pacx` removes packages and unneeded dependencies.
+  - `pacX` removes packages, their configuration, and unneeded dependencies.
+  - `pacq` displays information about a given package in the repositories.
+  - `pacQ` displays information about a given package in the local database.
+  - `pacs` searches for packages in the repositories.
+  - `pacS` searches for packages in the local database.
+  - `pacu` synchronizes the local package and Arch Build System (requires `abs`)
+    databases against the repositories.
+  - `pacU` synchronizes the local package database against the repositories then
+    upgrades outdated packages.
+  - `pacman-list-orphans` lists orphan packages.
+  - `pacman-remove-orphans` removes orphan packages.
+
+### Frontends
+
+#### Yaourt
+
+  - `pacc` manages *.pac\** files.
+
+Functions
+---------
+
+  - `pacman-list-explicit` lists explicitly installed pacman packages.
+  - `pacman-list-disowned` lists pacman disowned files.
+
+Authors
+-------
+
+*The authors of this module should be contacted via the [issue tracker][3].*
+
+  - [Benjamin Boudreau](https://github.com/dreur)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+[1]: http://www.archlinux.org/pacman/
+[2]: http://archlinux.fr/yaourt-en
+[3]: https://github.com/sorin-ionescu/oh-my-zsh/issues
+