aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2021-04-17 21:54:52 +0200
committerTeddy Wing2021-04-17 21:54:52 +0200
commit98799fdf302ce548dd2671d5fe3d667fe1bdebf4 (patch)
tree06202c4bb1140bfe7558716973eca6995db56a31
parent8a10f52ebdf514a798e1f38e8d568327902f9b9d (diff)
downloadformurapid-98799fdf302ce548dd2671d5fe3d667fe1bdebf4.tar.bz2
doc/formurapid.1.txt: Add manual description
-rw-r--r--doc/formurapid.1.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/formurapid.1.txt b/doc/formurapid.1.txt
index a409695..596d7aa 100644
--- a/doc/formurapid.1.txt
+++ b/doc/formurapid.1.txt
@@ -11,6 +11,26 @@ SYNOPSIS
DESCRIPTION
-----------
+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.
+
+First, generate the TOML file with:
+
+ $ formurapid --generate a-form.pdf
+
+This will produce two files: 'a-form-ids.pdf' and 'a-form.toml'. The IDs PDF
+includes text fields filled in with their corresponding ID. The TOML file
+associates values with field IDs.
+
+Once the TOML file is generated and stored in the same directory as
+'a-form.pdf', the form can be filled in with:
+
+ $ formurapid --fill a-form.pdf
+
+The above command generates a file 'a-form-filled.pdf', a version of
+'a-form.pdf' with form fields filled using the values in 'a-form.toml'.
OPTIONS
-------