Git/gitea-tea
1
0
Fork 0
mirror of https://gitea.com/gitea/tea.git synced 2025-09-19 02:02:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

generate man page (#811)

Browse Source 
[CLI.md](src/branch/main/docs/CLI.md) already gets generated using `urfave/cli-docs`. `cli-docs` can also generate man pages.

This change extends the doc generator to also generate a man page for `tea`.

* Add a subcommand to the doc generator to print the generated man page to stdout

Closes #777.

Co-authored-by: Valentin Brandl <mail@vbrandl.net>
Reviewed-on: https://gitea.com/gitea/tea/pulls/811
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: TheFox0x7 <thefox0x7@noreply.gitea.com>
Co-authored-by: Valentin Brandl <vbrandl@noreply.gitea.com>
Co-committed-by: Valentin Brandl <vbrandl@noreply.gitea.com>
This commit is contained in:
Valentin Brandl
2025-09-14 00:17:28 +00:00
committed by Lunny Xiao
parent cc20b52ab3
commit 4f513ca3e3
4 changed files with 82 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -144,6 +144,21 @@ tea completion fish > ~/.config/fish/completions/tea.fish
Output the script to path/to/autocomplete/tea.ps1 an run it.
```
### Man Page
The hidden command `tea man` can be used to generate the `tea` man page.
```shell
# for bash or zsh
man <(tea man)
# for fish
man (tea man | psub)
# write man page to a file
tea man --out ./tea.man
```
## Compilation
Make sure you have a current go version installed (1.13 or newer).