Documentation

1 files changed, 40 insertions, 0 deletions

diff --git a/man/bib-ls.1 b/man/bib-ls.1
new file mode 100644
index 0000000..b0de33e
--- /dev/null
+++ b/man/bib-ls.1
@@ -0,0 +1,40 @@
+.TH BIB-LS 1 "June 2026" "bibutils" "User Commands"
+.SH NAME
+bib-ls \- list the entries in a bibtex database
+.SH SYNOPSIS
+.B bib-ls
+.RB [ \-l ]
+.RI [ file " ...]"
+.SH DESCRIPTION
+.B bib-ls
+reads bibtex databases from the named files (or standard input) and
+lists their entries on standard output, one per line.
+By default only the citation keys are printed.
+.SH OPTIONS
+.TP
+.B \-l
+Long format: print key, entry type, author, year and title,
+tab-separated.
+Author lists are abbreviated to the first author followed by
+\(lqet al.\(rq, so that the output remains one line per entry and
+pipes cleanly into
+.BR grep (1),
+.BR cut (1)
+and
+.BR sort (1).
+.SH EXIT STATUS
+0 on success.
+.SH ENVIRONMENT
+.TP
+.B BIBUTILS_LIB
+Directory holding the shared awk library, overriding the default
+search (lib/ next to the script, then /usr/local/share/bibutils).
+.SH EXAMPLES
+Find everything by Lamport in a database:
+.nf
+bib-ls -l refs.bib | grep -i lamport
+.fi
+.SH SEE ALSO
+.BR bib-check (1),
+.BR bib-extract (1),
+.BR bib-util (1)