Skip to content

Add documentation for hachoir-list tool #103

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

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Add documentation for hachoir-list tool #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Command line tools using Hachoir parsers:
* :ref:`hachoir-wx <wx>`: display the content of a binary file in GUI mode
* :ref:`hachoir-grep <grep>`: find a text pattern in a binary file
* :ref:`hachoir-strip <strip>`: modify a file to remove metadata
* :ref:`hachoir-list <list>`: print decoded content of a binary file

.. image:: images/urwid.png
:alt: hachoir-urwid screenshot (MP3 audio file)
Expand All @@ -37,6 +38,7 @@ User Guide
subfile
grep
strip
list


Developer Guide
Expand Down
45 changes: 45 additions & 0 deletions doc/list.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.. _list:

++++++++++++++++++++
hachoir-list program
++++++++++++++++++++

hachoir-list uses Hachoir to decode a binary file and then
prints out the decoded fields, so that the output can be processed
by other text-oriented tools.

Examples
========

Print all decoded fields::

$ hachoir-list cd_0008_5C48_1m53s.cda
signature <FixedString, 4B>: "RIFF"
filesize <UInt32, 4B>: 36 bytes
type <FixedString, 4B>: "CDDA"
cdda <ChunkCDDA, 32B>
tag <FixedString, 4B>: "fmt "
size <UInt32, 4B>: 24 bytes
cda_version <UInt16, 2B>: 1
track_no <UInt16, 2B>: 4
disc_serial <UInt32, 4B>: 0008-5C48
hsg_offset <UInt32, 4B>: 19477
hsg_length <UInt32, 4B>: 8507
rb_offset <RedBook, 4B>
frame <UInt8, 1B>: 52
second <UInt8, 1B>: 21
minute <UInt8, 1B>: 4
notused <PaddingBytes, 1B>: "\0"
rb_length <RedBook, 4B>
frame <UInt8, 1B>: 32
second <UInt8, 1B>: 53
minute <UInt8, 1B>: 1
notused <PaddingBytes, 1B>: "\0"

Other options:

* ``--description``: Show description for each field
* ``--indent-width``: Change (or disable) indentation
* ``--hide-value``: Don't display the string value
* ``--hide-size``: Don't display field size
* Get full option list using ``--help``
Loading