Bech: /* Getting and installing apertium-c-formatters package */ Update for Git

2018-06-15T11:48:00Z

Getting and installing apertium-c-formatters package: Update for Git

Bech: Link to French page

2014-10-06T10:32:41Z

Link to French page

Bech: /* See also */ correcting external link

2012-10-18T12:03:32Z

Bech: Creating page

2012-10-18T10:43:30Z

Creating page

New page

'''Man pages''' format is not directly carried out by Apertium package. It is necessary to recover the package '''apertium-c-formatters''' to have a deformatter which takes into account specificities of this format.

== Getting and installing apertium-c-formatters package ==

If you did not already recover apertium-c-formatters package for [[translating mnemonic files]], let start by making the following operations:

Download apertium-c-formatters from SVN:
<pre>
svn checkout http://apertium.svn.sourceforge.net/svnroot/apertium/trunk/apertium-c-formatters
</pre>

Compile the source files:
<pre>
make
</pre>

Yes, compilation is very simple, and fast!

Install the tools:
<pre>
make install
</pre>

The above command assumes you have write access to <code>/usr/local/bin</code> and <code>/usr/local/share/man</code>. If not, enter the command:
<pre>
sudo make install
</pre>

By defaut, as for lttoolbox, apertium, and the language pairs, the installation is done in <code>/usr/local/bin</code> and <code>/usr/local/share</code>. If you wish to change the installation directory, you will have to change the first line of the ''makefile''.

<pre>
install_dir=/usr/local
</pre>

will be replaced by the parent directory where the executable commands will be. For example, if you put:

<pre>
install_dir=/usr
</pre>

tools will be installed in <code>/usr/bin</code> and man pages in <code>/usr/share/man</code> .

== Using ==

=== Available tools ===

Available tools to translate the man pages are the following:

* '''desman''' : deformatter for man pages,
* '''reman''' : generic reformatter used for man pages,
* '''apertium-man''' : a shell intended to make the translation of man pages easier.

=== Translation by calling the various tools ===

Assuming we are in the directory <code>/usr/share/man</code> and we want to translate into Spanish the English version of the man page of the command ''desman'' that will be copied directly at the good place. We can type:

<pre>
cat man1/desman.1 | desman | apertium -f none en-es | reman > es/man1/desman.1
</pre>

We can notice that the command <code>apertium</code> is executed with the <code>-f none</code> option, which is necessary for the deformatter <code>apertium-destxt</code> not to be used.

We can also give file names as parameters of the deformatter and the reformatter:

<pre>
desman man1/desman.1 | apertium -f none en-es | reman - es/man1/desman.1
</pre>

We can notice the dash '''<code>-</code>''' as the first parameter of <code>reman</code> . Reformatters usually use the standard input (in this case the result produced by the command <code>apertium</code>) whereas it can be useful to preserve the result of reformatting in a file. But the problem is the general syntax of apertium reformatters require to specify the output file as the 2nd parameter. The '''<code>-</code>''' as the first parameter permit to overcome this problem.

=== More simple with the command apertium-man ===

When a data format is integrated directly into the <code>apertium</code> command, there is the '''<code>-f</code>''' option to translate data produced in this format without having to call "by hand" a deformatter and a reformatter. The command <code>apertium-man</code> is a shell which permits to do in the same way.

For example, to translate into Esperanto the English version of the man page of the command ''apertium-man'' we can type:

<pre>
cat man1/apertium-man.1 | apertium-man en-eo > eo/man1/apertium-man.1
</pre>

or even better:

<pre>
apertium-man en-eo man1/apertium-man.1 eo/man1/apertium-man.1
</pre>

The options '''<code>-u</code>''' and '''<code>-d datadir</code>''' of the command <code>apertium</code> are caried out by <code>apertium-man</code>. You just have place them before the parameter indicating the translation direction (as for the command <code>apertium</code>).

== Characteristics of the deformatter for man pages ==

Some lines of man pages starts with a mnemonics in capital letters preceded by a period. We can find in particular:

* .TH
* .SH
* .TP
* .B
* .I
* .PP

These mnemonic relates to the page layout of the document and do not have to be modified during the translation. The deformatter <code>desman</code> mark as text to retain unchanged all beginnings of line starting with a period followed by one or more letters.

In addition, the commands described in a man page can accept options: generally a letter preceded by a '''<code>-</code>'''. To avoid the appearance of undesirable * (or even sometimes worse with some letters and some source languages), the deformatter <code>desman</code> mark as text to retain unchanged the '''<code>-</code>''' immediately followed (without space) of one or more alphanumerics characters.

== See also ==

[http://new.linuxfocus.org/English/November2003/article309.shtml- Documentation about man pages format]

[[Category:Formats]]
[[Category:Documentation in English]]

← Older revision		Revision as of 10:32, 6 October 2014
Line 1:		Line 1:
			[[Traduction des pages de man\|En français]]

	'''Man pages''' format is not directly carried out by Apertium package. It is necessary to recover the package '''apertium-c-formatters''' to have a deformatter which takes into account specificities of this format.		'''Man pages''' format is not directly carried out by Apertium package. It is necessary to recover the package '''apertium-c-formatters''' to have a deformatter which takes into account specificities of this format.

@@ Line 7: / Line 7: @@
 If you did not already recover apertium-c-formatters package for [[translating mnemonic files]], let start by making the following operations:
-Download apertium-c-formatters from SVN:
+Download apertium-c-formatters from GIT:
 <pre>
-svn checkout http://apertium.svn.sourceforge.net/svnroot/apertium/trunk/apertium-c-formatters
+git clone --depth 1 https://github.com/apertium/apertium-c-formatters
 </pre>

@@ Line 104: / Line 104: @@
 == See also ==
-[http://new.linuxfocus.org/English/November2003/article309.shtml- Documentation about man pages format]
+[http://new.linuxfocus.org/English/November2003/article309.shtml Documentation about man pages format]
 [[Category:Formats]]

Translating man pages - Revision history

Bech: /* Getting and installing apertium-c-formatters package */ Update for Git

Bech: Link to French page

Bech: /* See also */ correcting external link

Bech: Creating page