Add Pager::with_pager()

1 files changed, 24 insertions, 0 deletions

diff --git a/src/lib.rs b/src/lib.rs
index 0da6a88..d3a09f6 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -30,6 +30,21 @@
 //! }
 //! ```
 //!
+//! Alternatively you can specify directly the desired pager command, exactly
+//! as it would appear in PAGER environment variable. This is useful if you
+//! need some specific pager and/or flags (like "more -r") and would like to
+//! avoid forcing your consumers into modifying their existing PAGER
+//! configuration just for your application.
+//!
+//! ```rust
+//! extern crate pager;
+//! use pager::Pager;
+//! fn main() {
+//!     Pager::with_pager("more -r").setup();
+//!     // The rest of your program goes here
+//! }
+//! ```
+//!
 //! 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.
@@ -71,6 +86,15 @@ impl Pager {
         }
     }
 
+    /// Creates a new pager instance directly specifying the desired pager
+    pub fn with_pager(pager: &str) -> Self {
+        Pager {
+            pager: OsString::from(pager).into(),
+            env: None,
+            on: true,
+        }
+    }
+
     /// Gives quick assessment of successful Pager setup
     pub fn is_on(&self) -> bool {
         self.on