WinMan

A Windows manual page like linux's man command. Built with Rust.

Features

• PowerShell command management
• Manual page generation for powershell commands
• Easy-to-use command-line interface

Building from Source

Prerequisites

• Rust toolchain (https://rustup.rs/)
• WiX Toolset v3 (https://wixtoolset.org/releases/)

Build Steps

1. Clone the repository:

git clone https://github.com/LoreRealm/winman.git
cd winman

2. Build the executable:

cargo build --release

3. Build the MSI installer:

.\build_msi.ps1

Installation

From MSI

1. Download the latest winman.msi from Releases
2. Run the MSI installer
3. The installer will:
   • Install winman.exe to C:\Program Files\WinMan\
   • Install commands.json to C:\Program Files\WinMan\data\
   • Add the installation directory to your system PATH

From Source

After building, you can run the executable directly from:

target\release\winman.exe

Usage

After installation, you can run WinMan from any command prompt or PowerShell window:

USAGE
winman [command]

Display PowerShell command documentation in man page format.
Currently loaded: 714 commands

OPTIONS
-h, --help         Display this help message
-v, --version      Display the version number

EXAMPLES
winman Get-Process
winman Get-Service
winman Start-Process

NOTES
winman queries PowerShell's Get-Help to retrieve full documentation.
This may take a moment for the first query.

Project Structure

winman/
├── src/              # Rust source code
├── data/             # Data files (commands.json)
├── target/           # Build output (ignored by git)
├── winman.wxs        # WiX installer configuration
├── build_msi.ps1     # MSI build script
├── generate_commands.ps1  # Commands data generator
├── Cargo.toml        # Rust project configuration
└── README.md         # This file

Development

built entirely with Rust

Building

cargo build

Running Tests

cargo test

Creating a Release Build

cargo build --release

Building the Installer

.\build_msi.ps1

For a clean build:

.\build_msi.ps1 -Clean

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Author

Lorerealm