list-org-headlines-fast - List Org headlines
This document describes version 0.482 of list-org-headlines-fast (from Perl distribution App-OrgUtils), released on 2021-07-04.
Usage:
% list-org-headlines-fast [--ascendant-match=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--is-done] [--is-todo] [--isnt-done] [--isnt-todo] [--json] [--lacks-tag=s+] [--lacks-tags-json=s] [--level=s] [--match=s] [--max-level=s] [--min-level=s] [--(no)naked-res] [--page-result[=program]] [--parent-match=s] [--view-result[=program]] -- <input>
This routine uses simple regex instead of Org::Parser, for faster performance.
* marks required options.
*
Value is either a string or an array of strings.
Can also be specified as the 1st command-line argument.
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 have all these tags.
Can be specified multiple times.
Only include headline which have all these tags (JSON-encoded).
See --has-tag.
--has-tag
Only include headline which is a done todo item.
Only include headline which is a todo item.
Only include headline which lack all these tags.
Only include headline which lack all these tags (JSON-encoded).
See --lacks-tag.
--lacks-tag
Only include headline which matches this.
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]
Filter output through a pager.
View output using a viewer.
Display help message and exit.
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.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
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.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-OrgUtils.
Source repository is at https://github.com/perlancar/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) 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012, 2011 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.