plowprobe(1)

1
2plowprobe(1)                 Plowshare for Bash 4                 plowprobe(1)
3
4
5

NAME

7       plowprobe - Gather information from file sharing download links
8
9

SYNOPSIS

11       plowprobe [OPTIONS]...  [MODULE_OPTIONS]...  URL|FILE...
12
13

DESCRIPTION

15       plowprobe  is a command-line tool designed for retrieving metadata from
16       file-sharing download links. Information are printed  on  stdout  (only
17       alive links).  Provided links can also be downloaded with plowdown(1).
18
19       Currently supported hosting sites list is available in README file.
20
21

OPTIONS

23   Common options
24       -i, --interface=IFACE
25              If  your  machine  has  several  network interfaces, force using
26              IFACE interface.
27
28           --printf=FORMAT
29              Print results (on stdout) in a given format (for  each  non-dead
30              link).  Default format string is "%F%u%n". Interpreted sequences
31              are:
32
33              %%     raw % character
34
35              %c     probe function return status (0 for success, 13 for  dead
36                     link, see list below)
37
38              %f     filename (can be empty string)
39
40              %F     empty if %f is empty, or alias to "# %f%n".
41
42              %h     filehash  (can be empty string if not available). Usually
43                     MD5 or SHA1. If hoster supports several  algorithms,  the
44                     longest digest is used.
45
46              %i     file  identifier  (can be empty string if not available).
47                     Usually included in input URL.
48
49              %m     module name
50
51              %n     newline
52
53              %s     filesize (positive integer) in bytes (can be empty string
54                     if not available). Note: It's often approximative.
55
56              %t     tabulation character
57
58              %T     file  timestamp  (can  be empty string if not available).
59                     Unix epoch time is preferred.
60
61              %u     download (source) url
62
63              %U     same as %u but url is escaped for JSON usage
64
65              %v     alternate or refactored download url.  This  can  be  for
66                     example  fixing primary hostname (to avoid HTTP 301 redi‐
67                     rection), or force HTTPS  protocol.   If  not  available,
68                     alias to %u.
69
70              %V     same as %v but url is escaped for JSON usage
71
72              Note:  Metadata  are  often not fully available from hosters nor
73              implemented by all modules.
74
75   Logging options
76       -v, --verbose=LEVEL
77              Set output verbosity level:
78              0  none,
79              1  errors,
80              2  notice (default behavior),
81              3  debug,
82              4  report (very noisy, log HTML pages).
83
84       -q, --quiet
85              Alias for -v0. Do not print any debug messages.
86
87   Miscellaneous options
88           --no-color
89              Disables log messages (stderr only) output coloring.
90
91           --follow
92              If no module is found for link, follow HTTP redirects (curl -L).
93              Default is disabled.
94
95           --get-module
96              Echo module name for each URL and exit. Faster than --printf=%m.
97              Useful for wrappers.
98
99           --no-curlrc
100              Do not use curl config file (~/.curlrc).
101
102           --curlrc=FILE
103              Force using  an  alternate  curl  configuration  file.  Replaces
104              ~/.curlrc  if  it  exists.   This  option  has  no  effect  when
105              --no-curlrc is defined.
106
107           --no-plowsharerc
108              Do not consider any configuration file.
109
110           --plowsharerc=FILE
111              Force using an alternate configuration file (instead of per-user
112              or  systemwide  plowshare.conf).  This option has no effect when
113              --no-plowsharerc is defined.
114
115           --modules
116              Display all supported module names (one per line) and exit. Use‐
117              ful for wrappers.
118
119   Generic program information
120       -h, --help
121              Display this help and exit.
122
123       -H, --longhelp
124              Display complete help (with module options) and exit.
125
126           --version
127              Output version information and exit.
128
129

MODULE OPTIONS

131       There is none yet!
132
133

EXAMPLES

135   1) Filter alive links in a text file
136       $ plowprobe file_with_links.txt > file_with_active_links.txt
137       # Or
138       $ cat file_with_links.txt | plowprobe - > file_with_active_links.txt
139
140   2) Custom results format
141       # Print links information: filename and hash
142       $ plowprobe --printf '# %f (%h)%n%u%n' http://www.sendspace.com/file/5njdw7
143
144       # Print a JSON result
145       $ plowprobe --printf '{"url":"%U","size":%s}%n' http://www.sendspace.com/file/5njdw7
146
147

FILES

149       ~/.config/plowshare/plowshare.conf
150              This is the per-user configuration file.
151
152       /etc/plowshare.conf
153              Systemwide configuration file.
154
155       The file format is described in plowshare.conf(5).
156
157       ~/.config/plowshare/modules/
158              User  directory considered when searching for modules at startup
159              (plowprobe will try to open ~/.config/plowshare/modules/config).
160              One file per module (hoster).
161
162

EXIT CODES

164       Possible exit codes are:
165
166       0      Success. Folder contain one or several files.
167
168       1      Fatal error. Upstream site updated or unexpected result.
169
170       2      No available module (provided URL is not supported).
171
172       3      Network error. Mostly curl related.
173
174       8      System generic error.
175
176       10     Link alive but temporarily unavailable.
177
178       11     Link alive but requires a password.
179
180       12     Link  alive but requires some authentication (private or premium
181              link).
182
183       13     Link is dead.
184
185       15     Unknown command line parameter or incompatible options.
186
187       If plowprobe is invoked with multiple links and one or  several  errors
188       occur, the first error code is returned added with 100.
189
190

AUTHORS

192       Plowshare  was initially written by Arnau Sanchez. See the AUTHORS file
193       for a list of some of the many other contributors.
194
195       Plowshare is (C) 2010-2015 The Plowshare Team
196