1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
|
.TH PyFunceble 1 "August 2023" "PyFunceble 1"
.SH NAME
\fBpyfunceble - The tool to check the availability or syntax of domain, IP or URL
.SH SYNOPSIS
.B pyfunceble [options] [DOMAINS [DOMAINS ...]]
.PP
.SH DESCRIPTION
.fam C
.nf
tool written in Python that was developed with the objective of verifying
the availability of domains and IP addresses on the Internet. The main
purpose of PyFunceble is to perform DNS resolution and connection tests
to determine if a domain is up and reachable or down and unavailable.
.PP
.fam T
.fi
.SH USAGE
.fam C
.nf
Usage overview and basic syntax of helper executablesincluded in the PyFunceble
package:
.PP
.BR pyfunceble:
[--show-completion {bash,zsh,tcsh}]
[-d DOMAINS [DOMAINS \.\.\.]]
[-u URLS [URLS \.\.\.]] [-f FILES [FILES \.\.\.]]
[-uf URL_FILES [URL_FILES \.\.\.]] [--adblock]
[--cidr] [--complements] [--preload]
[--filter CLI_TESTING__FILE_FILTER] [--mining]
[--rpz] [--wildcard] [--chancy] [-c]
[--cooldown-time CLI_TESTING__COOLDOWN_TIME]
[--local]
[--collection-preferred-origin {frequent,latest,recommended}]
[--collection-lookup]
[--collection-lookup-only] [--dns-lookup]
[--dns-lookup-only] [--http] [--http-only]
[--netinfo-lookup] [--netinfo-lookup-only]
[--special-lookup] [--special-lookup-only]
[--whois-lookup] [--whois-lookup-only]
[--reputation-lookup]
[--reputation-lookup-only] [--reputation]
[--syntax] [-t LOOKUP__TIMEOUT]
[--max-http-retries MAX_HTTP_RETRIES]
[-ua USER_AGENT__CUSTOM] [-vsc]
[--dns DNS__SERVER [DNS__SERVER \.\.\.]]
[--dns-protocol {UDP,TCP,HTTPS,TLS}]
[--follow-server-order] [--trust-dns-server]
[--dns-delay DNS__DELAY]
[--http-proxy PROXY__GLOBAL__HTTP]
[--https-proxy PROXY__GLOBAL__HTTPS]
[--inactive-db]
[--database-type {csv,mariadb,mysql,postgresql}]
[-dbr CLI_TESTING__DAYS_BETWEEN__DB_RETEST]
[-wdb] [-a] [-ex] [--colour]
[--display-status {all,ACTIVE,INACTIVE,VALID,INVALID,MALICIOUS,SANE}
[{all,ACTIVE,INACTIVE,VALID,INVALID,MALICIOUS,SANE} \.\.\.]]
[--dots] [--hierarchical] [-h]
[-ip CLI_TESTING__HOSTS_IP] [--merge-output]
[--no-files]
[--output-location OUTPUT_LOCATION]
[--unified-results] [--percentage]
[--registrar]
[--max-registrar CLI_TESTING__DISPLAY_MODE__MAX_REGISTRAR]
[--plain] [-q] [--push-collection] [-s]
[-w CLI_TESTING__MAX_WORKERS]
[--ci-max-minutes CLI_TESTING__CI__MAX_EXEC_MINUTES]
[--ci] [--ci-branch CLI_TESTING__CI__BRANCH]
[--ci-distribution-branch CLI_TESTING__CI__DISTRIBUTION_BRANCH]
[--ci-command CLI_TESTING__CI__COMMAND]
[--ci-end-command CLI_TESTING__CI__END_COMMAND]
[--ci-commit-message CLI_TESTING__CI__COMMIT_MESSAGE]
[--ci-end-commit-message CLI_TESTING__CI__END_COMMIT_MESSAGE]
[--help] [-v]
\fBNote:\fP
All arguments listed below acts a switch to your configuration file-s.
This means that if (e.g.) 'file_generation.no_file' is set to 'true' its
value will be switch to 'false' at the runtime if the '--no-files' argument
is being used. Meaning that output files will be generated.
.fam T
.fi
.RE
.fam C
.nf
.SH OPTIONS
\fB--show-completion\fP {bash,zsh,tcsh} Show Shell completion script and exit.
.PP
\fB--help\fP Show this help message and exit.
.PP
\fB-v\fP, \fB--version\fPShow the version of PyFunceble and exit.
\fBTest sources:\fP
.PP
\fB-d\fP DOMAINS[DOMAINS \.\.\.], \fB--domain\fP DOMAINS [DOMAINS \.\.\.]
Test one or more domains, separated by spaces.
qWhen this option is used, no output files are generated.
\fB-u\fP URLS [URLS \.\.\.], \fB--url\fP URLS [URLS \.\.\.]
Test one or more full URL, separated by spaces.
\fB-f\fP FILES [FILES \.\.\.], \fB--file\fP FILES [FILES \.\.\.]
Read a local or remote (RAW link) file and test all domains
inside it. If remote (RAW link) file is given, PyFunceble
will download it,and test the content of the given RAW link
as if it was a locally stored file.
\fB-uf\fP URL_F ILES [URL_FILES \.\.\.], \fB--url-file\fP URL_FILES [URL_FILES \.\.\.]
Read a local or remote (RAW link) file and test all (full) URLs inside it.
If remote (RAW link) file is given, PyFunceble will download it, and test
the content of the given RAW link as if it was a locally stored file.
This argument test if an URL is available. It ONLY test full URLs.
.fam T
.fi
.fam C
.nf
\fBSource filtering, decoding, conversion and expansion:\fP
--adblock Activates or deactivates the decoding of the adblock format.
Configured value: False
--cidr Activates or disables the expansion of CIDR formatted
addresses.
Configured value: False
--complements Activates or disables the generation and test of the
complements.
A complement is for example `example.org` if 'www.example.org'
is given and vice-versa.
Configured value: False
--preload Activates or disables the preloading of the input
file(s) into the continue dataset before starting the tests.
This reduces the waiting time while continuing a previous
session.
Note: This is useless when the auto continue subsystem is not active.
Configured value: False
--filter CLI_TESTING__FILE_FILTER
Regex to match in order to test a given line.
Configured value: None
--mining Activates or disables the mining subsystem.
Configured value: False
--rpz Activates or disables the decoding of RPZ policies
from each given input files.
Configured value: False
--wildcard Activates or disables the decoding of wildcards for
each given input files.
Configured value: False
.fam T
.fi
.RS
.fam C
.RE
\fBTest control:\fP
.nf
\fB--chancy\fP, \fB--ludicrous\fP
Activates a chancy mode that unleashes the safety
workflow in place.
\m[red]WARNING: You shouldn't have to use this unless you feel really
lucky and trust your machine. This mode makes things look 'fast', but
it may produce some unexpected results if N process simultaneouslywrite
the same output file.This mode makes the graphical CLI outputunparsable
- either.\m[]
\m[green]MAY THE FORCE BE WITH YOU!\m[]
Configured value:False
-c, --auto-continue, --continue
activates or disables the autocontinue subsystem.
Configured value: False
--cooldown-time CLI_TESTING__COOLDOWN_TIME
Sets the cooldown time (in second) to apply between each test.
Configured value:0.0]
--local Activates or disables the consideration of the test(s)
in or for a local or private network context.
Configured value:False
--collection-preferred-origin {frequent,latest,recommended}
Sets the preferred status origin.
Configured value:'recommended'
--collection-lookup Activates or disables the usage of the Collection lookup
whether possible.
Configured value:False
--collection-lookup-only
Only perform a Collection lookup.
--dns-lookup Activates or disables the usage of the DNS lookup
whether possible.
Configured value:True
--dns-lookup-only Only perform a DNS lookup.
--http, --http-status-code-lookup
Switch the value of the usage of HTTP code.
Configured value: True
--http-only, --http-status-code-lookup-only
Only perform a HTTP Code lookup.
--netinfo-lookup Activates or disables the usage of the network
information (or network socket) whether possible.
Configured value: True
--netinfo-lookup-only
Only perform a network information (or networket socket) lookup.
--special-lookup Activates or disables the usage of our SPECIAL and
extra rules whether possible.
Configured value: True
--special-lookup-only
Only perform a SPECIAL lookup.
--whois-lookup Activates or disables the usage of the WHOIS record
(or better said the expiration date in it) whether possible.
Configured value: True
--whois-lookup-only Only perform a WHOIS lookup.
--reputation-lookup Activates or disables the usage of the reputation
dataset whether possible.
Configured value: False
--reputation-lookup-only
Only perform a reputation lookup.
--reputation Activates or disables the reputation checker.
Configured value: False
--syntax Activates or disables the syntax checker.
Configured value: False
-t LOOKUP__TIMEOUT, --timeout LOOKUP__TIMEOUT
Sets the default timeout to apply to each lookup
utilities every time it is possible to define a timeout.
Configured value: 5
--max-http-retries MAX_HTTP_RETRIES
Sets the maximum number of retries for an HTTP request.
Configured value: 3
-ua USER_AGENT__CUSTOM, --user-agent USER_AGENT__CUSTOM
Sets the user agent to use.
If not given, we try to get the latest (automatically) for you.
-vsc, --verify-ssl-certificate
Activates or disables the verification of the SSL/TLS
certificate when testing for URL.
Configured value: False
.fam T
.fi
.RS
.fam C
.RE
\fBDNS control:\fP
.nf
\fB--dns\fP DNS__SERVER [DNS__SERVER \.\.\.]
Sets one or more (space separated) DNS server(s) to use during testing.
To specify a port number for the DNS server you append it
as :port [ip:port].
If no port is specified, the default DNS port (53) is used.
Configured value: None
\fB--dns-protocol\fP {UDP,TCP,HTTPS,TLS}
Sets the protocol to use for the DNS queries.
Configured value: 'UDP'
\fB--follow-server-order\fP
Let us follow or mix the order of usage of the given
or found DNS server(s).
Configured value: True
\fB--trust-dns-server\fPActivates or disable the trust mode.
When active, when the first read DNS server give us a negative
response - without error - we take it as it it.
Otherwise, if not active, when the first read DNS server give us
a negative response - without error - we still consolidate by
checking all given/found server.
Configured value: False
\fB--dns-delay\fP DNS__DELAY
Sets the delay (in seconds) to apply between each DNS
queries.
Configured value: 0.0
\fBProxy control\fP:
\fB--http-proxy\fP PROXY__GLOBAL__HTTP
Sets the proxy to use when testing subjects over HTTP.
Configured value: None
\fB--https-proxy\fP PROXY__GLOBAL__HTTPS
Sets the proxy to use when testing subjects over HTTPS.
Configured value: None
\fBDatabases:\fP
\fB--inactive-db\fP Activates or disables the usage of a 'database' to
store all 'INACTIVE' and 'INVALID' subject for continuous retest.
Configured value: True
\fB--database-type\fP{csv,mariadb,mysql,postgresql}
Sets the database engine to use.
You can choose between the following: `csv | mariadb | mysql | postgresql`
Configured value: 'csv'
\fB-dbr\fP CLI_TESTING_DAYS_BETWEEN__DB_RETEST,
\fB--days-between-db-retest\fP CLI_TESTING__DAYS_BETWEEN__DB_RETEST
Sets the numbers of days since the introduction of
subject into the inactive dataset before it gets retested.
Configured value: 1
\fB-wdb\fP, \fB--whois-database\fP
Activates or disables the usage of a 'database' to
store the expiration date of all domains with a valid
expiration date.
Configured value: True
.fam T
.fi
.RS
.fam C
.RE
\fBOutput control:\fP
.nf
\fB-a\fP,\fB--all\fP Activates or disables the display of the all
information in the table we print to stdout.
Configured value: False
\fB-ex\fP, \fB--execution\fP
Activates or disables the display of the execution time.
Configured value: False
\fB--colour\fP, \fB--color\fP
Activates or disables the coloration to STDOUT.
Configured value: True
\fB--display-status\fP{all,ACTIVE,INACTIVE,VALID,INVALID,MALICIOUS,SANE}
[{all,ACTIVE,INACTIVE,VALID,INVALID,MALICIOUS,SANE} \.\.\.]
Sets the status that we are allowed to print to STDOUT.
Multiple space separated statuses can be given.
Configured value: 'all'
\fB--dots\fP Activate or disables the display of dots or other
characters when we skip the test of a subject.
Configured value: False
\fB--hierarchical\fP
Activates or disables the sorting of the files
content (output) in a hierarchical order.
Configured value: False
\fB-h\fP, \fB--host\fP
Activates or disables the generation of the
hosts file(s).
Configured value: False
\fB-ip\fP CLI_TESTING__HOSTS_IP, \fB--hosts-ip\fP CLI_TESTING__HOSTS_IP
Sets the IP to prefix each lines of the hosts file.
Configured value: '0.0.0.0'
\fB--merge-output\fP Activates or disables the merging of the outputs of all
inputted files inside a single subdirectory as opposed to the
normal behavior.
Configured value: False
\fB--no-files\fP Activates or disables the generation of any non-logs
file(s).
Configured value: False
\fB--output-location\fP OUTPUT_LOCATION
Sets the location where we are supposed to generation
the output directory from.
Configured value:
\fB--unified-results\fP Activates or disables the generation of the unified
results file instead of the divided ones.
Configured value: False
\fB--percentage\fP Activates or disables the display and generation
of the percentage - file - of each status.
Configured value: True
\fB--registrar\fP Activates or disables the display and generation
of the registrar - file - status at the end of a test.
The registrar file contains the top domain registrar found
while testing.
Configured value: False
\fB--max-registrar\fP CLI_TESTING__DISPLAY_MODE__MAX_REGISTRAR
Sets the maximal number of registrar to display.
Note: This argument has no effect when the \fB--registrar\fP
argument is not set. This argument only takes effect on
display but not in the log file
Configured value: 15
\fB--plain\fP Activates or disables the generation of the
RAW \fBfile\fP(s). What is meant is a list with only a list of
subject (one per line).
Configured value: True
\fB-q\fP,\fB--quiet\fP Activates or disables the display of output to the
terminal.
Configured value: False
\fB--push-collection\fPActivates or disables the push of test result into the
collection API.
Configured value: False
\fB-s\fP, \fB--simple\fPActivates or disables the simple output mode.
Configured value: False
Configured value: True
\fBMultiprocessing:\fP
\fB-w\fP CLI_TESTING__MAX_WORKERS, \fB--max-workers\fP CLI_TESTING__MAX_WORKERS
Sets the number of maximal workers to use.
If not given, 20 (based on the current machine) will be applied.
Configured value: None
CI / CD:
\fB--ci-max-minutes\fP CLI_TESTING__CI__MAX_EXEC_MINUTES
Sets the number of minutes to wait before starting
to stop a CI session.
Configured value: 15
\fB--ci\fP Activates or disables the Continuous Integration
mechanism.
Configured value: False
\fB--ci-branch\fP CLI_TESTING__CI__BRANCH
Sets our git working branch. This is the branch
from where we are supposed to store the tests
(excepts the final results).
Configured value: 'master'
\fB--ci-distribution-branch\fP CLI_TESTING__CI__DISTRIBUTION_BRANCH
Sets our git distributions branch. This is the
branch from where we are supposed to store and push
the final results.
Configured value: 'master'
\fB--ci-command\fP CLI_TESTING__CI__COMMAND
Sets the command to execute before each commit
(except the final one).
Configured value: None
\fB--ci-end-command\fP CLI_TESTING__CI__END_COMMAND
Sets the command to execute before the final commit.
Configured value: None
\fB--ci-commit-message\fP CLI_TESTING__CI__COMMIT_MESSAGE
Sets the commit message to apply every time we have
to apply a commit except for the really last one.
Configured value: 'PyFunceble - AutoSave'
\fB--ci-end-commit-message\fP CLI_TESTING__CI__END_COMMIT_MESSAGE
Sets the commit message to apply at the really end.
Configured value: 'PyFunceble - Results'
.SH EXAMPLES
.fam C
.nf
Check the availability of 'example.com'.
$ pyfunceble \fB-d\fP example.com
.PP
Check the availability of 'example.com' with a simple (stdout) output.
$ pyfunceble \fB-s\fP \fB-d\fP example.com
.PP
Check the availability of 'example.com' with extended (stdout) output.
$ pyfunceble \fB-a\fP \fB-d\fP example.com
.PP
Check the availability of 'example.com' and 'example.org'.
$ pyfunceble \fB-d\fP example.com example.org
.PP
Check the availability of 'https://example.com'.
$ pyfunceble \fB-u\fP https://example.com
.PP
Check the availability of 'https://example.com' and 'https://example.org'.
$ pyfunceble \fB-u\fP https://example.com https://example.com
.PP
Check the syntax of 'example.com'.
$ pyfunceble \fB--syntax\fP \fB-d\fP example.com
.PP
Check the reputation of 'example.com'.
$ pyfunceble \fB--reputation\fP \fB-d\fP example.com
.PP
Check the availability of all subjects in the 'myhosts' file.
$ pyfunceble \fB-f\fP myhosts
.PP
Check the availability of all subjects in the 'myhosts' and 'yourhosts' files.
$ pyfunceble \fB-f\fP myhosts yourhosts
.fam T
.fi
.SH SEE ALSO
.fam C
.nf
For an in-depth usage, explanation and examples of the arguments,you should read
the documentation at https://pyfunceble.readthedocs.io/en/latest/
.fam T
.fi
.SH REPORTING BUGS
.fam C
.nf
To report a bug please visit cplay-ng issues tracking system at:
https://github.com/funilrys/PyFunceble/issues
.fam T
.fi
.SH AUTHORS
.fam C
.nf
Written by Nissar Chababy (@funilrys) with the help of
https://pyfunceble.github.io/#/contributors
&& https://pyfunceble.github.io/#/special-thanks
.PP
This manual page was written by Josenison F. da Silva<nilsonfsilva@hotmail.com>
for the Debian project (but may be used by others).
.fam T
.fi
|
