/ 
App-durseq-0.004
River stage one • 1 direct dependent • 1 total dependent
/ durseq

NAME

durseq - Generate a sequence of durations

VERSION

This document describes version 0.004 of durseq (from Perl distribution App-durseq), released on 2019-11-29.

SYNOPSIS

Usage:

% durseq [options] [from] [to] [increment]

Examples:

Generate "infinite" durations from zero (then P1D, P2D, ...):

% durseq

Generate durations from P0D to P10D:

% durseq P0D P10D
PT0H0M0S
P1D
... 7 more lines ...
P9D
P10D

Generate durations from P0D to P10D, with 12 hours increment:

% durseq P0D P10D -i PT12H
PT0H0M0S
PT12H
... 17 more lines ...
PT228H
PT240H

Generate durations from P10D to P0D (reverse):

% durseq P10D P0D -r
P10D
P9D
... 7 more lines ...
P1D
PT0H0M0S

Generate 10 durations from P1M (increment 1 week):

% durseq P1M -i P1W -n 10
P1M
P1M7D
... 6 more lines ...
P1M56D
P1M63D

DESCRIPTION

This utility is similar to Perl script dateseq, except that it generates a sequence of durations instead of dates.

OPTIONS

* marks required options.

Main options

--from=s

Starting duration.

--increment=s, -i

Increment, default is one day (P1D).

--limit=s, -n

Only generate a certain amount of items.

--reverse, -r

Decrement instead of increment.

--to=s

Ending duration, if not specified will generate an infinite* stream of durations.

Formatting options

--format-class-attrs-json=s

Arguments to pass to constructor of DateTime::Format::* class (JSON-encoded).

See --format-class-attrs.

--format-class-attrs=s

Arguments to pass to constructor of DateTime::Format::* class.

--format-class=s

Use a DateTime::Format::Duration::* class for formatting.

Default value:

"ISO8601"

By default, "ISO8601" (<pm:DateTime::Format::Duration::ISO8601>) is used.

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

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C durseq durseq

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.

tcsh

To activate tcsh completion for this script, put:

complete durseq 'p/*/`durseq`/'

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.

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-App-durseq.

BUGS

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

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