From 0aa68c4ab91e2a58d448c9c89a16721eb8b89ffc Mon Sep 17 00:00:00 2001 From: Cyril Plisko Date: Wed, 26 Sep 2018 11:30:34 +0300 Subject: Add documentation for Pager::with_default_pager() --- src/lib.rs | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 39d4d82..7786ea7 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -30,6 +30,17 @@ //! } //! ``` //! +//! Also you can set alternative default (fallback) pager to be used instead of +//! `more`. PAGER environment variable (if set) will still have precedence. +//! +//! ```rust +//! extern crate pager; +//! use pager::Pager; +//! fn main() { +//! Pager::with_default_pager("pager").setup(); +//! // The rest of your program goes here +//! } +//! ``` //! 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 "less -r") and would like to @@ -40,7 +51,7 @@ //! extern crate pager; //! use pager::Pager; //! fn main() { -//! Pager::with_pager("less -r").setup(); +//! Pager::with_pager("pager -r").setup(); //! // The rest of your program goes here //! } //! ``` -- cgit v1.2.3