summaryrefslogtreecommitdiffstats
path: root/share/doc/po4a-display-pod.xml
blob: 4c3a805cd12fc001550cb25f32153b0d8c56dc0c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
                   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='po4adisplaypod1' xml:lang="en">
<refentryinfo><date>2009-03-16</date></refentryinfo>
<refmeta>
<refentrytitle>PO4A-DISPLAY-POD</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>2009-03-16</refmiscinfo>
<refmiscinfo class='source'>Po4a Tools</refmiscinfo>
<refmiscinfo class='manual'>Po4a Tools</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>po4a-display-pod</refname>
<refpurpose>display of a translated POD file according to a PO</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
  <command>po4a-display-pod</command>
    <arg choice='plain'><option>-p </option></arg>
    <arg choice='plain'><replaceable>PO_FILE</replaceable></arg>
    <arg choice='plain'><option>-m </option></arg>
    <arg choice='plain'><replaceable>POD_FILE</replaceable></arg>
    <arg choice='opt'><arg choice='plain'><option>-o </option></arg><arg choice='plain'><replaceable>PO4A_OPT</replaceable></arg></arg>
    <sbr/>
</cmdsynopsis>
</refsynopsisdiv>


<refsect1 id='description'><title>DESCRIPTION</title>
<para>Translators can use <command>po4a-display-pod</command> to see
how their translation of a man page will be rendered to the end
users, without recompiling and reinstalling the whole project.
Most of the time, the POD file is only available in source package or
embedded in Perl script.</para>
</refsect1>

<refsect1 id='options'><title>OPTIONS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><option>-p </option><replaceable>PO_FILE</replaceable></term>
  <listitem>
<para>The PO file containing the translations.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-m </option><replaceable>POD_FILE</replaceable></term>
  <listitem>
<para>The original POD file used by po4a to generate PO file.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-o </option><replaceable>PO4A_OPT</replaceable></term>
  <listitem>
<para>Some options to pass to <citerefentry><refentrytitle>po4a-translate</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>
  <citerefentry>
    <refentrytitle>po4a-display-man</refentrytitle><manvolnum>1</manvolnum>
  </citerefentry>
</para>
</refsect1>

<refsect1 id='author'><title>AUTHOR</title>
<para>Florentin Duneau</para>
</refsect1>
</refentry>