Skip to content

Commit fe3f012

Browse files
Improve script to update the text manpage
1 parent 1d8dfc2 commit fe3f012

File tree

5 files changed

+65
-90
lines changed

5 files changed

+65
-90
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ $ make uninstall
4747

4848
## Usage
4949

50-
Run `gh help` or read the manpage [right here](./docs/ascii_man).
50+
Run `gh help` or read the manpage [right here](./docs/text_man).
5151

5252
## Contributing
5353

docs/ascii_man

Lines changed: 0 additions & 85 deletions
This file was deleted.

docs/text_man

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
gh(1) User commands gh(1)
2+
3+
NAME
4+
gh - A minimal alternative to GitHub CLI.
5+
6+
DESCRIPTION
7+
gh is a CLI that works as an interface to github.com. It requires a browser for that and right now only Firefox is supported.
8+
9+
SYNOPSIS
10+
gh [COMMANDS] [OPTIONS]
11+
12+
COMMANDS
13+
gh-help
14+
Prints help.
15+
16+
gh-repo
17+
Open the repository page. When no option is provided, this command is used by default.
18+
19+
gh-pulls
20+
Open the pull request page of the current repository.
21+
22+
gh-newpr
23+
Open a pull request for the current repository.
24+
25+
GH-PULLS OPTIONS
26+
--open Only list open pull requests.
27+
28+
--closed
29+
Only list closed pull requests.
30+
31+
--author=<value>
32+
Filter pull requests by author. `@me` works as an alis to your Github username.
33+
34+
--to-review
35+
Filter pull requests awaiting review from you.
36+
37+
GH-NEWPR OPTIONS
38+
--dest-src=<dest_branch>...<src_branch>
39+
Select the destination branch and the source branch.
40+
41+
--template=<value>
42+
Select the template to be used in the PR description.
43+
44+
--title=<value>
45+
Define the PR title.
46+
47+
--assignees=<value1>,<value2>,<valueN>
48+
Define the PR assignees.
49+
50+
--labels=<value1>,<value2>,valueN>
51+
Define the PR labels.
52+
53+
FILES
54+
~/.local/bin/gh
55+
56+
~/.local/man/man1/gh.1.gz
57+
58+
AUTHOR
59+
Gustavo Ribeiro (grdev@tutanota.com)
60+
61+
0.1.0 07 Mar 2024 gh(1)

scripts/update_ascii_man.sh

Lines changed: 0 additions & 4 deletions
This file was deleted.

scripts/update_text_man.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
rm -f ./docs/text_man
2+
touch ./docs/text_man
3+
man ./docs/gh.1 | col -b > ./docs/text_man

0 commit comments

Comments
 (0)