#!perl

# Note: This script is a CLI for Riap function /App/OfficeUtils/officewp2txt
# and generated automatically using Perinci::CmdLine::Gen version 0.496

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2020-08-22'; # DATE
our $DIST = 'App-OfficeUtils'; # DIST
our $VERSION = '0.003'; # VERSION

use 5.010001;
use strict;
use warnings;
use Log::ger;

use Perinci::CmdLine::Any;

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/OfficeUtils/officewp2txt",
    program_name => "doc2txt",
    log => 1,
    read_config => 0,
    read_env => 0,
);

$cmdline->run;

# ABSTRACT: Convert Office word-processor format file (.doc, .docx, .odt, etc) to .txt
# PODNAME: doc2txt

__END__

=pod

=encoding UTF-8

=head1 NAME

doc2txt - Convert Office word-processor format file (.doc, .docx, .odt, etc) to .txt

=head1 VERSION

This document describes version 0.003 of doc2txt (from Perl distribution App-OfficeUtils), released on 2020-08-22.

=head1 SYNOPSIS

Usage:

 % doc2txt [-O] [--debug] [--fmt] [--format=name] [--json]
     [--libreoffice-path=s] [--log-level=level] [--(no)naked-res]
     [--no-fmt] [--no-overwrite] [--no-return-output-file] [--nofmt]
     [--nooverwrite] [--noreturn-output-file] [--overwrite]
     [--page-result[=program]] [--quiet] [--return-output-file] [--trace]
     [--verbose] [--view-result[=program]] <input_file> [output_file]

=head1 DESCRIPTION

This utility uses one of the following backends:

=over

=item * LibreOffice

=back

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--fmt>

Run Unix fmt over the txt output.

=item B<--input-file>=I<s>*

Path to input file.

=item B<--output-file>=I<s>

Path to output file.

If not specified, will output to stdout.


=item B<--overwrite>, B<-O>

=item B<--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.


=back

=head2 Libreoffice options

=over

=item B<--libreoffice-path>=I<s>

=back

=head2 Logging options

=over

=item B<--debug>

Shortcut for --log-level=debug.

=item B<--log-level>=I<s>

Set log level.

=item B<--quiet>

Shortcut for --log-level=error.

=item B<--trace>

Shortcut for --log-level=trace.

=item B<--verbose>

Shortcut for --log-level=info.

=back

=head2 Output options

=over

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:

 undef

=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:

 0

By 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]


=item B<--page-result>

Filter output through a pager.

=item B<--view-result>

View output using a viewer.

=back

=head2 Other options

=over

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head1 COMPLETION

This script has shell tab completion capability with support for several
shells.

=head2 bash

To activate bash completion for this script, put:

 complete -C doc2txt doc2txt

in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete doc2txt 'p/*/`doc2txt`/'

in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-OfficeUtils>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-OfficeUtils>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<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.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 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.

=cut
