From f0e87f4e91bc60a7ab86dcd9819368082c102b82 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Sat, 2 Nov 2019 20:27:51 +0100 Subject: Add a man page --- Makefile | 5 +++++ doc/pdf-urls.1 | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/pdf-urls.1.txt | 22 ++++++++++++++++++++++ 3 files changed, 77 insertions(+) create mode 100644 Makefile create mode 100644 doc/pdf-urls.1 create mode 100644 doc/pdf-urls.1.txt diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..201e839 --- /dev/null +++ b/Makefile @@ -0,0 +1,5 @@ +.PHONY: doc +doc: doc/pdf-urls.1 + +doc/pdf-urls.1: doc/pdf-urls.1.txt + a2x --no-xmllint --format manpage $< diff --git a/doc/pdf-urls.1 b/doc/pdf-urls.1 new file mode 100644 index 0000000..e58ad01 --- /dev/null +++ b/doc/pdf-urls.1 @@ -0,0 +1,50 @@ +'\" t +.\" Title: pdf-urls +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 11/02/2019 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "PDF\-URLS" "1" "11/02/2019" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +pdf-urls \- Extract URLs from a PDF file +.SH "SYNOPSIS" +.sp +\fBpdf\-urls\fR \fIFILE\fR +.SH "DESCRIPTION" +.sp +Extract all URLs from a PDF file and print them, one per line, to standard output\&. +.SH "EXAMPLES" +.sp +The following extracts URLs from the document \fIfile\&.pdf\fR and passes them to \fBurlview\fR to be opened in a browser: +.sp +.if n \{\ +.RS 4 +.\} +.nf +pdf\-urls file\&.pdf | urlview +.fi +.if n \{\ +.RE +.\} diff --git a/doc/pdf-urls.1.txt b/doc/pdf-urls.1.txt new file mode 100644 index 0000000..18ef69e --- /dev/null +++ b/doc/pdf-urls.1.txt @@ -0,0 +1,22 @@ +pdf-urls(1) +=========== + +NAME +---- +pdf-urls - Extract URLs from a PDF file + +SYNOPSIS +-------- +*pdf-urls* 'FILE' + +DESCRIPTION +----------- +Extract all URLs from a PDF file and print them, one per line, to +standard output. + +EXAMPLES +-------- +The following extracts URLs from the document 'file.pdf' and passes them +to *urlview* to be opened in a browser: + + pdf-urls file.pdf | urlview -- cgit v1.2.3