Common options
- -i,
--interface=IFACE
- If your machine has several network interfaces, force using IFACE
interface.
- -r,
--max-retries=N
- Set maximum retries for upload failures. Apply on module exit value:
1 (fatal error), 3 (network error), 7 (captcha
error). Default option value is 0 (no retry) and applies for one single
upload.
- -t,
--timeout=SECS
- Cancel upload download after SECS seconds of waits. Apply on module
exit value: 10 (temporary unavailable error). This error mainly
occurs on remote upload operations. Default option value is disabled (no
timeout, infinite) and applies for one single upload.
- --cache=METHOD
- Cache policy regarding module storage space. Each module is able to save
data (credentials, authentication session, or tokens) in order to be
reused later. Available values:
none: module storage file is deleted before each
item processing. Temporary directory is used.
session (default): module storage file is deleted
at the end of plowup execution. Temporary directory is used.
shared: module storage file is global and located
(in
~/.config/plowshare/storage/). It can be accessed by any other
instance of plow* scripts. Warning: There is no atomicity (or file locking) on
concurrent access.
Example: Multiple file upload using a premium account. If
supported by module, login stage could be performed once.
- --9kweu=KEY
- Use 9kw.eu service to solve captchas.
- --antigate=KEY
- Use Antigate.com service to solve captchas.
- --captchabhood=USER:PASSWORD
- Use Captcha Brotherhood service to solve captchas.
- --captchacoin=KEY
- Use CaptchaCoin service to solve captchas.
- --deathbycaptcha=USER:PASSWORD
- Use Death by Captcha service to solve captchas.
- --captchamethod=METHOD
- Force specific captcha solving method (if unspecified it is autodetected).
Available values:
imgur: upload image to Imgur.com service, print
image url in console and prompt for manual entering. Useful for NAS and
embedded devices.
none: abort if captcha solving is requested (even
if automatic solving service is available).
online: use captcha solving website only (9kweu,
Antigate, CaptchaBrotherhood, CaptchaCoin or DeathByCaptcha account
required).
fb: display image in framebuffer console and
prompt for manual entering. Looks for framebuffer viewers: fbi, fim.
FRAMEBUFFER environment variable can contain device file. Default is
/dev/fb0.
nox: display image in console (text) and prompt
for manual entering. Looks for ascii viewers: img2txt, aview, tiv.
x11: display image in an X11 window and prompt for
manual entering. Looks for viewers: display, feh, sxiv, qiv. DISPLAY
environment variable must not be empty.
- --captchaprogram=PROGRAM
- Call external program or script for solving captchas. Provided executable
can be located in PATH environment variable.
Three arguments are given:
$1 module name (lowercase). For example:
mediafire.
$2 image filename (with full path).
$3 hint or captcha type (string). For example:
recaptcha,
solvemedia or
digits-4.
Return value (on stdout) and exit status:
0: solving success. Captcha Word(s) must be
echo'ed.
2: external solver is not able to solve requested
captcha. Let plowup continue solving it normally (will consider
--captchamethod if specified).
7: external solver failed. Note: this exit code is
eligible with retry policy (
-r/
--max-retries).
Note: plowup legacy exit errors can also be returned, for example:
1 (fatal) or 3 (network).
- --max-rate=SPEED
- Limit upload maximum speed in bytes per second. Suffixes are:
k for kilobytes (kB i.e. 1000),
M for megabytes (MB i.e. 1000^2),
K or Ki for kibibytes (KB or KiB i.e.
1024),
m or Mi for mebibytes (mB or MiB i.e.
1024^2).
- --min-rate=SPEED
- Limit upload minimum speed in bytes per second (for a delay of 30
seconds). Suffixes are the same than --max-rate.
- --temp-directory=DIRECTORY
- Directory for temporary files: cookies, images, ...
- --name=FORMAT
- Format destination filename (applies on each file argument). Can be useful
is you want to append or prepend a string to all your files. Default
format string is "%f". Interpreted sequences are:
- %%
- raw % character
- %f
- destination (remote) filename
- %g
- destination (remote) filename (without extension)
- %G
- destination (remote) filename (without extension, greedy)
- %h
- MD5 hash (32-digit hexadecimal number, lowercase letters)
- %l
- source (local) filename
- %m
- module name
- %s
- file size (in bytes)
- %x
- extension (without dot character) of %f (not greedy)
- --run-before=PROGRAM
- Call external program or script before upload file processing. Provided
executable can be located in PATH environment variable. Messages
can be sent to stderr, stdout is trashed.
Three arguments are given:
$1 module name (lowercase). For example:
mediafire.
$2 local filename
$3 destination filename
$4 cookie (initially empty) file given to upload
module function.
Exit status:
0: script success. plowup continue normally.
2: script explicitly requests skipping current
file.
Note: Any other script exit status like 1 (fatal) or
3 (network) will be ignored (an error message will be reported).
- --printf=FORMAT
- Print results (on stdout) in a given format (for each successful upload).
Default format string is "%L%M%u%n". Interpreted
sequences are:
- %%
- raw % character
- %a
- admin url or admin code (rare case)
- %A
- same as %a but url is escaped for JSON usage
- %M
- empty if %a is empty, or alias to "#ADM
%a%n".
- %d
- delete url
- %D
- same as %d but url is escaped for JSON usage
- %L
- empty if %d is empty, or alias to "#DEL
%d%n".
- %f
- destination (remote) filename
- %l
- source (local) filename
- %m
- module name
- %n
- newline
- %s
- filesize (positive integer in bytes)
- %t
- tabulation character
- %T
- 24-hour clock time of finished file upload. 8 characters string in the
format "HH:MM:SS" (invoke /bin/date +%T).
- %u
- download url
- %U
- same as %u but url is escaped for JSON usage