view release on metacpan or  search on metacpan

script/upf-get-user  view on Meta::CPAN

#!perl

# Note: This script is a CLI for Riap function /Unix/Passwd/File/get_user
# and generated automatically using Perinci::CmdLine::Gen version 0.496

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2020-04-29'; # DATE
our $DIST = 'App-UpfUtils'; # DIST
our $VERSION = '0.060'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/Unix/Passwd/File/get_user",
    program_name => "upf-get-user",
    read_config => 0,
    read_env => 0,
);

$cmdline->run;

# ABSTRACT: Get user details by username or uid
# PODNAME: upf-get-user

__END__

=pod

=encoding UTF-8

=head1 NAME

upf-get-user - Get user details by username or uid

=head1 VERSION

This document describes version 0.060 of upf-get-user (from Perl distribution App-UpfUtils), released on 2020-04-29.

=head1 SYNOPSIS

Usage:

 % upf-get-user [--etc-dir=s] [--format=name] [--json] [--(no)naked-res]
     [--page-result[=program]] [--uid=s] [--user=s] [--with-field-names]
     [--without-field-names]

=head1 DESCRIPTION

Either C<user> OR C<uid> must be specified.

The function is not dissimilar to Unix's C<getpwnam()> or C<getpwuid()>.

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--uid>=I<s>

=item B<--user>=I<s>

=item B<--without-field-names>

By default, a hashref is returned containing field names and its values, e.g.
`{user=>"titin", pass=>"x", uid=>500, ...}`. With `with_field_names=>0`, an
arrayref is returned instead: `["titin", "x", 500, ...]`.


=back

=head2 Output options

=over

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:

 undef

=item B<--json>

Set output format to json.

=item B<--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]


=item B<--page-result>