NAME
doc2txt - Convert Office word-processor format file (.doc, .docx, .odt, etc) to .txt
VERSION
This document describes version 0.006 of doc2txt (from Perl distribution App-OfficeUtils), released on 2021-07-13.
SYNOPSIS
Usage:
% 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]
DESCRIPTION
This utility uses one of the following backends:
LibreOffice
OPTIONS
* marks required options.
Main options
- --fmt
-
Run Unix fmt over the txt output.
- --input-file=s*
-
Path to input file.
Can also be specified as the 1st command-line argument.
- --output-file=s
-
Path to output file.
If not specified, will output to stdout.
Can also be specified as the 2nd command-line argument.
- --overwrite, -O
- --return-output-file
-
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.
Libreoffice options
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.
- --view-result
-
View output using a viewer.
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 doc2txt doc2txtin 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 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).
other shells
For fish and zsh, install shcompgen as described above.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-OfficeUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-OfficeUtils.
BUGS
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.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2020 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.