The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
#!perl

our $DATE = '2016-01-18'; # DATE
our $VERSION = '0.35'; # VERSION

use 5.010;
use strict;
use warnings;

use Perinci::CmdLine::Any;

binmode STDOUT, ":utf8";
Perinci::CmdLine::Any->new(url=>'/App/ListOrgHeadlines/list_org_headlines')->run;

1;
# ABSTRACT: List all headlines in all Org files
# PODNAME: list-org-headlines

__END__

=pod

=encoding UTF-8

=head1 NAME

list-org-headlines - List all headlines in all Org files

=head1 VERSION

This document describes version 0.35 of list-org-headlines (from Perl distribution App-OrgUtils), released on 2016-01-18.

=head1 SYNOPSIS

 # list all headlines in all Org files
 $ list-org-headlines ~/*.org

 # instead of only listing its title, list details about each headline
 $ list-org-headlines --detail FILES ...

 # list all todo items in all Org files
 $ list-org-headlines --todo FILES ...

 # list headlines that are not todo items in all Org files
 $ list-org-headlines --notodo FILES ...

 # list up to level 2 only
 $ list-org-headlines --tolevel 2 FILES ...

 # list *only* level 3
 $ list-org-headlines --from-level 3 --to-level 3 FILES ...

=head1 DESCRIPTION

This is a simple application to list headlines in Org files, first created as a
demo for L<Org::Parser>.

=head1 OPTIONS

C<*> marks required options.

=head2 Configuration options

=over

=item B<--config-path>=I<filename>

Set path to configuration file.

Can be specified multiple times.

=item B<--config-profile>=I<s>

Set configuration profile to use.

=item B<--no-config>

Do not use any configuration file.

=back

=head2 Environment options

=over

=item B<--no-env>

Do not read environment for default options.

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


=back

=head2 Other options

=over

=item B<--cache-dir>=I<dirname>

Cache Org parse result.

Since Org::Parser can spend some time to parse largish Org files, this is an
option to store the parse result. Caching is turned on if this argument is set.


=item B<--detail>

Show details instead of just titles.

=item B<--done>

Only show todo items that are done.

=item B<--due-in>=I<i>

Only show todo items that are (nearing|passed) due.

If value is not set, then will use todo item's warning period (or, if todo item
does not have due date or warning period in its due date, will use the default
14 days).

If value is set to something smaller than the warning period, the todo item will
still be considered nearing due when the warning period is passed. For example,
if today is 2011-06-30 and due_in is set to 7, then todo item with due date
<2011-07-10 > won't pass the filter (it's still 10 days in the future, larger
than 7) but <2011-07-10 Sun +1y -14d> will (warning period 14 days is already
passed by that time).


=item B<--file>=I<filename>*

Can be specified multiple times.

=item B<--files-json>=I<filename>

See C<--file>.

=item B<--from-level>=I<i>

Only show headlines having this level as the minimum.

Default value:

 1

=item B<--group-by-tags>

Whether to group result by tags.

If set to true, instead of returning a list, this function will return a hash of
lists, keyed by tag: {tag1: [hl1, hl2, ...], tag2: [...]}. Note that some
headlines might be listed more than once if it has several tags.


=item B<--has-tags-json>=I<s>

Only show headlines that have the specified tags (JSON-encoded).

See C<--has-tags>.

=item B<--has-tags>=I<s@>

Only show headlines that have the specified tags.

Can be specified multiple times.

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

Display help message and exit.

=item B<--lacks-tags-json>=I<s>

Only show headlines that don't have the specified tags (JSON-encoded).

See C<--lacks-tags>.

=item B<--lacks-tags>=I<s@>

Only show headlines that don't have the specified tags.

Can be specified multiple times.

=item B<--maximum-priority>=I<s>

Only show todo items that have at most this priority.

Note that the default priority list is [A, B, C] (A being the highest) and it
can be customized using the `#+PRIORITIES` setting.


=item B<--minimum-priority>=I<s>

Only show todo items that have at least this priority.

Note that the default priority list is [A, B, C] (A being the highest) and it
can be customized using the `#+PRIORITIES` setting.


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

Only show todo items that have this priority.

=item B<--sort-json>=I<s>

Specify sorting (JSON-encoded).

See C<--sort>.

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

Specify sorting.

Default value:

 "due_date"

If string, must be one of 'due_date', '-due_date' (descending).

If code, sorting code will get [REC, DUE_DATE, HL] as the items to compare,
where REC is the final record that will be returned as final result (can be a
string or a hash, if 'detail' is enabled), DUE_DATE is the DateTime object (if
any), and HL is the Org::Headline object.


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

Only show todo items that have this state.

=item B<--time-zone>=I<timezone>

Will be passed to parser's options.

If not set, TZ environment variable will be picked as default.


=item B<--to-level>=I<i>

Only show headlines having this level as the maximum.

=item B<--today-json>=I<s>

Assume today's date (JSON-encoded).

See C<--today>.

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

Assume today's date.

You can provide Unix timestamp or DateTime object. If you provide a DateTime
object, remember to set the correct time zone.


=item B<--todo>

Only show headlines that are todos.

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

Display program's version and exit.

=item B<--with-unknown-priority>

Also show items with no/unknown priority.

Relevant only when used with `minimum_priority` and/or `maximum_priority`.

If this option is turned on, todo items that does not have any priority or have
unknown priorities will *still* be included. Otherwise they will not be
included.


=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 list-org-headlines list-org-headlines

in your bash startup (e.g. C<~/.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 L<shcompgen> which allows you to
activate completion scripts for several kinds of scripts on multiple shells.
Some CPAN distributions (those that are built with
L<Dist::Zilla::Plugin::GenShellCompletion>) will even automatically enable shell
completion for their included scripts (using C<shcompgen>) at installation time,
so you can immadiately have tab completion.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete list-org-headlines 'p/*/`list-org-headlines`/'

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

=head2 other shells

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

=head1 CONFIGURATION FILE

This script can read configuration file, which by default is searched at C<~/.config/list-org-headlines.conf>, C<~/list-org-headlines.conf> or C</etc/list-org-headlines.conf> (can be changed by specifying C<--config-path>). All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

Configuration file is in the format of L<IOD>, which is basically INI with some extra features. 

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

List of available configuration parameters:

 cache_dir (see --cache-dir)
 detail (see --detail)
 done (see --done)
 due_in (see --due-in)
 files (see --file)
 format (see --format)
 from_level (see --from-level)
 group_by_tags (see --group-by-tags)
 has_tags (see --has-tags)
 lacks_tags (see --lacks-tags)
 maximum_priority (see --maximum-priority)
 minimum_priority (see --minimum-priority)
 naked_res (see --naked-res)
 priority (see --priority)
 sort (see --sort)
 state (see --state)
 time_zone (see --time-zone)
 to_level (see --to-level)
 today (see --today)
 todo (see --todo)
 with_unknown_priority (see --with-unknown-priority)

=head1 ENVIRONMENT

=head2 LIST_ORG_HEADLINES_OPT => str

Specify additional command-line options

=head1 FILES

~/.config/list-org-headlines.conf

~/list-org-headlines.conf

/etc/list-org-headlines.conf

=head1 HOMEPAGE

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

=head1 SOURCE

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

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-OrgUtils>

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 SEE ALSO

B<list-org-todos>

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

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