suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2025-01-23 14:16:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Man page wip

Browse Source
This commit is contained in:
Mike Farah 2021-10-15 09:59:08 +11:00
parent 0436b77d91
commit 948399f163
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pkg/yqlib/doc/headers/Main.md
View File

@ -1,9 +1,11 @@
# NAME
*yq* - Command-line yaml processor
*yq* is a portable command-line YAML processor (https://github.com/mikefarah/yq/)
# SYNOPSIS
a lightweight and portable command-line YAML processor. `yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml files as well as json. It doesn't yet support everything `jq` does - but it does support the most common operations and functions, and more is being added continuously.
This documentation is also available at https://mikefarah.gitbook.io/yq/.
# QUICK GUIDE
## Read a value:

2
scripts/genman.sh
View File

@ -18,4 +18,4 @@ for f in ./pkg/yqlib/doc/*.md; do
done
pandoc --variable=title:"yq" --variable=author:"Mike Farah" --standalone --to man man.md -o yq.1
pandoc --variable=title:"yq" --variable=section:"1" --variable=author:"Mike Farah" --standalone --to man man.md -o yq.1