Reference

htmltodoc(1)

convert HTML source to PalmOS-ready e-text

NAME

htmltodoc - convert HTML source to PalmOS-ready e-text

SYNOPSIS

htmltodoc [OPTIONS ...] FILES ...

DESCRIPTION

This manual page documents htmltodoc, a utility for creating e-texts for perusal on a PalmOS device (3Com/USR/Palm Computing PalmPilot, IBM WorkPad, etc.), using standard e-text reader software.

Input to htmltodoc is in the form of HTML source. For each input file or URL (http and ftp are supported), htmltodoc outputs a PalmOS database, ready to install and read with any one of the popular document readers or editors.

The Doc format is a representation of plain text; therefore, the result of this conversion is the content of the HTML source with all tags stripped and a few simple bits of formatting applied.

OPTIONS

-h, --help

Show summary of options.

-t STRING, --title STRING

Set the title of the output document. If no title is supplied, the title of the HTML page will be used.

-b, --backup

Set the backup bit in the output document.

-c NUM, --category NUM

Set the category of the output document. The category must be specified as a number from 0 (Unfiled) to 15.

--creator ID

Set the creator ID of the document. The default is "REAd", which is the standard DOC creator ID. TealDoc uses "TlDc".

--type ID

Set the database type of the document. The default is "TEXt"; no others are known to be used at this time.

-T

Set several TealDoc compatibility options; equivalent to "--teal-headers --teal-wrap-headers --teal-hrules --creator 'TlDc'".

-I

Install documents directly onto a connected PalmPilot instead of writing them to the local disk.

-p PORT

Specify the port to which the PalmPilot is connected; the default is /dev/pilot.

--no-anchor-bookmarks

Normally, named anchors are bookmarked as they are encountered, on the general principle that if a spot is important enough to link to, it is a likely spot for a bookmark. This option turns that behavior off.

--no-links

Normally, links are marked with a numbered footnote indicator, and their targets are included in a section at the end of the document. This options turns that behavior off.

--teal-headers

Convert HTML <H1> through <H6> elements to TealDoc <HEADER> tags, in a variety of different styles.

--teal-wrap-headers

Current versions of TealDoc do not wordwrap <HEADER> tags; instead, they are cut off at the edge of the screen. With this option, long headers are wrapped into multiple <HEADER> tags so they are entirely readable when viewed in TealDoc.

--teal-hrules

Convert HTML <HR> elements to TealDoc <HRULE> tags. Without this option, horizontal rules are simulated by a string of punctuation (usually asterisks).

--teal-links

Attempt to use TealDoc features for intra-document linking. When a named anchor is encountered, a TealDoc <LABEL> tag is inserted; anchors which target the current document (i.e. HREF beginning with an octothorpe) are annotated with a <LINK> tag. This option is experimental, and is not automatically turned on by the -T (TealDoc) switch.

--teal-bookmarks

Use TealDoc <BOOKMARK> tags instead of setting bookmarks directly into the database. Since the latter method saves space in the file and doesn't require that the document be scanned, it is unlikely that you will need this option; it is included only for completeness, and is not turned on automatically by the -T switch.

HTML ENTITY SUPPORT

This program supports the Palm extended character set using HTML entities. In addition to the standard ISO-8859-1 entities supported by HTML, htmltodoc also supports the following entities, named according to the HTML4 DTD:

&OElig;

Uppercase OE ligature

&oelig;

Lowercase oe ligature

&Scaron;

Uppercase S with caron

&scaron;

Lowercase s with caron

&Yuml;

Uppercase Y with umlaut

&circ;

Circumflex

&tilde;

Small tilde

&ndash;

En dash

&mdash;

Em dash

&lsquo;

Left single quotation mark

&rsquo;

Right single quotation mark

&ldquo;

Left double quotation mark

&rdquo;

Right double quotation mark

&dagger;

Dagger

&Dagger;

Double dagger

&permil;

Per-mille sign

&lsaquo;

Left single angle quotation mark

&rsaquo;

Right single angle quotation mark

&fnof;

Latin lowercase f with hook (mathematical function definition)

&bull;

Bullet

&hellip;

Horizontal ellipsis

&trade;

Trademark sign

&spades;

Spade suit

&clubs;

Club suit

&hearts;

Heart suit

&diams;

Diamond suit

In addition, htmltodoc supports several entities which are not part of any standard DTD:

&dcomma;

Double comma

&grafcmd;

Graffiti "command" stroke icon

&grafsc;

Graffiti "shortcut" stroke icon

SEE ALSO

AportisDoc, http://www.aportis.com/

TealDoc, http://www.tealpoint.com/

QED, http://www.visionary2000.com/

BUGS

This is the first release; if you find a bug, please report it to the author.

AUTHOR

htmltodoc was written by Rob Tillotson <[email protected]>.