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

Check manpage in git #36

Merged
merged 3 commits into from
May 22, 2024
Merged
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
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@ all:

dlopen-notes.1: dlopen-notes.py docs/dlopen-description.man Makefile
argparse-manpage \
--output=$@ \
--output=docs/$@ \
--pyfile=$< \
--function=make_parser \
--project-name=package-notes \
--include=docs/dlopen-description.man

install:
install -m 755 -D dlopen-notes.py $(DESTDIR)/usr/bin/dlopen-notes
install -m 644 -D docs/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
38 changes: 38 additions & 0 deletions docs/dlopen-notes.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
.TH DLOPEN\-NOTES.PY "1" "2024\-05\-22" "package\-notes" "Generated Python Manual"
.SH NAME
dlopen\-notes.py
.SH SYNOPSIS
.B dlopen\-notes.py
[-r] [-s] [-f [FEATURE1,FEATURE2]] [-h] filename [filename ...]
.SH DESCRIPTION
Read .note.dlopen notes from ELF files and report the contents.
.PP
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.

.TP
\fBfilename\fR
Library file to extract notes from

.SH OPTIONS
.TP
\fB\-r\fR, \fB\-\-raw\fR
Show the original JSON extracted from input files

.TP
\fB\-s\fR, \fB\-\-sonames\fR
List all sonames and their priorities, one soname per line

.TP
\fB\-f\fR \fI\,[FEATURE1,FEATURE2]\/\fR, \fB\-\-features\fR \fI\,[FEATURE1,FEATURE2]\/\fR
Describe features, can be specified multiple times

.SH COMMENTS
If no option is specifed, \-\-raw is the default.