perlancar > App-after-0.04 > after

Download:
App-after-0.04.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

after - Run command after delay and/or other conditions

VERSION ^

This document describes version 0.04 of main (from Perl distribution App-after), released on 2016-05-21.

SYNOPSIS ^

Usage:

 % after [options] <command>...

Examples:

Run command after 30-minute delay:

 % after --delay 30m cmd

Run command after 12 hour delay and time has passed 2016-04-18:

 % after --delay 12h --time 2016-04-18 cmd

Run command after 12 hour delay *or* time has passed 2016-04-18:

 % after --or --delay 12h --time 2016-04-18 cmd

Run command after system uptime is 2 days:

 % after --uptime 2d cmd

Run command after system load is above 2.5:

 % after --load-above 2.5 cmd

Run command after system load is between 1 and 5:

 % after --load-above 1 --load-below 5 cmd

DESCRIPTION ^

after will run command after all the specified conditions are met. A condition can be: delay (--delay), current time (--time), system uptime (--uptime), system load falling below a certain value (--load-below), system load rising above a certain value (--load-above). More conditions will be available in the future.

OPTIONS ^

* marks required options.

Condition options

--delay=s, -d
--load-above=f
--load-below=f
--time=s
--uptime=s

Logic options

--all

Run command after all conditions are met (the default).

--none

Run command when none (instead of all) of the conditions are met.

--or

Run command after one condition (instead of all) is met.

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

--command-json=s

See --command.

--command=s@*

Can be specified multiple times.

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION ^

The distribution comes with a shell completer script (_after) for this script.

bash

To activate bash completion for this script, put:

 complete -C _after after

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 _after 'p/*/`after`/'

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

SOURCE ^

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

BUGS ^

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

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.

SEE ALSO ^

http://onegeek.org/~tom/software/delay/. This CLI can also be used to run a command after specified delay or point of time.

Proc::Govern. This module can be used to run a command then pause it when system load is outside specified range. The distribution also comes with a CLI script.

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2016 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: