Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add man page for prqlc #2033

Closed
wants to merge 5 commits into from
Closed

feat: Add man page for prqlc #2033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57aa64e
Create man page for prqlc
vanillajonathan Mar 6, 2023
d8d7841
Add prqlc man page
vanillajonathan Mar 6, 2023
9d62a48
Update and rename prql-compiler/prqlc.1 to prql-compiler/prqlc/prqlc.1
vanillajonathan Mar 6, 2023
b359169
Update release.yaml
vanillajonathan Mar 6, 2023
3f43869
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ jobs:
mkdir -p .debpkg/usr/bin
cp target/release/prqlc .debpkg/usr/bin/prqlc
chmod +x .debpkg/usr/bin/prqlc
mkdir -p .rpmpkg/usr/share/man
cp prql-compiler/prqlc/prqlc.1 .rpmpkg/usr/share/man
- name: 📦 Build .deb package
uses: jiro4989/build-deb-action@v2
with:
Expand All @@ -63,6 +65,8 @@ jobs:
mkdir -p .rpmpkg/usr/bin
cp target/release/prqlc .rpmpkg/usr/bin/prqlc
chmod +x .rpmpkg/usr/bin/prqlc
mkdir -p .rpmpkg/usr/share/man
cp prql-compiler/prqlc/prqlc.1 .rpmpkg/usr/share/man
- name: 📦 Build .rpm package
uses: jiro4989/build-rpm-action@v2
with:
Expand Down
92 changes: 92 additions & 0 deletions prql-compiler/prqlc/prqlc.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
.\" prqlc man page.
.\"
.\" PRQL is a modern language for transforming data — a simple, powerful,
.\" pipelined SQL replacement.
.\"
.\" https://prql-lang.org/
.Dt prqlc 1
.Os Linux
.Sh NAME
.Nm prqlc
.And PRQL compiler.
.Sh SYNOPSIS
.Pp
.SY prqlc
parse
.Op Ar input
.Op Ar output
.YS
.Pp
.SY prqlc
fmt
.Op Ar input
.Op Ar output
.YS
.Pp
.SY prqlc
annotate
.Op Ar input
.Op Ar output
.YS
.Pp
.SY prqlc
debug
.Op Ar input
.Op Ar output
.YS
.Pp
.SY prqlc
resolve
.Op Ar input
.Op Ar output
.YS
.Pp
.SY prqlc
compile
.Op Ar options
.Op Ar input
.Op Ar output
.YS
.Pp
.SY prqlc
watch
.Op Ar options
path
.YS
.Pp
.SY prqlc
help
.YS
.Pp
.Sh DESCRIPTION
PRQL is a modern language for transforming data — a simple, powerful,
pipelined SQL replacement.
.Pp
Flags:
.Bl -tag
.It Fl h
Print help
.It Fl v
Print version
.El
.Pp
Flags for the compile option:
.Bl -tag
.It Fl -no-format
do not format the output
.It Fl -no-signature
do not print the PRQL signature
.El
.Sh FILES \" File used or created by the topic of the man page
.Bl -tag
.It Pa /usr/bin/prqlc
The
.Nm
executable.
.Sh DIAGNOSTICS
.Nm
returns zero on normal operation, 1 on error.
.Sh BUGS
Report any bugs on https://github.com/PRQL/prql/issues
.Sh AUTHOR
PRQL team