summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorCyril Plisko <cyril.plisko@mountall.com>2016-09-17 20:39:00 +0300
committerCyril Plisko <cyril.plisko@mountall.com>2016-09-17 20:39:00 +0300
commitd86f1474eb70917484d80466e74d0ce4c46c8c86 (patch)
treec0d0691e327fb0806f68078ff3e5560ed3e3ae73 /src
parent6ebeabe51c251107c847bdee98ded328d07815ef (diff)
Update documentation
Mention `NOPAGER` which disables Pager.
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 4aedc29..868657c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -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;