doc2txt - Convert Office word-processor format file (.doc, .docx, .odt, etc) to .txt
This document describes version 0.006 of doc2txt (from Perl distribution App-OfficeUtils), released on 2021-07-13.
% doc2txt [--debug|--log-level=level|--quiet|--trace|--verbose] [--fmt|--no-fmt|--nofmt] [--format=name|--json] [--libreoffice-path=filename] [--(no)naked-res] [--overwrite|-O|--no-overwrite|--nooverwrite] [--page-result[=program]|--view-result[=program]] [--return-output-file|--no-return-output-file|--noreturn-output-file] -- <input_file> [output_file]
This utility uses one of the following backends:
* marks required options.
Run Unix fmt over the txt output.
Path to input file.
Can also be specified as the 1st command-line argument.
Path to output file.
If not specified, will output to stdout.
Can also be specified as the 2nd command-line argument.
Return the path of output file instead.
This is useful when you do not specify an output file but do not want to show the converted document to stdout, but instead want to get the path to a temporary output file.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
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:
Filter output through a pager.
View output using a viewer.
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C doc2txt doc2txt
in 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.
To activate tcsh completion for this script, put:
complete doc2txt 'p/*/`doc2txt`/'
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).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-OfficeUtils.
Source repository is at https://github.com/perlancar/perl-App-OfficeUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-OfficeUtils
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.
This software is copyright (c) 2021, 2020 by firstname.lastname@example.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.
To install App::OfficeUtils, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.