{"id":13611814,"url":"https://github.com/rust-cli/man","last_synced_at":"2025-12-12T16:47:02.840Z","repository":{"id":55078281,"uuid":"138226576","full_name":"rust-cli/man","owner":"rust-cli","description":"Generate structured man pages","archived":false,"fork":false,"pushed_at":"2023-12-15T05:09:04.000Z","size":53,"stargazers_count":175,"open_issues_count":14,"forks_count":8,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-07T20:50:06.330Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rust-cli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-06-21T22:08:10.000Z","updated_at":"2025-03-22T20:13:35.000Z","dependencies_parsed_at":"2024-01-14T06:52:55.829Z","dependency_job_id":"84bc867f-f45e-497c-b00d-2b99461b5af6","html_url":"https://github.com/rust-cli/man","commit_stats":null,"previous_names":["rust-clique/man"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/rust-cli/man","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-cli%2Fman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-cli%2Fman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-cli%2Fman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-cli%2Fman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rust-cli","download_url":"https://codeload.github.com/rust-cli/man/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-cli%2Fman/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271378680,"owners_count":24749192,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T19:02:10.473Z","updated_at":"2025-12-12T16:46:57.808Z","avatar_url":"https://github.com/rust-cli.png","language":"Rust","readme":"# man\n[![crates.io version][1]][2] [![build status][3]][4]\n[![downloads][5]][6] [![docs.rs docs][7]][8]\n\nGenerate structured man pages using\n[roff-rs](https://github.com/killercup/roff-rs).\n\n- [Documentation][8]\n- [Crates.io][2]\n\n## Usage\n```rust\nuse man::prelude::*;\n\nfn main() {\n    let page = Manual::new(\"basic\")\n        .about(\"A basic example\")\n        .author(Author::new(\"Alice Person\").email(\"alice@person.com\"))\n        .author(Author::new(\"Bob Human\").email(\"bob@human.com\"))\n        .flag(\n            Flag::new()\n                .short(\"-d\")\n                .long(\"--debug\")\n                .help(\"Enable debug mode\"),\n        )\n        .flag(\n            Flag::new()\n                .short(\"-v\")\n                .long(\"--verbose\")\n                .help(\"Enable verbose mode\"),\n        )\n        .option(\n            Opt::new(\"output\")\n                .short(\"-o\")\n                .long(\"--output\")\n                .help(\"The file path to write output to\"),\n        )\n        .example(\n            Example::new()\n                .text(\"run basic in debug mode\")\n                .command(\"basic -d\")\n                .output(\"Debug Mode: basic will print errors to the console\")\n            )\n        .custom(\n            Section::new(\"usage note\")\n                .paragraph(\"This program will overwrite any file currently stored at the output path\")\n        )\n        .render();\n\n    println!(\"{}\", page);\n}\n```\nPreview by running:\n```sh\n$ cargo run \u003e /tmp/app.man; man /tmp/app.man\n```\nWhich outputs:\n\u003cpre\u003e\nBASIC(1)                       General Commands Manual                          BASIC(1)\n\n\u003cb\u003eNAME\u003c/b\u003e\n       basic - A basic example\n\n\u003cb\u003eSYNOPSIS\u003c/b\u003e\n       \u003cb\u003ebasic\u003c/b\u003e [FLAGS] [OPTIONS]\n\n\u003cb\u003eFLAGS\u003c/b\u003e\n       \u003cb\u003e-d, --debug\u003c/b\u003e\n              Enable debug mode\n\n       \u003cb\u003e-v, --verbose\u003c/b\u003e\n              Enable verbose mode\n\n\u003cb\u003eOPTIONS\u003c/b\u003e\n       \u003cb\u003e-o, --output\u003c/b\u003e=\u003ci\u003eoutput\u003c/i\u003e\n              The file path to write output to\n\n\u003cb\u003eUSAGE NOTE\u003c/b\u003e\n       This file will overwrite any file currently stored at the output path.\n\n\u003cb\u003eEXIT STATUS\u003c/b\u003e\n       \u003cstrong\u003e0\u003c/strong\u003e      Successful program execution.\n\n       \u003cb\u003e1\u003c/b\u003e      Unsuccessful program execution.\n\n       \u003cb\u003e101\u003c/b\u003e    The program panicked.\n\n\u003cb\u003eEXAMPLES\u003c/b\u003e\n       run basic in debug mode\n              \u003cb\u003e$ basic -d\u003c/b\u003e\n              Debug Mode: basic will print errors to the console\n\n\u003cb\u003eAUTHORS\u003c/b\u003e\n         Alice Person \u0026lt;alice@person.com\u0026gt;\n         Bob Human \u0026lt;bob@human.com\u0026gt;\n\n                                                                                BASIC(1)\n\u003c/pre\u003e\n\n## Installation\nIf using [cargo-edit](https://github.com/killercup/cargo-edit), install with\n```sh\n$ cargo add man\n```\nOtherwise, install by adding to Cargo.toml file's dependency section.\n\n## License\n[MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE)\n\n[1]: https://img.shields.io/crates/v/man.svg?style=flat-square\n[2]: https://crates.io/crates/man\n[3]: https://img.shields.io/travis/rust-clique/man.svg?style=flat-square\n[4]: https://travis-ci.org/rust-clique/man\n[5]: https://img.shields.io/crates/d/man.svg?style=flat-square\n[6]: https://crates.io/crates/man\n[7]: https://docs.rs/man/badge.svg\n[8]: https://docs.rs/man\n","funding_links":[],"categories":["Rust"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frust-cli%2Fman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frust-cli%2Fman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frust-cli%2Fman/lists"}