NAME

metasyn - Alternative front-end to Acme::MetaSyntactic

VERSION

This document describes version 0.008 of main (from Perl distribution App-metasyn), released on 2021-06-26.

SYNOPSIS

Usage:

 % metasyn [-R] [-T] [--action=s] [-c] [--categories] [--config-path=path+]
     [--config-profile=profile] [--format=name] [--json] [-l] [-n=s]
     [--(no)naked-res] [--no-config] [--no-env] [--number=s]
     [--page-result[=program]] [--random-theme] [--shuffle]
     [--view-result[=program]] [theme]

Examples:

List all names from the default theme, foo:

 % metasyn
 foo
 bar
 baz
 foobar
 fubar
 ... 37 more lines ...
 does
 hok
 duif
 schapen

Return a single random name from the default theme (equivalent to: "meta"):

 % metasyn -n1 -R
 xyzzy

List all names from a theme:

 % metasyn christmas
 bushy
 evergreen
 shinny
 upatree
 wunorse
 ... 59 more lines ...
 mcicicles
 mcblizzard
 mcsparkles
 mcsnowflakes

List all names from a category of a theme in random order, return only 3 (equivalent to: "meta christmas/elf 3"):

 % metasyn christmas/elf -n3 -R
 alabaster
 shinny
 wunorse

Return a single random name from a theme (equivalent to: "meta christmas"):

 % metasyn christmas -n1 -R
 upatree

Return a single random name from a random theme:

 % metasyn -T -n1 -R
 XFER

List all installed themes (equivalent to: "meta --themes"):

 % metasyn -l
 abba
 afke
 alice
 alphabet
 amber
 ... 136 more lines ...
 wales_towns
 weekdays
 yapc
 zodiac

List 3 random themes (equivalent to: "meta --themes | shuf | head -n3"):

 % metasyn -l -n3 -R
 barbarella
 constellations
 icao

List all installed themes, along with all their categories:

 % metasyn -l -c
 abba
 afke
 alice
 alphabet/en
 alphabet/gr
 ... 2221 more lines ...
 zodiac/Vedic
 zodiac/Western
 zodiac/Western/Real
 zodiac/Western/Traditional

List all categories from a theme:

 % metasyn christmas -c
 elf
 reindeer
 santa
 snowman

List 2 categories from a theme, in random order:

 % metasyn christmas -c -n2 -R
 snowman
 santa

DESCRIPTION

This script is an alternative front-end for Acme::MetaSyntactic. Compared to the official CLI meta, this CLI currently does not retrieve themes/names remotely but:

provides shell completion (but see App::ShellCompleter::meta to add tab completion for the official CLI);
provides an option to shuffle list of themes/categories/names returned;
makes it easy to print all names in a theme;
makes it easy to print all (or some) categories in a theme.

This CLI is more geared towards listing all themes/names/categories instead of picking random ones.

OPTIONS

* marks required options.

Main options

--action=s

Default value:

 "list-names"

Valid values:

 ["list-themes","list-names"]

--categories, -c

--number=s, -n

Limit only return this number of results.

--random-theme, -T

--shuffle, -R

--theme=s

Can also be specified as the 1st command-line argument.

-l

List installed themes.

See --action.

Configuration options

--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--no-config

Do not use any configuration file.

Environment options

--no-env: Do not read environment for default options.

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:

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]

--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?: Display help message and exit.
--version, -v: Display program's version and exit.

COMPLETION

The script comes with a companion shell completer script (_metasyn) for this script.

bash

To activate bash completion for this script, put:

 complete -C _metasyn metasyn

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

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.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/metasyn.conf, ~/metasyn.conf, or /etc/metasyn.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

 action (see --action)
 categories (see --categories)
 format (see --format)
 naked_res (see --naked-res)
 number (see --number)
 random_theme (see --random-theme)
 shuffle (see --shuffle)
 theme (see --theme)

ENVIRONMENT

METASYN_OPT => str

Specify additional command-line options.

FILES

~/.config/metasyn.conf

~/metasyn.conf

/etc/metasyn.conf

HOMEPAGE

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

SOURCE

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

BUGS

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

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 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::metasyn, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::metasyn

CPAN shell

perl -MCPAN -e shell
install App::metasyn

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

OPTIONS

Main options

Configuration options

Environment options

Output options

Other options

COMPLETION

bash

tcsh

other shells

CONFIGURATION FILE

ENVIRONMENT

METASYN_OPT => str

FILES

HOMEPAGE

SOURCE

BUGS

SEE ALSO

AUTHOR

COPYRIGHT AND LICENSE

Module Install Instructions