diff --git a/README.md b/README.md index b990ba9..a77cc23 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ extern crate man; use man::prelude::*; fn main() { - let page = Man::new("basic") - .description("A basic example") + let page = Manual::new("basic") + .about("A basic example") .author(Author::new("Alice Person").email("alice@person.com")) .author(Author::new("Bob Human").email("bob@human.com")) .flag(Flag::new().short("-d").long("--deubg").description("Enable debug mode")) diff --git a/examples/main.rs b/examples/main.rs index 03a2a65..98cf5d6 100644 --- a/examples/main.rs +++ b/examples/main.rs @@ -3,7 +3,7 @@ extern crate man; use man::prelude::*; fn main() { - let msg = Man::new("auth-service") + let msg = Manual::new("auth-service") .about("authorize & authenticate members".into()) .arg(Arg::new("path")) .env(Env::new("PORT").help("The network port to listen to")) diff --git a/src/lib.rs b/src/lib.rs index a2570d7..d3c3fd6 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -18,5 +18,5 @@ pub use arg::Arg; pub use author::Author; pub use environment::Env; pub use flag::Flag; -pub use man::Man; +pub use man::Manual; pub use option::Opt; diff --git a/src/man.rs b/src/man.rs index d956fb9..7b06424 100644 --- a/src/man.rs +++ b/src/man.rs @@ -3,7 +3,7 @@ use roff::{bold, italic, list, Roff, Troffable}; /// Man page struct. #[derive(Debug, Clone)] -pub struct Man { +pub struct Manual { name: String, about: Option, authors: Vec, @@ -13,7 +13,7 @@ pub struct Man { arguments: Vec, } -impl Man { +impl Manual { /// Create a new instance. pub fn new(name: &str) -> Self { Self { diff --git a/src/prelude.rs b/src/prelude.rs index 3a04a29..89a3b20 100644 --- a/src/prelude.rs +++ b/src/prelude.rs @@ -13,5 +13,5 @@ pub use arg::Arg; pub use author::Author; pub use environment::Env; pub use flag::Flag; -pub use man::Man; +pub use man::Manual; pub use option::Opt;