Go to file
Robin Krahl fc7d2c7ee9
Format text output look like man
With this patch, we change our rich and plain viewer implementations to
format their output similar to the output of man.  This means:
- Adding a title with the current crate, documentation item and
  “rusty-man”
- Printing headings at indent levels 0, 3, 6 and printing content with
  indent 6, 12
- Printing headings bold and uppercase (level 1) or bold (levels 2, 3)
2020-07-24 12:09:40 +02:00
.builds Run cargo doc before cargo test 2020-07-19 17:39:47 +02:00
LICENSES Initial project scaffolding 2020-07-19 14:10:54 +02:00
src Format text output look like man 2020-07-24 12:09:40 +02:00
.gitignore Initial project scaffolding 2020-07-19 14:10:54 +02:00
Cargo.lock List variants for enums 2020-07-22 19:37:48 +02:00
Cargo.toml List variants for enums 2020-07-22 19:37:48 +02:00
CONTRIBUTING.md Extend contributing guide 2020-07-20 10:23:28 +02:00
INSTALL.md Add installation and contributing information 2020-07-20 01:42:30 +02:00
README.md Fix wrong command in example usage 2020-07-20 10:29:55 +02:00

rusty-man

A command-line viewer for documentation generated by rustdoc.

Example Usage

$ cd rusty-man && cargo doc
$ rusty-man kuchiki::NodeRef
# Struct kuchiki::NodeRef

pub struct NodeRef(pub Rc<Node>);

A strong reference to a node.

$ rusty-man --source ~/.rustup/toolchains/stable-*/share/doc/html io::Error
# Struct std::io::Error

pub struct Error { /* fields omitted */ }

The error type for I/O operations of the `Read`, `Write`, `Seek`, and associated traits.

Errors mostly originate from the underlying OS, but custom instances of `Error` can be created with
crafted error messages and a particular value of `ErrorKind`.

$ rusty-man --source ~/.rustup/toolchains/stable-*/share/doc/rust/html u8
Found mulitple matches for u8  select one of:

[ 0 ] core::u8: The 8-bit unsigned integer type.
[ 1 ] std::u8: The 8-bit unsigned integer type.

> 1

# Primitive Type u8

The 8-bit unsigned integer type.

Installation

To install rusty-man, clone this repository and use cargo to build the project. See the INSTALL.md file for more information.

rusty-man should run on all platforms supported by termion. If you have trouble running rusty-man on your platform or if you want to help porting rusty-man to other platforms, please let me know.

Contributing

Contributions to this project are very welcome! You can contribute by writing code or documentation or by testing. See the CONTRIBUTING.md file for more information.

If you are looking for a good starting point, have a look at the issues with the label “good first issue” in rusty-mans issue tracker.

Minimum Supported Rust Version

This crate supports Rust 1.40 or later.

Contact

For bug reports, patches, feature requests or other messages, please send a mail to the mailing list ~ireas/rusty-man-dev@lists.sr.ht (public archive) or contact me directly. You can also use the rusty-man issue tracker for bug reports or features requests.

License

This project is licensed under the MIT License.

rusty-man complies with version 3.0 of the REUSE specification.