perlancar

NAME

dux - Run dux function on the command-line

VERSION

This document describes version 1.48 of dux (from Perl distribution App-dux), released on 2014-12-27.

SYNOPSIS

 dux --help | -h
 dux --list | -l [ --long ]
 dux [common opts] <dux function> [function opts ...] [file ...]

DESCRIPTION

This script runs a dux function on the command line. Dux function receives items as lines from files/stdin, and outputs items as lines of stdout.

OPTIONS

--list, -l

List available dux functions. If run without the --long option, will just output names of dux functions. Otherwise will also display extra information: whether function is an itemfunc (i symbol), whether function is unsafe (U symbol, meaning function evals string from user input), function's version and tags.

--library=STR, -I

Like Perl's -I option.

ENVIRONMENT

See Perinci::CmdLine for a more complete list.

COLOR (bool)

Whether to force enable/disable color. The default is to enable when running interactively.

LOG (bool, default 0)

Whether to enable logging. By default this script sets LOG environment to 0. If you want to enable logging, you have to specifically set LOG=1.

SEE ALSO

Data::Unixish

COMPLETION

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

bash

To activate bash completion for this script, put:

 complete -C dux dux

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

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

SOURCE

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

BUGS

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

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