From 6f1846d38866853fc7a36ee0d431d70baf352669 Mon Sep 17 00:00:00 2001 From: Kevin MacMartin Date: Thu, 31 Jul 2014 01:44:10 -0400 Subject: [PATCH] Improved vimpager documentation --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d7d0465..e70a5be 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,32 @@ A theme, config and collection of plugins for Vim. ### Vimpager ### -Once darkcloud-vimconfig has been set up, you can configure `vimpager` to use it by running: `ln -s /etc/darkcloud-vimconfig/vimpagerrc /etc/vimpagerrc` for a system-wide configuration, or `ln -s /etc/darkcloud-vimconfig/vimpagerrc ~/.vimpagerrc` for a given user (assuming you've used the default path @ _"/etc/darkcloud-vimconfig"_). +Once darkcloud-vimconfig has been set up, you can configure `vimpager` to use it by running (assuming the default path @ _"/etc/darkcloud-vimconfig"_): -As usual, to have your system use vimpager in place of less, you'll need to set the PAGER environment variable to vimpager: `export PAGER=vimpager` and configure an alias for less: `alias less='vimpager'`. +`ln -s /etc/darkcloud-vimconfig/vimpagerrc /etc/vimpagerrc` (for a system-wide configuration) + +or: + +`ln -s /etc/darkcloud-vimconfig/vimpagerrc ~/.vimpagerrc` (for a given user). + +Similarly, the _vimpagerrc_ can be used for `vimcat` as well by running: + +`ln -s /etc/darkcloud-vimconfig/vimpagerrc /etc/vimcatrc` (for a system-wide configuration) + +or: + +`ln -s /etc/darkcloud-vimconfig/vimpagerrc ~/.vimcatrc` (for a given user). + +As usual, to have your system use `vimpager` in place of `less`, you'll need to set the **$PAGER** environment variable to `vimpager`: + +`export PAGER=vimpager` + +and configure aliases for less and cat in _"/etc/bash.bashrc"_ or _"~/.bashrc"_: + +``` +alias less='vimpager' +alias cat='vimcat' +``` ## Configuration ##