/ 
Acme-CPANModules-Parse-UnixShellCommandLine-0.003
River stage one • 1 direct dependent • 1 total dependent
/ Acme::CPANModules::Parse::UnixShellCommandLine

NAME

Acme::CPANModules::Parse::UnixShellCommandLine - List of modules that parse command-line like Unix shells

VERSION

This document describes version 0.003 of Acme::CPANModules::Parse::UnixShellCommandLine (from Perl distribution Acme-CPANModules-Parse-UnixShellCommandLine), released on 2023-10-31.

DESCRIPTION

Sometimes you need to parse a Unix shell command-line string, e.g. when you want to break it into "words".

In general I recommend Text::ParseWords as it is a core module. If you want a little more speed, try Parse::CommandLine::Regexp (see reference to benchmark in See Also).

ACME::CPANMODULES ENTRIES

Complete::Bash

Author: PERLANCAR

Its parse_cmdline() function can break a command-line string into words. This function is geared for tab completion, so by default it also breaks on some other word-breaking characters like "=", "@", and so on. Probably not what you want generally, unless you are working with tab completion.

Complete::Zsh

Author: PERLANCAR

Complete::Fish

Author: PERLANCAR

Complete::Tcsh

Author: PERLANCAR

Text::ParseWords

Author: NEILB

This core module can split string into words with customizable quoting character and support for escaping using backslash. Its shellwords() function is suitable for breaking command-line string into words.

Parse::CommandLine

Author: SONGMU

Parse::CommandLine::Regexp

Author: PERLANCAR

FAQ

What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module names that share a common characteristics. It is a way to categorize modules and document CPAN. See Acme::CPANModules for more details.

What are ways to use this Acme::CPANModules module?

Aside from reading this Acme::CPANModules module's POD documentation, you can install all the listed modules (entries) using cpanm-cpanmodules script (from App::cpanm::cpanmodules distribution):

% cpanm-cpanmodules -n Parse::UnixShellCommandLine

Alternatively you can use the cpanmodules CLI (from App::cpanmodules distribution):

% cpanmodules ls-entries Parse::UnixShellCommandLine | cpanm -n

or Acme::CM::Get:

% perl -MAcme::CM::Get=Parse::UnixShellCommandLine -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

or directly:

% perl -MAcme::CPANModules::Parse::UnixShellCommandLine -E'say $_->{module} for @{ $Acme::CPANModules::Parse::UnixShellCommandLine::LIST->{entries} }' | cpanm -n

This Acme::CPANModules module also helps lcpan produce a more meaningful result for lcpan related-mods command when it comes to finding related modules for the modules listed in this Acme::CPANModules module. See App::lcpan::Cmd::related_mods for more details on how "related modules" are found.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Acme-CPANModules-Parse-UnixShellCommandLine.

SOURCE

Source repository is at https://github.com/perlancar/perl-Acme-CPANModules-Parse-UnixShellCommandLine.

SEE ALSO

Acme::CPANModules - about the Acme::CPANModules namespace

cpanmodules - CLI tool to let you browse/view the lists

Bencher::Scenario::CmdLineParsingModules

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2021 by perlancar <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.

BUGS

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

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.