list-org-headlines-fast - List Org headlines
This document describes version 0.31 of list-org-headlines-fast (from Perl distribution App-OrgUtils), released on 2015-05-02.
Usage:
% list-org-headlines-fast [options] <input>
This routine uses simple regex instead of Org::Parser, for faster performance.
* marks required options.
*
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Do not use any configuration file.
Do not read environment for default options.
Only include headline whose ascendant matches this (JSON-encoded).
See --ascendant-match.
--ascendant-match
Only include headline whose ascendant matches this.
Value is either a string or a regex. If string is in the form of `/.../` or `/.../i` it is assumed to be a regex.
Only include headline which is a done todo item.
Only include headline which is a todo item.
Only include headline which matches this (JSON-encoded).
See --match.
--match
Only include headline which matches this.
Only include headline whose parent matches this (JSON-encoded).
See --parent-match.
--parent-match
Only include headline whose parent matches this.
Choose output format, e.g. json, text.
Default value:
undef
Set output format to json.
When outputing as JSON, strip result envelope.
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]
Display help message and exit.
Value is either a string or an array of strings.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C list-org-headlines-fast list-org-headlines-fast
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.
~/.bashrc
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.
shcompgen
To activate tcsh completion for this script, put:
complete list-org-headlines-fast 'p/*/`list-org-headlines-fast`/'
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.
~/.tcshrc
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
LIST_ORG_HEADLINES_FAST_OPT
Specify additional command-line options
This script can read configuration file, which by default is searched at ~/.config/list-org-headlines-fast.conf, ~/list-org-headlines-fast.conf or /etc/list-org-headlines-fast.conf (can be changed by specifying --config-path). All found files will be read and merged.
~/.config/list-org-headlines-fast.conf
~/list-org-headlines-fast.conf
/etc/list-org-headlines-fast.conf
--config-path
To disable searching for configuration files, pass --no-config.
--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.
[profile=SOMENAME]
--config-profile SOMENAME
List of available configuration parameters:
ascendant_match (see --ascendant-match) format (see --format) input (see --input) is_done (see --is-done) is_todo (see --is-todo) level (see --level) match (see --match) max_level (see --max-level) min_level (see --min-level) naked_res (see --naked-res) parent_match (see --parent-match)
Please visit the project's homepage at https://metacpan.org/release/App-OrgUtils.
Source repository is at https://github.com/sharyanto/perl-App-OrgUtils.
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.
perlancar <perlancar@cpan.org>
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.
To install App::OrgUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::OrgUtils
CPAN shell
perl -MCPAN -e shell install App::OrgUtils
For more information on module installation, please visit the detailed CPAN module installation guide.