doc/manpages/man1/megatron.1.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="megatron.1">
   3   <refmeta>
   4     <refentrytitle>megatron</refentrytitle>
   5
   6     <manvolnum>1</manvolnum>
   7
   8     <refmiscinfo class="date">02 Sep 2011</refmiscinfo>
   9
  10     <refmiscinfo class="source">@NETATALK_VERSION@</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="name">
  14     <refname>megatron</refname>
  15
  16     <refname>unhex</refname>
  17
  18     <refname>unbin</refname>
  19
  20     <refname>unsingle</refname>
  21
  22     <refname>hqx2bin</refname>
  23
  24     <refname>single2bin</refname>
  25
  26     <refname>macbinary</refname>
  27
  28     <refpurpose>Macintosh file format transformer</refpurpose>
  29   </refnamediv>
  30
  31   <refsynopsisdiv id="synopsis">
  32     <cmdsynopsis>
  33       <command>megatron<indexterm><primary>megatron</primary></indexterm></command>
  34
  35       <arg choice="opt" rep="repeat"><replaceable>sourcefile</replaceable></arg>
  36
  37       <sbr />
  38
  39       <command>unbin<indexterm><primary>unbin</primary></indexterm></command>
  40
  41       <arg choice="opt" rep="repeat"><replaceable>sourcefile</replaceable></arg>
  42
  43       <sbr />
  44
  45       <command>unhex<indexterm><primary>unhex</primary></indexterm></command>
  46
  47       <arg choice="opt" rep="repeat"><replaceable>sourcefile</replaceable></arg>
  48
  49       <sbr />
  50
  51       <command>unsingle<indexterm><primary>unsingle</primary></indexterm></command>
  52
  53       <arg choice="opt" rep="repeat"><replaceable>sourcefile</replaceable></arg>
  54
  55       <sbr />
  56
  57       <command>hqx2bin<indexterm><primary>hqx2bin</primary></indexterm></command>
  58
  59       <arg choice="opt" rep="repeat"><replaceable>sourcefile</replaceable></arg>
  60
  61       <sbr />
  62
  63       <command>single2bin<indexterm><primary>single2bin</primary></indexterm></command>
  64
  65       <arg choice="opt" rep="repeat"><replaceable>sourcefile</replaceable></arg>
  66
  67       <sbr />
  68
  69       <command>macbinary<indexterm><primary>macbinary</primary></indexterm></command>
  70
  71       <arg choice="opt" rep="repeat"><replaceable>sourcefile</replaceable></arg>
  72     </cmdsynopsis>
  73   </refsynopsisdiv>
  74
  75   <refsect1 id="description">
  76     <title>DESCRIPTION</title>
  77
  78     <para><command>megatron</command> is used to transform files from BinHex,
  79     MacBinary, AppleSingle, or <emphasis remap="B" role="bold">netatalk</emphasis> style
  80     AppleDouble formats into MacBinary or <emphasis remap="B">netatalk</emphasis>
  81     style AppleDouble formats. The <emphasis remap="B">netatalk</emphasis>
  82     style AppleDouble format is the file format used by <emphasis remap="B">afpd,</emphasis>
  83     the <emphasis remap="B">netatalk</emphasis> Apple Filing Protocol
  84     (AppleShare) server. BinHex, MacBinary, and AppleSingle are commonly used
  85     formats for transferring Macintosh files between machines via email or
  86     file transfer protocols. <command>megatron</command> uses its name to
  87     determine what type of transformation is being asked of it.</para>
  88
  89     <para>If <command>megatron</command> is called as <command>unhex</command>
  90     , <command>unbin</command> or <command>unsingle</command>, it tries to
  91     convert file(s) from BinHex, MacBinary, or AppleSingle into AppleDouble
  92     format. BinHex is the format most often used to send Macintosh files by
  93     e-mail. Usually these files have an extension of &#34;.hqx&#34;. MacBinary
  94     is the format most often used by terminal emulators &#34;on the fly&#34;
  95     when transferring Macintosh files in binary mode. MacBinary files often
  96     have an extension of &#34;.bin&#34;. Some Macintosh LAN-based email
  97     packages use uuencoded AppleSingle format to &#34;attach&#34; or
  98     &#34;enclose&#34; files in email. AppleSingle files don&#39;t have a
  99     standard filename extension.</para>
 100
 101     <para>If <command>megatron</command> is called as <command>hqx2bin</command>,
 102     <command>single2bin</command>, or <command>macbinary</command>, it will
 103     try to convert the file(s) from BinHex, AppleSingle, or AppleDouble into
 104     MacBinary. This last translation may be useful in moving Macintosh files
 105     from your <command>afpd</command> server to some other machine when you
 106     can&#39;t copy them from the server using a Macintosh for some reason.</para>
 107
 108     <para>If <command>megatron</command> is called with any other name, it
 109     uses the default translation, namely <command>unhex</command>.</para>
 110
 111     <para>If no source file is given, or if <emphasis remap="I">sourcefile</emphasis>
 112     is `<emphasis remap="" role="bold">-</emphasis>&#39;, and if the
 113     conversion is from a BinHex or MacBinary file, <command>megatron</command>
 114     will read from standard input.</para>
 115
 116     <para>The filename used to store any output file is the filename that is
 117     encoded in the source file. MacBinary files are created with a
 118     &#34;.bin&#34; extension. In the case of conflicts, the old file is
 119     overwritten!</para>
 120   </refsect1>
 121
 122   <refsect1 id="options">
 123     <title>OPTIONS</title>
 124
 125     <variablelist remap="TP">
 126       <varlistentry>
 127         <term><option>-v, --version</option></term>
 128
 129         <listitem>
 130           <para>Show version.</para>
 131         </listitem>
 132
 133       </varlistentry>
 134
 135     </variablelist>
 136   </refsect1>
 137
 138   <refsect1 id="see_also">
 139     <title>SEE ALSO</title>
 140
 141     <para><citerefentry><refentrytitle>afpd</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
 142   </refsect1>
 143 </refentry>