~taiite/protodump

2144bd777b9ee0b941a7c610f8cacebaeb9fdc5b — Hubert Hirtz 1 year, 5 months ago ab29a2c
update man page
1 files changed, 17 insertions(+), 3 deletions(-)

M doc/protodump.1.scd
M doc/protodump.1.scd => doc/protodump.1.scd +17 -3
@@ 16,6 16,12 @@ protodump - dumps object files in a header-like format
*-d, --diff BASELINE*
	Show the differences between BASELINE (another object file) and FILE.

	- Items in red (-) mean the type or function is in BASELINE but not in FILE,
	- Items in green (+) mean the type or function is in FILE but not in
	  BASELINE,
	- Items in yellow (~) mean the function's signature is the same, but one of
	  its types is different in both versions.

*-i, --imports*
	Take into account the list of imported symbols.  Imported symbols are
	symbols that are expected to come from another shared object.  They are


@@ 33,13 39,21 @@ protodump - dumps object files in a header-like format

protodump (for PROTOtype DUMPer) dumps object symbols that are found in debug
information (DWARF) of the same object.  The output format is made
human-readable, in a C-like header format.  It can be used in conjunction of
diff to detect changes in the object ABI.
human-readable, in a C-like header format.

protodump supports the following file formats, depending on your build
configuration:

- COFF (Common Object File Format),
- ELF (Executable and Linkable Format),
- Mach-O (Mach Object file format),
- PE (Portable Executable), and
- WASM (Web Assembly).

# NOTES

protodump use the *mmap*(3P) system call to read object files.  It is up to the
caller to ensure those files are not open during protodump lifetime.
caller to ensure those files are not open for writing during protodump lifetime.

# AUTHORS