July 7th, 2008Htm2Pic Command Line Tool Detailed Usage
Notice
There are many options and flags supported, each option can have a specified value while flags can’t. An option starts with a ‘/’ and a flag starts with a ‘-’. Don’t forget to quote your option value if it contains space (s) otherwise your command would not be parsed correctly.
All right, here it goes…
/url
url(s) to capture, use semicolon to seperate multiple urls, the prefix “http://” can be ignored.
>Htm2PicCmdLine /url www.google.com;www.yahoo.com
/list
prepared text file containing url list(1 url per line), this option is ignored if you specify the ‘/url’ option at the same time.
>Htm2PicCmdLine /list c:\url.txt
/dir
output directory for captured images, default value is current directory.
>Htm2PicCmdLine /url www.google.com /dir d:\mypic
/name
naming rules of output images.
?u URL only
?ut URL and TimeStamp
?t TimeStamp only
?n Thread Number
or just type any name you want (without extension name)
default value is “?u”.
>Htm2PicCmdLine /url www.google.com /name ?u
>Htm2PicCmdLine /url www.google.com /name myname
/width /height
thumbnail width and height. these 2 options only take effect when you turn the “-thumbnail” flag on.
>Htm2PicCmdLine /url www.google.com /width 400 /height 300 -thumbnail
/percent
zooming percent while creating thumbnails(1-100). this option only takes effect when you turn both the “-thumbnail” and the “-zoom” flag on.
>Htm2PicCmdLine /url www.google.com /percent 30 -thumbnail -zoom
/format
output image format. supported formats: JPG/GIF/BMP/PNG/TIF/PDF/PCX/DCX/WMF/EMF/TGA, default format is JPG
>Htm2PicCmdLine /url www.google.com /format PNG
/quality
jpg compression quality(1-100), the bigger the better, default value is 90, this only takes effect when output image format is JPG.
>Htm2PicCmdLine /url www.google.com /quality 95
/bwidth
browser width(htm2pic uses IE browser’s rendering engine to take snapshots), default value is 800(pixels)
>Htm2PicCmdLine /url www.google.com /bwidth 1000
/cheight
by default, htm2pic would capture the whole webpage in full-length if you left this option blank, otherwise it would crop height to specified value in pixels, default value is 600.
>Htm2PicCmdLine /url www.google.com /cheight 400
/timeout
HTTP read time out in milliseconds, defualt value is 15000(15 seconds)
>Htm2PicCmdLine /url www.google.com /timeout 5000
/delay
delay in milliseconds after the browser loads the html document, this is to give some time to let browser to download heavy flash or other medias completely and avoid getting a blank snapshot. default value is 0(no delay)
>Htm2PicCmdLine /url www.google.com /delay 5000
/thread
htm2pic works in multi-threading mode if you provide multiple urls, so this is to set synchronized thread count. default value is 3. I suggest you not give it a value larger than 10 although there’s no limitaion on this. the default value is OK.
>Htm2PicCmdLine /url /list c:\urls.txt /thread 5
/log
htm2pic creates a log file named “Htm2Pic.log” while running, “/log” option sets the dir of the log file. by default, the log file is created in current directory. The data format of the log file is as follows:
STATUS, URL, IMAGE_FILENAME(if STATUS is SUCCESS)
eg.
SUCCESS,http://www.google.com,c:\www.google.com.JPG
FAILURE,http://www.noneexisting.com
this gives you a chance to get running results while htm2pic works in multi-threading mode.
/postdata
if you want to post some data to your target url, use this option. specify your datas in the following format:
name1=value1&name2=value2…
Htm2PicCmdLine /url www.somesite.com/post.php /postdata usr=username&pwd=password
/usr /key
these 2 options are for registration, you only have to run htm2pic once with the given usr/key pair after a successful purchase. the registration info would be stored on your machine ,so you do not need to specify them each time you capture a page.
Htm2PicCmdLine /usr your_name /key your_reg_code
/effect
finally, it comes to the most interesting yet complicated part. “/effect” option gives you the ability to apply several special image effects to output thumbnails by using functions.
drop shadow: ?ds(shadow_type)
shadow_type: rb(right bottom) | rt(right top) | lb(left bottom) | lt(left top) | fs(rect); default value:rb
>Htm2PicCmdLine /url www.google.com /width 800 /height 600 /effect ?ds(lb) -thumbnail
buttonize: ?bt(border_color;thickness;weight)
border_color: HEX color code starts with “#”, eg. #EF45A6. or directly color name(red, yellow, blue, purple…)
thickness: border thickness, integer.
weight: alpha. integer(1-256).
>Htm2PicCmdLine /url www.google.com /effect ?bt(#EFEFEF;5;128) -thumbnail
round corner: ?rc(bg_color;radius)
bg_color: same as above.
radius: radius of rounded corner.
>Htm2PicCmdLine /url www.google.com /effect ?rc(red;30) -thumbnail
reflection: ?rf(bg_color;percent;alpha_a;alpha_b)
bg_color: same as above.
percent: reflection percent.
alpha_a, alpha_b: linear reflecton from alpha_a to alpha_b, integer(1-256).
>Htm2PicCmdLine /url www.google.com /effect ?rf(yellow;50;128;180) -thumbnail
rotate: ?ro(bg_color;angle;new_width;new_height)
bg_color: same as above.
angle: rotate angle(1-360), clockwise.
new_width, new_height: integer.
>Htm2PicCmdLine /url www.google.com /effect ?rf(red;30;800;600) -thumbnail
tilt: ?ti(bg_color;direction;angle;len_a;len_b)
bg_color: same as above.
direction: h/v (horizontal/vertical)
angle: tilt angle(1-360), clockwise.
len_a, len_b: integer.
>Htm2PicCmdLine /url www.google.com /effect ?ti(#EF6523;h;800;600) -thumbnail
-thumbnail
make thumbnails of captured image, you should have known it if you read line by line from top.
-force
force capture when time out regardless of document completion.
-zoom
create thumbnails in zooming mode by specify the “/percent” option.
-nolog
disable system log(Htm2Pic.log)
-multipage
this will combine all captured images into one multi-page TIF file
>Htm2PicCmdLine /url www.google.com;www.yahoo.com;www.msn.com -multipage
-noscript
disable scripts in webpage while capturing, this is mainly to avoid nag dialogs created by javascript
-nobgsound
some webpages contain background music, but we don’t want browser to load it, right?
-noimage
this flag can prevent all images from being displayed in browser while capturing, thus, you’ll get a snapshot with only clean text in it.
-novideo
almost the same as above, but only affect videos.(flash videos are not included)