From c70bff172c5b99fac29252da25bb182e427d61d7 Mon Sep 17 00:00:00 2001
From: Anton Golub <antongolub@antongolub.com>
Date: Mon, 13 May 2024 19:49:29 +0300
Subject: [PATCH] docs: provide man page (#806)

Co-authored-by: Anton Medvedev <anton@medv.io>
---
 man/zx.1     | 40 ++++++++++++++++++++++++++++++++++++++++
 package.json |  3 ++-
 2 files changed, 42 insertions(+), 1 deletion(-)
 create mode 100644 man/zx.1

diff --git a/man/zx.1 b/man/zx.1
new file mode 100644
index 0000000000..b50131e88e
--- /dev/null
+++ b/man/zx.1
@@ -0,0 +1,40 @@
+.\" Manpage for zx.
+.TH man 8 "12 May 2024" "8.x" "zx man page"
+.SH NAME
+zx \- the zx CLI
+.SH DESCRIPTION
+A tool for writing better scripts.
+.SH SYNOPSIS
+.SS zx\fR [\fIOPTIONS\fR]  \fIURI\fR
+.SH OPTIONS
+.SS --quiet
+don't echo commands
+.SS --verbose
+Enables verbose mode
+.SS --shell=<path>
+Sets the shell to use
+.SS --prefix=<command>
+prefix all commands
+.SS --postfix=<command>
+postfix all commands
+.SS --eval=<js>, -e
+evaluate script
+.SS --install, -i
+install dependencies
+.SS --repl
+start repl
+.SS --version, -v
+print current zx version
+.SS --help, -h
+Print command help and options
+.SH EXAMPLES
+.TP
+.I zx --verbose script.js
+.TP
+.I zx https://example.com/script.js
+.TP
+.I zx -e '$`ls -l`'
+.SH BUGS
+https://github.com/google/zx/issues.
+.SH AUTHOR
+Anton Medvedev (https://medv.io/)
\ No newline at end of file
diff --git a/package.json b/package.json
index 6cb6f9facf..f4064a2f65 100644
--- a/package.json
+++ b/package.json
@@ -51,6 +51,7 @@
   "bin": {
     "zx": "./build/cli.js"
   },
+  "man": "./man/zx.1",
   "engines": {
     "node": ">= 12.17.0"
   },
@@ -123,7 +124,7 @@
   },
   "files": [
     "build",
-    "zx.js"
+    "man"
   ],
   "prettier": {
     "semi": false,