perlancar > App-OrgUtils-0.31 > list-org-headlines

Download:
App-OrgUtils-0.31.tar.gz

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

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

VERSION ^

This document describes version 0.31 of list-org-headlines (from Perl distribution App-OrgUtils), released on 2015-05-02.

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 ...

DESCRIPTION ^

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

OPTIONS ^

* marks required options.

Configuration options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--no-config

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

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:

 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]

Other options

--cache-dir=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.

--detail

Show details instead of just titles.

--done

Only show todo items that are done.

--due-in=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).

--file=filename*

Can be specified multiple times.

--files-json=filename

See --file.

--from-level=i

Only show headlines having this level as the minimum.

Default value:

 1
--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.

--has-tags-json=s

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

See --has-tags.

--has-tags=s@

Only show headlines that have the specified tags.

Can be specified multiple times.

--help, -h, -?

Display help message and exit.

--lacks-tags-json=s

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

See --lacks-tags.

--lacks-tags=s@

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

Can be specified multiple times.

--maximum-priority=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.

--minimum-priority=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.

--priority=s

Only show todo items that have this priority.

--sort-json=s

Specify sorting (JSON-encoded).

See --sort.

--sort=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.

--state=s

Only show todo items that have this state.

--time-zone=timezone

Will be passed to parser's options.

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

--to-level=i

Only show headlines having this level as the maximum.

--today-json=s

Assume today's date (JSON-encoded).

See --today.

--today=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.

--todo

Only show headlines that are todos.

--version, -v

Display program's version and exit.

--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.

SEE ALSO ^

list-org-todos

COMPLETION ^

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

bash

To activate bash completion for this script, put:

 complete -C list-org-headlines list-org-headlines

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

tcsh

To activate tcsh completion for this script, put:

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

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.

ENVIRONMENT ^

CONFIGURATION FILE ^

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

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

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

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

FILES ^

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

~/list-org-headlines.conf

/etc/list-org-headlines.conf

HOMEPAGE ^

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

SOURCE ^

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

BUGS ^

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

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

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

syntax highlighting: