NAME
dump-firefox-history - Dump Firefox history
VERSION
This document describes version 0.008 of dump-firefox-history (from Perl distribution App-DumpFirefoxHistory), released on 2020-05-24.
SYNOPSIS
Usage:
% dump-firefox-history [--attempt-orig-first] [--copy-size-limit=s] [--debug] [--detail] [--format=name] [--json] [-l] [--log-level=level] [--(no)naked-res] [--no-attempt-orig-first] [--no-detail] [--noattempt-orig-first] [--nodetail] [--page-result[=program]] [--profiles-json=s] [--profiles=s+] [--quiet] [--trace] [--verbose]OPTIONS
* marks required options.
Main options
- --attempt-orig-first
-
Attempt to open the original history database first instead of directly copying the database.
- --copy-size-limit=s
-
Default value:
104857600Firefox often locks the History database for a long time. If the size of the database is not too large (determine by checking against this limit), then the script will copy the file to a temporary file and extract the data from the copied database.
- --detail, -l
- --profiles-json=s
-
Select profile(s) to dump (JSON-encoded).
See
--profiles. - --profiles=s@
-
Select profile(s) to dump.
You can choose to dump history for only some profiles. By default, if this option is not specified, history from all profiles will be dumped.
Can be specified multiple times.
Logging options
- --debug
-
Shortcut for --log-level=debug.
- --log-level=s
-
Set log level.
- --quiet
-
Shortcut for --log-level=error.
- --trace
-
Shortcut for --log-level=trace.
- --verbose
-
Shortcut for --log-level=info.
Output options
- --format=s
-
Choose output format, e.g. json, text.
Default value:
undef - --json
-
Set output format to json.
- --naked-res
-
When outputing as JSON, strip result envelope.
Default value:
0By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3] - --page-result
-
Filter output through a pager.
Other options
COMPLETION
This script has shell tab completion capability with support for several shells.
bash
To activate bash completion for this script, put:
complete -C dump-firefox-history dump-firefox-historyin your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
tcsh
To activate tcsh completion for this script, put:
complete dump-firefox-history 'p/*/`dump-firefox-history`/'in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
other shells
For fish and zsh, install shcompgen as described above.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-DumpFirefoxHistory.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-DumpFirefoxHistory.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-DumpFirefoxHistory
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2020, 2019, 2017 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.