blob: 761c49e4fb38e0da9ca7d95a3b20a420439f78c1 (
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<?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='po4adisplayman1' xml:lang="en">
<refentryinfo><date>2006-04-08</date></refentryinfo>
<refmeta>
<refentrytitle>PO4A-DISPLAY-MAN</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>2020-04-19</refmiscinfo>
<refmiscinfo class='source'>Po4a Tools</refmiscinfo>
<refmiscinfo class='manual'>Po4a Tools</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>po4a-display-man</refname>
<refpurpose>display a translated man page according to a PO</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>po4a-display-man</command>
<arg choice='plain'><option>-p</option> </arg>
<arg choice='plain'><replaceable>PO_FILE</replaceable></arg>
<arg choice='opt'><arg choice='plain'><option>-m</option> </arg><arg choice='plain'><replaceable>MASTER_FILE</replaceable></arg></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-man</command> to see
how their translation of a man page will be rendered to the end
users, without recompiling and reinstalling the whole project.</para>
<para>This script only works with man pages written directly in
<emphasis remap='I'>nroff</emphasis> and handled by the po4a's
<emphasis remap='I'>man</emphasis> module.
Manual pages generated from other formats, like DocBook or POD, are not
supported.
See <citerefentry><refentrytitle>po4a-display-pod</refentrytitle><manvolnum>1</manvolnum></citerefentry> for an equivalent supporting <emphasis remap='I'>POD</emphasis> documents.
</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>MASTER_FILE</replaceable></term>
<listitem>
<para>The original man page.
It can be the absolute or relative path to the original man page (gzipped
or not), the name of the man page or the name and section of the man page
(using the man.section format).
<!-- .br -->
When the master document is not provided with the <option>-m</option> option,
<command>po4a-display-man</command> tries to find the original man page
based on the line reference of the first string in the PO.</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-pod</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1 id='author'><title>AUTHOR</title>
<para>Thomas Huriaux</para>
</refsect1>
</refentry>
|
