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

Add manpage for dlopen-notes #34

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ all:

install:
install -m 755 -D dlopen-notes.py $(DESTDIR)/usr/bin/dlopen-notes
install -m 644 -D man/dlopen-notes.1 $(DESTDIR)/usr/share/man/man1/dlopen-notes.1

check:
make -C test check
Expand Down
1 change: 1 addition & 0 deletions debian/dh-dlopenlibdeps.manpages
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
debian/dh_dlopenlibdeps.1
usr/share/man/man1/dlopen-notes.1
36 changes: 36 additions & 0 deletions man/dlopen-notes.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.TH DLOPEN\-NOTES 1 "May 2024"
.SH NAME
dlopen\-notes \- parses dlopen elf metadata
.SH SYNOPSIS
.B dlopen\-notes
.RI [ OPTION ...]
.SH DESCRIPTION
ELF binaries store link-time dependencies in their headers, which can be parsed
by various tools. There is no machine-readable metadata about dependencies
loaded at build time via
.BR \%dlopen (3)
available by default. The ELF Dlopen Metadata specification aims to fill this
gap, by defining a common format.
.PP
This tool allows parsing such a note, and printing out the result in various
formats.
.SH OPTIONS
.TP
.BI \-\-raw
Show the original JSON extracted from input files
.TP
.BI \-\-sonames
List all sonames and their priorities, one soname per line
.TP
.BI \-\-features= [FEATURE...]
Print the description of the specified features
.TP
.BR \-h ", " \-\-help
Show a short help message and exit.
.SH SEE ALSO
.ad l
.nh
.BR dh\-dlopenlibdeps (1),
.UR https://systemd.io/ELF_DLOPEN_METADATA/
.B Dlopen Metadata for ELF Files
.UE