Package: gscan2pdf Version: 2.11.0-1 Severity: minor Tags: upstream patch Hi,
please find attached a patch for the POD part & manual page of gscan2pdf, which brings it more in line with other manual pages The patch is against upstream version 2.11.2. Please consider including it in one of the future versions of gscan2pdf Peter -- System Information: Debian Release: bullseye/sid APT prefers testing APT policy: (990, 'testing'), (500, 'unstable'), (500, 'stable'), (1, 'experimental') Architecture: amd64 (x86_64) Kernel: Linux 5.10.0-5-amd64 (SMP w/12 CPU threads) Kernel taint flags: TAINT_CRAP Locale: LANG=de_DE.UTF-8, LC_CTYPE=de_DE.UTF-8 (charmap=UTF-8), LANGUAGE=en_GB Shell: /bin/sh linked to /usr/bin/dash Init: systemd (via /run/systemd/system) LSM: AppArmor: enabled Versions of packages gscan2pdf depends on: ii imagemagick 8:6.9.11.60+dfsg-1 ii imagemagick-6.q16 [imagemagick] 8:6.9.11.60+dfsg-1 ii libconfig-general-perl 2.63-1 ii libdate-calc-perl 6.4-1.1 ii libfilesys-df-perl 0.92-6+b6 ii libgoocanvas2-perl 0.06-2 ii libgtk3-imageview-perl 6-1 ii libgtk3-perl 0.038-1 ii libgtk3-simplelist-perl 0.21-1 ii libhtml-parser-perl 3.75-1+b1 ii libimage-magick-perl 8:6.9.11.60+dfsg-1 ii libimage-sane-perl 5-1+b1 ii liblist-moreutils-perl 0.430-2 ii liblocale-codes-perl 3.66-1 ii liblocale-gettext-perl 1.07-4+b1 ii liblog-log4perl-perl 1.54-1 ii libossp-uuid-perl [libdata-uuid-perl] 1.6.2-1.5+b9 ii libpdf-builder-perl 3.021-2 ii libproc-processtable-perl 0.59-2+b1 ii libreadonly-perl 2.050-3 ii librsvg2-common 2.50.3+dfsg-1 ii libset-intspan-perl 1.19-1.1 ii libtiff-tools 4.2.0-1 ii libtry-tiny-perl 0.30-1 hi sane-utils 1.0.31-4pm1 Versions of packages gscan2pdf recommends: ii djvulibre-bin 3.5.28-1 ii gocr 0.52-3 ii pdftk-java [pdftk] 3.2.2-1 ii tesseract-ocr 4.1.1-2.1 ii unpaper 6.1-2+b2 ii xdg-utils 1.1.3-4 gscan2pdf suggests no packages. -- no debconf information
From 951566125ec98859f80b510fcec254aa85d3ffc6 Mon Sep 17 00:00:00 2001 From: Peter Marschall <pe...@adpm.de> Date: Sun, 10 Mar 2019 09:52:43 +0100 Subject: [PATCH] gscan2pdf: man pages updates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * use ยด=over 4' as specified by perlpod to get correct indentation * add empty lines after '=item' entries for correct separation and display of the itemized lists in POD and manual pages * mark command line options in bold, and file arguments as files to visually separate them from surrounding text * '=item'ize %-variables to display them nicely as lists * indent verbatim text to display it as code Signed-off-by: Peter Marschall <pe...@adpm.de> --- bin/gscan2pdf | 123 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 86 insertions(+), 37 deletions(-) diff --git a/bin/gscan2pdf b/bin/gscan2pdf index 42d82c7c..f0b630a8 100755 --- a/bin/gscan2pdf +++ b/bin/gscan2pdf @@ -7473,7 +7473,7 @@ gscan2pdf - A GUI to produce PDFs or DjVus from scanned documents =head1 USAGE -=over +=over 4 =item 1. Scan one or several pages in with File/Scan @@ -7489,29 +7489,36 @@ None gscan2pdf has the following command-line options: -=over +=over 4 + +=item B<--device>=F<device> -=item --device=<device> Specifies the device to use, instead of getting the list of devices from via the SANE API. This can be useful if the scanner is on a remote computer which is not broadcasting its existence. -=item --help +=item B<--help> + Displays this help page and exits. -=item --log=<log file> +=item B<--log>=F<log-file> + Specifies a file to store logging messages. -=item --(debug|info|warn|error|fatal) -Defines the log level. If a log file is specified, this defaults to 'debug', otherwise 'warn'. +=item B<--debug>, B<--info>, B<--warn>, B<--error>, B<--fatal> + +Defines the log level. +If a log file is specified, this defaults to B<--debug>, otherwise B<--error>. + +=item B<--import>=F<PDF|DjVu|images> -=item --import=<PDF|DjVu|images> Imports the specified file(s). If the document has more than one page, a window is displayed to select the required pages. -=item --import-all=<PDF|DjVu|images> +=item B<--import-all>=F<PDF|DjVu|images> Imports all pages of the specified file(s). -=item --version +=item B<--version> + Displays the program version and exits. =back @@ -7527,7 +7534,7 @@ To diagnose a possible error, start gscan2pdf from the command line with logging C<gscan2pdf --log=file.log> -and check file.log. +and check F<file.log>. =head1 EXIT STATUS @@ -7535,7 +7542,7 @@ None =head1 CONFIGURATION -gscan2pdf creates a text resource file in ~/.config/gscan2pdfrc. The directory +gscan2pdf creates a text resource file in F<~/.config/gscan2pdfrc>. The directory can be changed by setting the $XDG_CONFIG_HOME variable. Generally, however, preferences should be changed via the Edit/Preferences menu, or are captured automatically during normal usage of the program. @@ -7556,8 +7563,8 @@ gscan2pdf is available on Sourceforge =head2 Debian-based -If you are using Debian, you should find that sid has the latest version already -packaged. +If you are using Debian, you should find that L<sid|https://www.debian.org/releases/sid/> +has the latest version already packaged. If you are using a Ubuntu-based system, you can automatically keep up to date with the latest version via the ppa: @@ -7613,11 +7620,11 @@ install them under I<Recommends>. Note also that the library names given below are the Debian/Ubuntu ones. Those distributions using RPM typically use perl(module) where Debian has libmodule-perl. -=over +=over 4 =item Required -=over +=over 4 =item libgtk3-perl >= 0.028 @@ -7669,7 +7676,7 @@ API library for scanners -- utilities. =item Optional -=over +=over 4 =item sane @@ -7712,7 +7719,7 @@ A command line OCR. See L<http://launchpad.net/cuneiform-linux> There are two mailing lists for gscan2pdf: -=over +=over 4 =item gscan2pdf-announce @@ -7734,7 +7741,7 @@ Please report any bugs found, preferably against the Debian package[1][2]. You do not need to be a Debian user, or set up an account to do this. The Debian tool "reportbug" provides a convenient GUI for doing so. -=over +=over 4 =item 1. https://packages.debian.org/sid/gscan2pdf @@ -7808,7 +7815,7 @@ whether the page number is incremented or decremented by 2. To scan both sides of three pages, i.e. 6 sides: -=over +=over 4 =item 1. Select: @@ -7842,7 +7849,7 @@ correct order. These, naturally, depend on your scanner. They can include -=over +=over 4 =item Page size. @@ -7975,15 +7982,39 @@ name as listed in the scan window, e.g. Noname Integrated_Webcam_HD. All strftime codes (e.g. %Y for the current year) are available as variables, with the following additions: - %Da author - %De filename extension - %Dt title +=over 4 + +=item B<%Da> + +author + +=item B<%De> + +filename extension + +=item B<%Dt> + +title + +=back All document date codes use strftime codes with a leading D, e.g.: - %DY document year - %Dm document month - %Dd document day +=over 4 + +=item B<%DY> + +document year + +=item B<%Dm> + +document month + +=item B<%Dd> + +document day + +=back =head2 View @@ -8048,7 +8079,7 @@ Up to v2.04, the only way to tell which languages were available to tesseract was to look for the language files. Therefore, gscan2pdf checks the path returned by: - tesseract '' '' -l '' +C<tesseract '' '' -l ''> If there are no language files in the above location, then gscan2pdf assumes that tesseract v1.0 is installed, which had no language files. @@ -8057,11 +8088,23 @@ assumes that tesseract v1.0 is installed, which had no language files. The following variables are available: - %i input filename - %o output filename - %r resolution +=over 4 + +=item B<%i> + +input filename + +=item B<%o> + +output filename + +=item B<%r> + +resolution -An image can be modified in-place by just specifying %i. +=back + +An image can be modified in-place by just specifying B<%i>. =head1 FAQs @@ -8128,24 +8171,30 @@ function will typically find the page with the requested text and highlight it. There are various tools for searching or indexing files, including PDF and DJVU: -=over +=over 4 =item * + (meta) Tracker (L<https://projects.gnome.org/tracker/>) =item * + plone (L<http://plone.org/>) =item * + pdfgrep (L<http://pdfgrep.sourceforge.net/> =item * + swish-e (L<http://www.swish-e.org/>) =item * + recoll (L<http://www.lesbonscomptes.com/recoll/>) =item * + terrier (L<http://www.lesbonscomptes.com/recoll/>) =back @@ -8167,9 +8216,9 @@ Create a file called C<~/.config/gtk-3.0/gtk.css> with the following content: Create a file called C<~/.config/gtk-3.0/gtk.css> with the following content: -#gscan2pdf-ocr-output { - color: black; -} + #gscan2pdf-ocr-output { + color: black; + } =head1 See Also @@ -8183,7 +8232,7 @@ Jeffrey Ratcliffe (jffry at posteo dot net) =head1 Thanks to -=over +=over 4 =item * all the people who have sent patches, translations, bugs and feedback. -- 2.30.2
