From eae6a43d23c8cb0969e31282a827d61b4efc07ad Mon Sep 17 00:00:00 2001 From: Zaraksh Rahman Date: Fri, 8 Sep 2023 16:57:16 +0100 Subject: [PATCH] Add examples below synopsis --- doc/fq.1 | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/fq.1 b/doc/fq.1 index 4ceffad9..d8a29b1a 100644 --- a/doc/fq.1 +++ b/doc/fq.1 @@ -6,6 +6,24 @@ fq \- jq for binary formats .SH SYNOPSIS \fBfq\fR [\fI\,OPTION\/\fR]... [--] \fI\,EXPR [\fI\,FILE\/\fR]... +\fBfq\fR . + +\fBfq\fR d + +\fBfq\fR -V '.path[1].value' + +\fBfq\fR tovalue + +\fBfq\fR -r to_toml file.yml + +\fBfq\fR -s -d html 'map(.html.head.title?)' *.html + +\fBfq\fR file.cbor | fq -d cbor torepr + +\fBfq\fR 'grep("^main$") | parent' /bin/ls + +\fBfq\fR -i + .SH DESCRIPTION \fBfq\fR is inspired by the well known jq tool and language that allows you to work with binary formats the same way you would using jq. In addition it can present data like a hex viewer, transform, slice and concatenate binary data. It also supports nested formats and has an interactive REPL with auto-completion. .P