Skip to content

Generate Man Pages for Linux (mvis.1) #57

@SickleFire

Description

@SickleFire

Problem

Linux users expect man mvis to work, but there's no man page. Users unfamiliar with the tool can't quickly reference command syntax or options while in the terminal.

Proposed Solution

Create a mvis.1 man page in roff format (standard man page format) that documents:

  • NAME: Brief description
  • SYNOPSIS: Command syntax
  • DESCRIPTION: Detailed explanation
  • COMMANDS: Each command (scan, leak, list, tui) with examples
  • OPTIONS: All flags and their behavior
  • EXAMPLES: Real-world usage scenarios
  • SEE ALSO: Related commands
  • BUGS: Known limitations

Generate during build with cargo build --release and install to /usr/share/man/man1/mvis.1 or $PREFIX/share/man/man1/ on make install.

Alternative Approaches

  • Host docs on GitHub Pages only (less discoverable)
  • Generate at runtime with mvis man mvis command

Examples

$ man mvis
# Opens formatted man page in less/pager
$ man mvis.leak
# Shows man page for leak subcommand

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions