diff options
author | Cyril Plisko <cyril.plisko@mountall.com> | 2016-09-17 20:39:00 +0300 |
---|---|---|
committer | Cyril Plisko <cyril.plisko@mountall.com> | 2016-09-17 20:39:00 +0300 |
commit | d86f1474eb70917484d80466e74d0ce4c46c8c86 (patch) | |
tree | c0d0691e327fb0806f68078ff3e5560ed3e3ae73 | |
parent | 6ebeabe51c251107c847bdee98ded328d07815ef (diff) |
Update documentation
Mention `NOPAGER` which disables Pager.
-rw-r--r-- | README.md | 4 | ||||
-rw-r--r-- | src/lib.rs | 3 |
2 files changed, 7 insertions, 0 deletions
@@ -43,3 +43,7 @@ fn main() { If no suitable pager found `setup()` does nothing and your executable keeps running as usual. `Pager` cleans after itself and doesn't leak resources in case of setup failure. + +If you need to disable pager altogether set environment variable `NOPAGER` +and Pager::setup() will skip initialization. The host application will continue +as normal. Pager::ok() will reflect the fact that no Pager is active. @@ -34,6 +34,9 @@ //! running as usual. `Pager` cleans after itself and doesn't leak resources in //! case of setup failure. //! +//! If you need to disable pager altogether set environment variable `NOPAGER` and Pager::setup() +//! will skip initialization. The host application will continue as normal. Pager::ok() will +//! reflect the fact that no Pager is active. extern crate libc; |