linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2026-01-23 02:35:38 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(man): improved documentation

Browse source
This commit is contained in:
Hanashiko 2025-05-24 20:57:15 +03:00
commit 2eeb4a3b4a
1 changed files with 32 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

39
plugins/man/README.md
View file

@ -1,13 +1,38 @@
# Man plugin # Man Plugin
This plugin adds a shortcut to insert man before the previous command. This plugin provides a convenient shortcut to quickly view the manual (`man`) page for a command you've previously typed. It is especially useful when you're working in the terminal and want to look up usage details or options for a command without retyping it.
To use it, add `man` to the plugins array in your zshrc file: ## Features
- Automatically inserts `man` before the most recent command you've typed (or the one currently in the buffer).
- If the command includes a subcommand (e.g., `git commit`), the plugin attempts to open a more specific manual page like `git-commit`, if available.
- Smart fallback to the base command manual page if a more specific one doesn't exist.
- Works by pressing a simple keyboard shorcut: <kbd>Esc</kbd> then typing `man`.
## Installation
To enable this plugin, add `man` to the `plugins` array in your `.zshrc`:
```zsh ```zsh
plugins=(... man) plugins=(... man)
``` ```
# Keyboard Shortcuts
| Shortcut | Description | ## Keyboard Shortcut
|-----------------------------------|------------------------------------------------------------------------|
| <kbd>Esc</kbd> + man | add man before the previous command to see the manual for this command | | Shortcut | Description |
|------------------------|----------------------------------------------------------------------|
| <kbd>Esc</kbd> + `man` | Opens the man page for the previous or current command in the buffer |
## How It Works
- If no command is typed in the current buffer, the plugin uses the last command from history.
- If a command is already typed, it uses the contents of the buffer.
- If the buffer already start with `man`, the plguin does nothing (to avoid duplication).
- The plugin then tries to:
- Show the manual for a combined command and subcommand (e.g., `git-commit`),
- If that fails, it falls back to showing the manual for the base command (e.g., `git`).
For example:
```zsh
> git commit
# (then press <Esc> and type `man`)
# Result: opens the man page for git-commit if it exists, otherwise git
```