From 38a93ec51b23826a8f0f2b91fbaea5956ea5bda4 Mon Sep 17 00:00:00 2001 From: Stef Date: Tue, 27 Jul 2004 21:54:23 +0000 Subject: - Documentation --- src/rtfx.1 | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 59 insertions(+), 6 deletions(-) (limited to 'src/rtfx.1') diff --git a/src/rtfx.1 b/src/rtfx.1 index 3ddf4fa..6119ef8 100644 --- a/src/rtfx.1 +++ b/src/rtfx.1 @@ -1,19 +1,72 @@ -.Dd March, 2004 -.Dt RTFX 1 -.Os RTFX 0.9.1 +.\" +.\" Copyright (c) 2004, Nate Nielsen +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" * Redistributions of source code must retain the above +.\" copyright notice, this list of conditions and the +.\" following disclaimer. +.\" * Redistributions in binary form must reproduce the +.\" above copyright notice, this list of conditions and +.\" the following disclaimer in the documentation and/or +.\" other materials provided with the distribution. +.\" * The names of contributors to this software may not be +.\" used to endorse or promote products derived from this +.\" software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS +.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF +.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +.\" DAMAGE. +.\" +.\" +.\" CONTRIBUTORS +.\" Nate Nielsen +.\" +.Dd July, 2004 +.Dt rtfx 1 +.Os rtfx .Sh NAME .Nm rtfx .Nd converts RTF to a generic XML format .Sh SYNOPSIS .Nm +.Op Fl p .Ar inrtf .Ar outxml .Sh DESCRIPTION .Nm -converts RTF files into a generic XML format. It majors on keeping meta data like style names, etc... rather than every bit of formatting. This makes it handy for converting RTF documents into a custom XML format (using XSL or an additional processing step). -There are no options. To get different output you should use another processing step. rtfx's goal is just to get stuff into a basic XML format. +converts RTF files into a generic XML format. It majors on keeping meta data like style +names, etc... rather than every bit of formatting. This makes it handy for converting +RTF documents into a custom XML format (using XSL or an additional processing step). +.Pp +The output format is documented on the rtfx website (below). There are two slight +variations of output format. The normal mode contains structure type data with +formatting that has relevance on the context (such as bold or underline). The +presentation format adds some more formatting tags (such as fonts or colors). +.Sh OPTIONS +The options are as follows: +.Bl -tag -width Fl +.It Fl p +Puts +.Nm +into 'presentation' output mode. +.El +.Sh WEBSITE +http://memberwebs.com/software/rtfx/ .Sh BUGS -Doesn't handle crummy RTF files nicely +Doesn't handle crummy RTF files nicely. Needs some speed improvements. .Sh SEE ALSO .Xr sablot 3 .Sh AUTHOR -- cgit v1.2.3