[SCM] mediaconch/master: Add manpages

hyperair at users.alioth.debian.org hyperair at users.alioth.debian.org
Sat Nov 28 14:27:55 UTC 2015


The following commit has been merged in the master branch:
commit 99d72b0b7cb439c3d5e81b3a8b94f6ec21896f1e
Author: Chow Loong Jin <hyperair at debian.org>
Date:   Sat Nov 28 20:58:33 2015 +0800

    Add manpages

diff --git a/debian/mediaconch-gui.manpages b/debian/mediaconch-gui.manpages
new file mode 100644
index 0000000..6712e55
--- /dev/null
+++ b/debian/mediaconch-gui.manpages
@@ -0,0 +1 @@
+debian/mediaconch-gui.1
diff --git a/debian/mediaconch-gui.pod b/debian/mediaconch-gui.pod
new file mode 120000
index 0000000..2da288e
--- /dev/null
+++ b/debian/mediaconch-gui.pod
@@ -0,0 +1 @@
+mediaconch.pod
\ No newline at end of file
diff --git a/debian/mediaconch.manpages b/debian/mediaconch.manpages
new file mode 100644
index 0000000..433087c
--- /dev/null
+++ b/debian/mediaconch.manpages
@@ -0,0 +1 @@
+debian/mediaconch.1
diff --git a/debian/mediaconch.pod b/debian/mediaconch.pod
new file mode 100644
index 0000000..da3bb87
--- /dev/null
+++ b/debian/mediaconch.pod
@@ -0,0 +1,115 @@
+=pod
+
+=head1 NAME
+
+MediaConch - implementation and policy checker, reporter and fixer for media files
+
+MediaInfo-Gui - implementation and policy checker, reporter and fixer for media files (graphical utility)
+
+=head1 SYNOPSIS
+
+=over
+
+=item mediaconch [F<-Options>...] F<FileName1> [F<Filename2>...]
+
+=item mediaconch-gui [F<-Options>...] F<FileName1> [F<Filename2>...]
+
+=back
+
+
+=head1 DESCRIPTION
+
+MediaConch is an extensible, open source software project consisting of an
+implementation checker, policy checker, reporter, and fixer that targets
+preservation-level audiovisual files (specifically Matroska, Linear Pulse Code
+Modulation (LPCM) and FF Video Codec 1 (FFV1)) for use in memory institutions,
+providing detailed and batch-level conformance checking via an adaptable and
+flexible application program interface accessible by the command line, a
+graphical user interface, or a web-based shell.
+
+=head1 OPTIONS
+
+MediaInfo supports the following case-insensitive options:
+
+=over
+
+=item B<--Help>, B<-h>
+
+Display help and exit
+
+=item B<--Help=Advanced>, B<-ha>
+
+Display the advanced help and exit
+
+=back
+
+=head2 Reporting Elements
+
+=over
+
+=item B<--Mediaconch>, B<-mc>
+
+Output MediaConch report (default)
+
+(MediaConch contains default verbosity of implementationChecks plus any provided
+policy checks.)
+
+=item B<--Mediainfo>, B<-mi>
+
+Output MediaInfo report
+
+=item B<--Mediatrace>, B<-mt>
+
+Output a trace of the file
+
+=back
+
+=head2 Policy Checker
+
+=over
+
+=item B<--Policy=PolicyFileName>, B<-p PolicyFileName>
+
+Apply the policy (XSL or Schematron)
+
+=back
+
+=head2 Output Formats
+
+=over
+
+=item B<--Format=text>, B<-ft>
+
+Output in Text format (default)
+
+=item B<--Format=xml>, B<-fx>
+
+Output in MediaInfo/MediaConch/MediaTrace XML format (changed to -fa if there
+are more than 1 tool or more than 1 file)
+
+=item B<--Format=maxml>, B<-fa>
+
+Output in MediaArea XML format
+
+=item B<--Format=html>, B<-fh>
+
+Output MediaConch report in HTML format
+
+=item B<--Display=DisplayFileName>, B<-d DisplayFileName>
+
+Apply the display transformation (XSL)
+
+=back
+
+=head1 AUTHOR
+
+This manual page was written by Chow Loong Jin <hyperair at debian.org> for the
+Debian system (but may be used by others). Permissions is granted to copy,
+distribute, and/or modify this document under the terms of the GNU General
+Public License, Version 3 or any later version published by the Free Software
+Foundation, or the Mozilla Public License 2.0.
+
+On Debian systems, the full text of the GNU General Public License, Version 3
+can be found in /usr/share/common-licenses/GPL-3.
+
+=cut
diff --git a/debian/rules b/debian/rules
index c97e3b7..19a1b1d 100755
--- a/debian/rules
+++ b/debian/rules
@@ -2,6 +2,8 @@
 
 export DEB_LDFLAGS_MAINT_APPEND = -Wl,-z,defs -Wl,--as-needed
 
+include /usr/share/dpkg/default.mk
+
 paths = \
 	Project/GNU/CLI/ \
 	Project/Qt/
@@ -30,6 +32,16 @@ override_dh_auto_install:
 override_dh_auto_clean:
 	$(call auto_build_cmd,dh_auto_clean)
 
+override_dh_installman: debian/mediaconch.1 debian/mediaconch-gui.1
+	dh_installman
+
 override_dh_installchangelogs:
 	dh_installchangelogs -p mediaconch History_CLI.txt
 	dh_installchangelogs -p mediaconch-gui History_GUI.txt
+
+clean:
+	rm -f debian/*.1
+	dh clean --with=autoreconf
+
+%.1: %.pod
+	pod2man --center "User Commands" --release=MediaConch\ $(DEB_VERSION_UPSTREAM) $< > $@

-- 
mediaconch packaging



More information about the pkg-multimedia-commits mailing list