Skip to content

Commit c70bff1

Browse files
docs: provide man page (#806)
Co-authored-by: Anton Medvedev <anton@medv.io>
1 parent 73e3e1d commit c70bff1

File tree

2 files changed

+42
-1
lines changed

2 files changed

+42
-1
lines changed

man/zx.1

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.\" Manpage for zx.
2+
.TH man 8 "12 May 2024" "8.x" "zx man page"
3+
.SH NAME
4+
zx \- the zx CLI
5+
.SH DESCRIPTION
6+
A tool for writing better scripts.
7+
.SH SYNOPSIS
8+
.SS zx\fR [\fIOPTIONS\fR] \fIURI\fR
9+
.SH OPTIONS
10+
.SS --quiet
11+
don't echo commands
12+
.SS --verbose
13+
Enables verbose mode
14+
.SS --shell=<path>
15+
Sets the shell to use
16+
.SS --prefix=<command>
17+
prefix all commands
18+
.SS --postfix=<command>
19+
postfix all commands
20+
.SS --eval=<js>, -e
21+
evaluate script
22+
.SS --install, -i
23+
install dependencies
24+
.SS --repl
25+
start repl
26+
.SS --version, -v
27+
print current zx version
28+
.SS --help, -h
29+
Print command help and options
30+
.SH EXAMPLES
31+
.TP
32+
.I zx --verbose script.js
33+
.TP
34+
.I zx https://example.com/script.js
35+
.TP
36+
.I zx -e '$`ls -l`'
37+
.SH BUGS
38+
https://github.com/google/zx/issues.
39+
.SH AUTHOR
40+
Anton Medvedev (https://medv.io/)

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
"bin": {
5252
"zx": "./build/cli.js"
5353
},
54+
"man": "./man/zx.1",
5455
"engines": {
5556
"node": ">= 12.17.0"
5657
},
@@ -123,7 +124,7 @@
123124
},
124125
"files": [
125126
"build",
126-
"zx.js"
127+
"man"
127128
],
128129
"prettier": {
129130
"semi": false,

0 commit comments

Comments
 (0)