Skip to content

Commit

Permalink
Add man page
Browse files Browse the repository at this point in the history
  • Loading branch information
aarikpokras authored Nov 30, 2024
1 parent c32477c commit d17a062
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions man1/ebsl.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.TH EBSL 1 "2024-11-27" "1.0" "EBSL Man Page"
.SH NAME
EBSL \- Equals-based Serialization Language
.SH SYNOPSIS
\fBebsl\fR file=[file] key=[key] amt=[amount | max]
.SH OPTIONS

.TP
\fBfile\fR=\fIfile\fR
Set the file to read from
.TP
\fBkey\fR=\fIkey\fR
Set the key whose values to get
.TP
\fBamt\fR=\fIamount\fR
Set the amount of values to read. This can be an integer or "max".

.SH EXAMPLES

To get all values of the key "color" from the file rainbow.ebsl:
.br
ebsl file=rainbow.ebsl key=color amt=max
.sp
To get the first three values of the key "color" from the file rainbow.ebsl:
.br
ebsl file=rainbow.ebsl key=color amt=3

.SH BUGS
If you find a bug, please contact \fI[email protected]\fR or submit an issue on the GitHub page.
.SH SEE ALSO
\fIREGEX\fR(3), \fISTRING\fR(3)

0 comments on commit d17a062

Please sign in to comment.