view release on metacpan or  search on metacpan

script/list-org-headlines  view on Meta::CPAN

#!perl

use 5.010;
use strict;
use warnings;

use Perinci::CmdLine::Any;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-01-09'; # DATE
our $DIST = 'App-OrgUtils'; # DIST
our $VERSION = '0.487'; # VERSION

binmode STDOUT, ":encoding(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.487 of list-org-headlines (from Perl distribution App-OrgUtils), released on 2024-01-09.

=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 Main options

=over

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

(No description)


Can also be specified as the 1st command-line argument and onwards.