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.

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

Question: PDF manual #2402

Closed
ivanperez-keera opened this issue Jan 27, 2022 · 5 comments
Closed

Question: PDF manual #2402

ivanperez-keera opened this issue Jan 27, 2022 · 5 comments
Labels

Comments

@ivanperez-keera
Copy link

ivanperez-keera commented Jan 27, 2022

I find reading the web manual really hard. Just the idea of traversing the documentation using a web seems like a steep hill to me.

Is there a manual in PDF I can download, or a book I can buy?

Thanks.

@emanuele6
Copy link
Member

$ man -Tpdf jq > jq_manual.pdf
$ xdg-open jq_manual.pdf

@pkoppstein
Copy link
Contributor

If you are looking for documentation that is strictly linear, then perhaps one or both of the following will be of interest to you, though neither is as comprehensive as the official manual:

  1. https://github.com/stedolan/jq/wiki/jq-Language-Description

  2. https://github.com/pkoppstein/jq/wiki/A-Stream-oriented-Introduction-to-jq


Disclaimer: I am the author of (2).

@wader
Copy link
Member

wader commented Jan 28, 2022

@pkoppstein Thanks for (2), very well written article. I will surely use it and link people to it.
I've thought about writing some kind of "practical jq" article that walks thru some use cases, simliar to a practical fq article that i'm working on https://github.com/wader/fq/blob/f6f48cba3bcd22705cb8c391ed4a050a42b57824/doc/guides/fra-pcap-challenge-2021-09/README.md

@pkoppstein
Copy link
Contributor

@wader - Comments and suggestions re 2 are welcome. Tx.

Anyone interested in a (linear) collection of practical (for the most part) applications of jq might find the jq Cookbook useful - https://github.com/stedolan/jq/wiki/Cookbook

For a (nonlinear) collection of more than 800 examples, see https://rosettacode.org/wiki/Category:Jq

@itchyny itchyny added the docs label Jun 3, 2023
@itchyny
Copy link
Contributor

itchyny commented Jul 31, 2023

Although we don't provide a PDF manual, you can build from the man page as suggested above, and you can also use browser to print the page to a PDF file. I actually redesigned the manual page carefully for printer users in #2628.

@itchyny itchyny closed this as completed Jul 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants