rewrote manpage/--help

diff --git a/src/pdf2swf.1 b/src/pdf2swf.1
index ed641b8..f1eb3aa 100644 (file)
--- a/src/pdf2swf.1
+++ b/src/pdf2swf.1
@@ -1,77 +1,87 @@
-.TH pdf2swf "1" "January 2003" "pdf2swf" "swftools"
+.TH pdf2swf "1" "June 2008" "pdf2swf" "swftools"

 .SH NAME
 .SH NAME

-pdf2swf - convert PDF files into SWF
+pdf2swf - Converts Acrobat PDF files into Flash SWF Animation files.
+

 .SH Synopsis
 .SH Synopsis

-.B pdf2swf
-[\fIoptions\fR] \fIfile.pdf\fR [-o \fIfile.swf\fR]
+.B pdf2swf [-options] file.pdf -o file.swf
+

 .SH DESCRIPTION
 .SH DESCRIPTION

-This tools converts Acrobat PDF files into Flash SWF Animation
-files.
+Converts a PDF file to a SWF file.
+

 .SH OPTIONS
 .TP
 .SH OPTIONS
 .TP

-\fB\-h\fR, \fB\-\-help\fR
-Print short help message and exit
+\fB\-h\fR, \fB\-\-help\fR 
+    Print short help message and exit
+.TP
+\fB\-V\fR, \fB\-\-version\fR 
+    Print version info and exit

 .TP
 .TP

-\fB\-V\fR, \fB\-\-version\fR
-Print version info and exit
+\fB\-o\fR, \fB\-\-output\fR file.swf
+    will go into a seperate file.

 .TP
 .TP

-\fB\-p\fR, \fB\-\-pages\fR \fIrange\fR
-Convert only pages in \fIrange\fR with \fIrange\fR e.g. 1-20 or 1,4,6,9-11 or
-3-5,10-12
+\fB\-p\fR, \fB\-\-pages\fR range
+    3-5,10-12

 .TP
 .TP

-\fB\-v\fR, \fB\-\-verbose\fR
-Be verbose. Use more than one -v for greater effect.
+\fB\-P\fR, \fB\-\-password\fR password
+    Use password for deciphering the pdf.

 .TP
 .TP

-\fB\-z\fR, \fB\-\-zlib\fR
-Use Flash 6 (MX) zlib compression.
-\fBThe resulting SWF will not be playable in browsers with Flash Plugins 5 and below!\fR
+\fB\-v\fR, \fB\-\-verbose\fR 
+    Be verbose. Use more than one -v for greater effect.

 .TP
 .TP

-\fB\-i\fR, \fB\-\-ignore\fR
-Allows pdf2swf to change the draw order of the pdf. This may make the generated
-SWF files a little bit smaller, but it may also cause the images in the pdf to look funny.
+\fB\-z\fR, \fB\-\-zlib\fR 
+    The resulting SWF will not be playable in browsers with Flash Plugins 5 and below!

 .TP
 .TP

-\fB\-j\fR, \fB\-\-jpegquality\fR \fIquality\fR
-Set quality of embedded jpeg pictures to \fIquality\fR. 0 is worst (small), 100 is best (big). (default:85)
+\fB\-i\fR, \fB\-\-ignore\fR 
+    SWF files a little bit smaller, but it may also cause the images in the pdf to look funny.

 .TP
 .TP

-\fB\-s\fR, \fB\-\-set\fR \fIparam=value\fR
-Set a SWF encoder specific parameter. See pdf2swf \-\-help for more information.
+\fB\-j\fR, \fB\-\-jpegquality\fR quality
+    Set quality of embedded jpeg pictures to quality. 0 is worst (small), 100 is best (big). (default:85)

 .TP
 .TP

-\fB\-w\fR, \fB\-\-samewindow\fR
-When converting pdf hyperlinks, don't make the links open a new window when clicked on,
-but open the page they point to in the window the SWF is displayed.
+\fB\-s\fR, \fB\-\-set\fR param=value
+    Set a SWF encoder specific parameter.  See pdf2swf -s help for more information.

 .TP
 .TP

-\fB\-t\fR, \fB\-\-stop\fR
-Insert a stop() command in each page. The resulting SWF file will not turn pages automatically.
+\fB\-w\fR, \fB\-\-samewindow\fR 
+    When clicked on, the page they point to will be opened in the window the SWF is displayed.

 .TP
 .TP

-\fB\-T\fR, \fB\-\-flashversion\fR \fInum\fR
-Set Flash Version in the SWF header to \fInum\fR.
+\fB\-t\fR, \fB\-\-stop\fR 
+    The resulting SWF file will not turn pages automatically.

 .TP
 .TP

-\fB\-F\fR, \fB\-\-fontdir\fR \fIdirectory\fR
-Add \fIdirectory\fR to the font search path.
+\fB\-T\fR, \fB\-\-flashversion\fR num
+    Set Flash Version in the SWF header to num.
+.TP
+\fB\-F\fR, \fB\-\-fontdir\fR directory
+    Add directory to the font search path.

 .TP
 \fB\-b\fR, \fB\-\-defaultviewer\fR 
 .TP
 \fB\-b\fR, \fB\-\-defaultviewer\fR 

-Link a standard viewer to the swf file. Therefore the swf file will be "browseable", i.e.
-display some buttons for turning pages.
-The viewer swf to be used is determined by a symlink named "default_viewer.swf" in
-the swftools data directory.
-.TP
-\fB\-l\fR, \fB\-\-defaultloader\fR
-Link a standard preloader to the swf file which will be displayed while the main swf is
-loading.
-The loader swf to be used is determined by a symlink named "default_loader.swf" in
-the swftools data directory.
-.TP
-\fB\-B\fR, \fB\-\-viewer\fR \fIfilename\fR
-Link viewer \fIfilename\fR to the swf file. See http://www.quiss.org/swftools/pdf2swf_usage.html
-for information on how to create your own viewers.
-.TP
-\fB\-L\fR, \fB\-\-loader\fR \fIfilename\fR
-Link preloader \fIfilename\fR to the swf file, where \fIfilename\fR
-is an arbitrary swf animation.
-.SH BUGS
-.PP
-dashed lines don't work.
-
-.SH AUTHOR
-
-Matthias Kramm <kramm@quiss.org>
+    Therefore the swf file will be "browseable", i.e.  display some buttons for turning pages.
+    The viewer swf to be used is determined by a symlink named "default_viewer.swf" in
+    the swftools data directory.
+.TP
+\fB\-l\fR, \fB\-\-defaultloader\fR 
+    The loader swf to be used is determined by a symlink named "default_loader.swf" in
+    the swftools data directory.
+.TP
+\fB\-B\fR, \fB\-\-viewer\fR filename
+    See http://www.quiss.org/swftools/pdf2swf_usage.html for information on how to create your own viewers.
+.TP
+\fB\-L\fR, \fB\-\-preloader\fR filename
+    filename is an arbitrary swf animation.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR 
+    Suppress normal messages.  Use -qq to suppress warnings, also.
+.TP
+\fB\-S\fR, \fB\-\-shapes\fR 
+    Don't use SWF Fonts, but store everything as shape.
+.TP
+\fB\-f\fR, \fB\-\-fonts\fR 
+    Store full fonts in SWF. (Don't reduce to used characters).
+.TP
+\fB\-G\fR, \fB\-\-flatten\fR 
+    This usually makes the file faster to render and also usually smaller, but will increase
+    conversion time.
+.TP
+\fB\-I\fR, \fB\-\-info\fR 
+    Don't do actual conversion, just display a list of all pages in the PDF.
+.TP
+\fB\-Q\fR, \fB\-\-maxtime\fR n
+    Abort conversion after n seconds. Only available on Unix.

diff --git a/src/pdf2swf.c b/src/pdf2swf.c
index ea61645..3b63410 100644 (file)
--- a/src/pdf2swf.c
+++ b/src/pdf2swf.c
@@ -401,29 +401,32 @@ int args_callback_option(char*name,char*val) {
  {"l","defaultpreloader","Link default preloader to the pdf"}
  {0,0}
 };*/
  {"l","defaultpreloader","Link default preloader to the pdf"}
  {0,0}
 };*/

-struct options_t options[] =
-{{"o","output"},
- {"q","quiet"},
- {"V","version"},
- {"i","ignore"},
- {"I","info"},
- {"z","zlib"},
- {"s","set"},
- {"S","shapes"},
- {"Q","maxtime"},
- {"j","jpegquality"},
- {"p","pages"},
- {"w","samewindow"},
- {"f","fonts"},
- {"F","fontdir"},
- {"B","viewer"},
- {"G","flatten"},
- {"L","preloader"},
- {"b","defaultviewer"},
- {"l","defaultpreloader"},
- {"t","stop"},
- {"T","flashversion"},
- {0,0}
+static struct options_t options[] = {
+{"h", "help"},
+{"V", "version"},
+{"o", "output"},
+{"p", "pages"},
+{"P", "password"},
+{"v", "verbose"},
+{"z", "zlib"},
+{"i", "ignore"},
+{"j", "jpegquality"},
+{"s", "set"},
+{"w", "samewindow"},
+{"t", "stop"},
+{"T", "flashversion"},
+{"F", "fontdir"},
+{"b", "defaultviewer"},
+{"l", "defaultloader"},
+{"B", "viewer"},
+{"L", "preloader"},
+{"q", "quiet"},
+{"S", "shapes"},
+{"f", "fonts"},
+{"G", "flatten"},
+{"I", "info"},
+{"Q", "maxtime"},
+{0,0}

 };
 
 int args_callback_longoption(char*name,char*val) {
 };
 
 int args_callback_longoption(char*name,char*val) {

@@ -445,43 +448,36 @@ int args_callback_command(char*name, char*val) {
     return 0;
 }
 
     return 0;
 }
 

-void args_callback_usage(char*name)
+void args_callback_usage(char *name)

 {
 {

-    printf("Usage: %s [Options] input.pdf [-o output.swf]\n", name);
-    printf("\nBasic options:\n");
-    printf("-p  --pages=range          Convert only pages in range\n");
-    printf("-P  --password=password    Use password for deciphering the pdf\n");
-    printf("-v  --verbose              Be verbose. Use more than one -v for greater effect\n");
-    printf("-q  --quiet                Suppress normal messages. Use -qq to suppress warnings, also.\n");
-#ifdef HAVE_DIRENT_H
-    printf("-F  --fontdir directory    Add directory to font search path\n");
-#endif
-    printf("-V  --version              Print program version\n");
-    printf("\nEnhanced conversion options:\n");
-    printf("-S  --shapes               Don't use SWF Fonts, but store everything as shape\n");
-    printf("-z  --zlib                 Use Flash 6 (MX) zlib compression (Needs at least Flash 6 Plugin to play)\n");
-    printf("-w  --samewindow           Don't open a new Browser Window for Links in the SWF\n");
-    printf("-f  --fonts                Store full fonts in SWF. (Don't reduce to used characters)\n");
-    printf("-T  --flashversion=num     Set the flash version in the header to num (default: 4)\n");
-    printf("-s insertstop              Insert a \"Stop\" Tag in every frame (don't turn pages automatically)\n");
-    printf("-s zoom=factor             Scale result, default: 72\n");
-    printf("-s jpegquality=quality     Set quality of embedded jpeg pictures (default:85)\n");
-    printf("-s caplinewidth=value      Set the minimum line width to trigger cap style handling to value. (3)\n");
-    printf("-s splinequality=value     Set the quality of spline convertion to value (0-100, default: 100).\n");
-    printf("-s fontquality=value       Set the quality of font convertion to value (0-100, default: 100).\n");
-    printf("-s ignoredraworder         Ignore draw order (makes the SWF file smaller and faster, but may produce\n"
-          "                           graphic errors)\n");
-    printf("-s filloverlap             Make intersecting shapes overlap, instead of canceling each\n"
-          "                           other out. (Needed for some Powerpoint PDFs)\n");
-    printf("-s transparent             Make the SWF transparent\n");
-    //deliberately undocumented (for now)
-    //printf("-2                         Put 2 pages into each frame.\n");
-    //printf("-4                         Put 4 pages into each frame.\n");
-    printf("Postprocessing options:\n");
-    printf("-b  --defaultviewer        Link default viewer to the pdf (%s)\n", concatPaths(SWFDIR, "default_viewer.swf"));
-    printf("-l  --defaultpreloader     Link default preloader the pdf (%s)\n", concatPaths(SWFDIR, "default_loader.swf"));
-    printf("-B  --viewer=filename      Link viewer \"name\" to the pdf (\"%s -B\" for list)\n", name);
-    printf("-L  --preloader=filename   Link preloader \"name\" to the pdf (\"%s -L\" for list)\n",name);
+    printf("\n");
+    printf("Usage: %s [-options] file.pdf -o file.swf\n", name);
+    printf("\n");
+    printf("-h , --help                    Print short help message and exit\n");
+    printf("-V , --version                 Print version info and exit\n");
+    printf("-o , --output file.swf         Direct output to file.swf. If file.swf contains '%d' (file%d.swf), then each page \n");
+    printf("-p , --pages range             Convert only pages in range with range e.g. 1-20 or 1,4,6,9-11 or\n");
+    printf("-P , --password password       Use password for deciphering the pdf.\n");
+    printf("-v , --verbose                 Be verbose. Use more than one -v for greater effect.\n");
+    printf("-z , --zlib                    Use Flash 6 (MX) zlib compression.\n");
+    printf("-i , --ignore                  Allows pdf2swf to change the draw order of the pdf. This may make the generated\n");
+    printf("-j , --jpegquality quality     Set quality of embedded jpeg pictures to quality. 0 is worst (small), 100 is best (big). (default:85)\n");
+    printf("-s , --set param=value         Set a SWF encoder specific parameter.  See pdf2swf -s help for more information.\n");
+    printf("-w , --samewindow              When converting pdf hyperlinks, don't make the links open a new window. \n");
+    printf("-t , --stop                    Insert a stop() command in each page. \n");
+    printf("-T , --flashversion num        Set Flash Version in the SWF header to num.\n");
+    printf("-F , --fontdir directory       Add directory to the font search path.\n");
+    printf("-b , --defaultviewer           Link a standard viewer to the swf file. \n");
+    printf("-l , --defaultloader           Link a standard preloader to the swf file which will be displayed while the main swf is loading.\n");
+    printf("-B , --viewer filename         Link viewer filename to the swf file. \n");
+    printf("-L , --preloader filename      Link preloader filename to the swf file. \n");
+    printf("-q , --quiet                   Suppress normal messages.  Use -qq to suppress warnings, also.\n");
+    printf("-S , --shapes                  Don't use SWF Fonts, but store everything as shape.\n");
+    printf("-f , --fonts                   Store full fonts in SWF. (Don't reduce to used characters).\n");
+    printf("-G , --flatten                 Remove as many clip layers from file as possible. \n");
+    printf("-I , --info                    Don't do actual conversion, just display a list of all pages in the PDF.\n");
+    printf("-Q , --maxtime n               Abort conversion after n seconds. Only available on Unix.\n");
+    printf("\n");

 }
 
 float getRate(char*filename)
 }
 
 float getRate(char*filename)