aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2021-04-17 21:57:33 +0200
committerTeddy Wing2021-04-17 21:57:33 +0200
commit0e8e504e49ec57cabe7b33656066093bbe61be53 (patch)
tree6e53cb0632c44a6614808685b716f6f33fe22c7f
parent98799fdf302ce548dd2671d5fe3d667fe1bdebf4 (diff)
downloadformurapid-0e8e504e49ec57cabe7b33656066093bbe61be53.tar.bz2
Generate man page
-rw-r--r--Makefile7
-rw-r--r--doc/formurapid.188
2 files changed, 95 insertions, 0 deletions
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..6b86dcf
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,7 @@
+MAN_PAGE := doc/formurapid.1
+
+.PHONY: doc
+doc: $(MAN_PAGE)
+
+$(MAN_PAGE): $(MAN_PAGE).txt
+ a2x --no-xmllint --format manpage $<
diff --git a/doc/formurapid.1 b/doc/formurapid.1
new file mode 100644
index 0000000..21d160f
--- /dev/null
+++ b/doc/formurapid.1
@@ -0,0 +1,88 @@
+'\" t
+.\" Title: formurapid
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 04/17/2021
+.\" Manual: \ \&
+.\" Source: \ \&
+.\" Language: English
+.\"
+.TH "FORMURAPID" "1" "04/17/2021" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * 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"
+formurapid \- Fill in a PDF form using a text file
+.SH "SYNOPSIS"
+.sp
+\fIformurapid\fR [options] (\-\-generate | \-\-fill) \fIpdf_file\fR
+.SH "DESCRIPTION"
+.sp
+Fill in a PDF form based on the values in a TOML text file\&. This allows the values to be saved and reused\&. The TOML file can also be manipulated by external programs to calculate or fill in values in an interoperable format without having to directly manipulate the PDF\&.
+.sp
+First, generate the TOML file with:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+$ formurapid \-\-generate a\-form\&.pdf
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+This will produce two files: \fIa\-form\-ids\&.pdf\fR and \fIa\-form\&.toml\fR\&. The IDs PDF includes text fields filled in with their corresponding ID\&. The TOML file associates values with field IDs\&.
+.sp
+Once the TOML file is generated and stored in the same directory as \fIa\-form\&.pdf\fR, the form can be filled in with:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+$ formurapid \-\-fill a\-form\&.pdf
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+The above command generates a file \fIa\-form\-filled\&.pdf\fR, a version of \fIa\-form\&.pdf\fR with form fields filled using the values in \fIa\-form\&.toml\fR\&.
+.SH "OPTIONS"
+.PP
+\-\-fill
+.RS 4
+Fill in the input form based on a TOML file with the same file name stem in the same directory\&. The TOML file is generated with the
+\fI\-\-generate\fR
+argument\&.
+.RE
+.PP
+\-\-generate
+.RS 4
+Generate a TOML file to fill in the form as well as a copy of the PDF with IDs filled into the text fields\&.
+.RE
+.PP
+\-h, \-\-help
+.RS 4
+Print usage help\&.
+.RE
+.PP
+\-V, \-\-version
+.RS 4
+Print the program version\&.
+.RE