gil pushed to parquet (master). "add manpage"

notifications at fedoraproject.org notifications at fedoraproject.org
Sat Mar 28 03:58:41 UTC 2015


>From 6f5c0a28235fe44b9455f74b06fefc7c55734727 Mon Sep 17 00:00:00 2001
From: gil <puntogil at libero.it>
Date: Sat, 28 Mar 2015 04:58:27 +0100
Subject: add manpage


diff --git a/parquet-tools.xml b/parquet-tools.xml
new file mode 100644
index 0000000..c591e3d
--- /dev/null
+++ b/parquet-tools.xml
@@ -0,0 +1,193 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<refentry id="parquet-tools">
+  <refentryinfo>
+    <title>parquet-tools</title>
+    <productname>parquet-tools</productname>
+
+    <authorgroup>
+      <author>
+        <contrib></contrib>
+        <firstname>gil</firstname>
+        <surname></surname>
+        <email></email>
+      </author>
+    </authorgroup>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>parquet-tools</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>parquet-tools</refname>
+    <refpurpose>Java based command line tool that aid in the inspection of Parquet files.</refpurpose>
+  </refnamediv>
+
+  <refsect1>
+    <title>Description</title>
+    <para><command>parquet-tools</command></para>
+    <title>Options</title>
+
+    <para>The following options are understood:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>--debug</option></term>
+        <listitem><para>Disable color output even if supported.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-h,--help</option></term>
+        <listitem><para>Show this help string</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--no-color</option></term>
+        <listitem><para>Disable color output even if supported.</para></listitem>
+      </varlistentry>
+    </variablelist>
+
+  </refsect1>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>usage: parquet-tools cat</command>
+      <arg choice="opt" rep="repeat">OPTIONS</arg>
+      <arg choice="opt" rep="repeat">INPUT</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Options</title>
+
+    <para>The following options are understood:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>parquet-tools cat [option...] <constant>&#60;input&#62;</constant> </option></term>
+      </varlistentry>
+      <para>Where <constant>&#60;input&#62;</constant> is the parquet file to print to stdout.</para>
+    </variablelist>
+  </refsect1>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>usage: parquet-tools head</command>
+      <arg choice="opt" rep="repeat">OPTIONS</arg>
+      <arg choice="opt" rep="repeat">INPUT</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Options</title>
+
+    <para>The following options are understood:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>parquet-tools head [option...] <constant>&#60;input&#62;</constant> </option></term>
+      </varlistentry>
+
+      <para>Where <constant>&#60;input&#62;</constant> is the parquet file to print to stdout.</para>
+
+      <varlistentry>
+        <term><option>-n,--records <constant>&#60;arg&#62;</constant> </option></term>
+        <listitem><para>The number of records to show (default: 5)</para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>usage: parquet-tools schema</command>
+      <arg choice="opt" rep="repeat">OPTIONS</arg>
+      <arg choice="opt" rep="repeat">INPUT</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Options</title>
+
+    <para>The following options are understood:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>parquet-tools schema [option...] <constant>&#60;input&#62;</constant> </option></term>
+      </varlistentry>
+
+      <para>where <constant>&#60;input&#62;</constant> is the parquet file containing the schema to show.</para>
+
+      <varlistentry>
+        <term><option>-d,--detailed <constant>&#60;arg&#62;</constant> </option></term>
+        <listitem><para>Show detailed information about the schema.</para></listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>usage: parquet-tools meta</command>
+      <arg choice="opt" rep="repeat">OPTIONS</arg>
+      <arg choice="opt" rep="repeat">INPUT</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Options</title>
+
+    <para>The following options are understood:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>parquet-tools meta [option...] <constant>&#60;input&#62;</constant> </option></term>
+      </varlistentry>
+
+      <para>where <constant>&#60;input&#62;</constant> is the parquet file to print to stdout.</para>
+
+    </variablelist>
+  </refsect1>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>usage: parquet-tools dump</command>
+      <arg choice="opt" rep="repeat">OPTIONS</arg>
+      <arg choice="opt" rep="repeat">INPUT</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Options</title>
+
+    <para>The following options are understood:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>parquet-tools dump [option...] <constant>&#60;input&#62;</constant> </option></term>
+      </varlistentry>
+
+      <para>where <constant>&#60;input&#62;</constant> is the parquet file to print to stdout.</para>
+
+      <varlistentry>
+        <term><option>-c,--column <constant>&#60;arg&#62;</constant> </option></term>
+        <listitem><para>Dump only the given column, can be specified more than once.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-d,--disable-data </option></term>
+        <listitem><para>Do not dump column data.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-m,--disable-meta </option></term>
+        <listitem><para>Do not dump row group and page metadata.</para></listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+</refentry>
diff --git a/parquet.spec b/parquet.spec
index bb2918c..0edc9ba 100644
--- a/parquet.spec
+++ b/parquet.spec
@@ -9,6 +9,7 @@ URL:           http://parquet.io/
 # rm -r parquet-mr-parquet-1.5.0/doc/dremel_paper/*.png
 # tar czf parquet-mr-parquet-1.5.0-clean.tar.gz parquet-mr-parquet-1.5.0
 Source0:       %{name}-mr-%{name}-%{version}-clean.tar.gz
+Source1:       parquet-tools.xml
 
 BuildRequires: mvn(com.google.guava:guava)
 BuildRequires: mvn(com.twitter:parquet-format)
@@ -40,6 +41,8 @@ BuildRequires: mvn(junit:junit)
 BuildRequires: maven-local
 BuildRequires: buildnumber-maven-plugin
 BuildRequires: exec-maven-plugin
+BuildRequires: libxslt
+BuildRequires: docbook-style-xsl
 
 # Hadoop is not available on ARM
 ExcludeArch:   %{arm}
@@ -137,6 +140,14 @@ find . -name "*.class" -print -delete
 # No test deps
 %mvn_build -f
 
+xsltproc \
+  --nonet \
+  --stringparam man.output.quietly 1 \
+  --stringparam funcsynopsis.style ansi \
+  --stringparam man.authors.section.enabled 0 \
+  --stringparam man.copyright.section.enabled 0 \
+  http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl %{SOURCE1}
+
 %install
 %mvn_install
 
@@ -146,6 +157,9 @@ find . -name "*.class" -print -delete
 %jpackage_script parquet.tools.Main "" "" %{name}:%{name}-format:avalon-framework-api:avalon-logkit:commons-cli:commons-codec:commons-configuration:commons-lang:commons-logging:fastutil:geronimo-jms:guava:httpcomponents/httpclient:httpcomponents/httpcore:jackson/jackson-core-asl:jackson/jackson-mapper-asl:libthrift:log4j:javamail/mail:jboss-servlet-3.0-api:snappy-java:slf4j/slf4j-api:hadoop/hadoop-common:hadoop/hadoop-auth %{name}-tools true
 %endif
 
+mkdir -p %{buildroot}%{_mandir}/man1
+install -pm 644 parquet-tools.1 %{buildroot}%{_mandir}/man1/
+
 %files -f .mfiles
 %dir %{_javadir}/%{name}
 %doc CHANGES.md README.md
@@ -153,6 +167,7 @@ find . -name "*.class" -print -delete
 
 %files tools
 %{_bindir}/%{name}-tools
+%{_mandir}/man1/%{name}.*
 %doc %{name}-tools/README.md
 %license LICENSE %{name}-tools/NOTICE
 
-- 
cgit v0.10.2


	http://pkgs.fedoraproject.org/cgit/parquet.git/commit/?h=master&id=6f5c0a28235fe44b9455f74b06fefc7c55734727


More information about the scm-commits mailing list