aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2019-11-02 20:27:51 +0100
committerTeddy Wing2019-11-02 20:27:51 +0100
commitf0e87f4e91bc60a7ab86dcd9819368082c102b82 (patch)
tree9a5d8be69926f140bb2516fc12acd22d0892c665
parent7395b7f6ebb5b18df8b410c8ded1af094019dd6e (diff)
downloadpdf-urls-f0e87f4e91bc60a7ab86dcd9819368082c102b82.tar.bz2
Add a man page
-rw-r--r--Makefile5
-rw-r--r--doc/pdf-urls.150
-rw-r--r--doc/pdf-urls.1.txt22
3 files changed, 77 insertions, 0 deletions
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 <http://docbook.sf.net/>
+.\" 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