| Current Path : /proc/thread-self/root/proc/self/root/usr/local/share/man/man3/ |
| Current File : //proc/thread-self/root/proc/self/root/usr/local/share/man/man3/Mojolicious::Command::get.3pm |
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mojolicious::Command::get 3"
.TH Mojolicious::Command::get 3 "2023-03-08" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mojolicious::Command::get \- Get command
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& Usage: APPLICATION get [OPTIONS] URL [SELECTOR|JSON\-POINTER] [COMMANDS]
\&
\& ./myapp.pl get /
\& ./myapp.pl get \-H \*(AqAccept: text/html\*(Aq /hello.html \*(Aqhead > title\*(Aq text
\& ./myapp.pl get //sri:secr3t@/secrets.json /1/content
\& mojo get mojolicious.org
\& mojo get \-v \-r \-o 25 \-i 50 google.com
\& mojo get \-v \-H \*(AqHost: mojolicious.org\*(Aq \-H \*(AqAccept: */*\*(Aq mojolicious.org
\& mojo get \-u \*(Aqsri:s3cret\*(Aq https://mojolicious.org
\& mojo get mojolicious.org > example.html
\& mojo get \-M PUT mojolicious.org < example.html
\& mojo get \-f \*(Aqq=Mojolicious\*(Aq \-f \*(Aqsize=5\*(Aq https://metacpan.org/search
\& mojo get \-M POST \-f \*(Aqupload=@example.html\*(Aq mojolicious.org
\& mojo get mojolicious.org \*(Aqhead > title\*(Aq text
\& mojo get mojolicious.org .footer all
\& mojo get mojolicious.org a attr href
\& mojo get mojolicious.org \*(Aq*\*(Aq attr id
\& mojo get mojolicious.org \*(Aqh1, h2, h3\*(Aq 3 text
\& mojo get https://fastapi.metacpan.org/v1/author/SRI /name
\& mojo get \-H \*(AqHost: example.com\*(Aq http+unix://%2Ftmp%2Fmyapp.sock/index.html
\&
\& Options:
\& \-C, \-\-charset <charset> Charset of HTML/XML content, defaults
\& to auto\-detection
\& \-c, \-\-content <content> Content to send with request
\& \-f, \-\-form <name=value> One or more form values and file
\& uploads
\& \-H, \-\-header <name:value> One or more additional HTTP headers
\& \-h, \-\-help Show this summary of available options
\& \-\-home <path> Path to home directory of your
\& application, defaults to the value of
\& MOJO_HOME or auto\-detection
\& \-i, \-\-inactivity\-timeout <seconds> Inactivity timeout, defaults to the
\& value of MOJO_INACTIVITY_TIMEOUT or 40
\& \-k, \-\-insecure Do not require a valid TLS certificate
\& to access HTTPS sites
\& \-M, \-\-method <method> HTTP method to use, defaults to "GET"
\& \-m, \-\-mode <name> Operating mode for your application,
\& defaults to the value of
\& MOJO_MODE/PLACK_ENV or "development"
\& \-o, \-\-connect\-timeout <seconds> Connect timeout, defaults to the value
\& of MOJO_CONNECT_TIMEOUT or 10
\& \-r, \-\-redirect Follow up to 10 redirects
\& \-S, \-\-response\-size <size> Maximum response size in bytes,
\& defaults to 2147483648 (2GiB)
\& \-u, \-\-user <userinfo> Alternate mechanism for specifying
\& colon\-separated username and password
\& \-v, \-\-verbose Print request and response headers to
\& STDERR
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mojolicious::Command::get performs requests to remote hosts or local applications.
.PP
This is a core command, that means it is always enabled and its code a good example for learning to build new commands,
you're welcome to fork it.
.PP
See \*(L"\s-1COMMANDS\*(R"\s0 in Mojolicious::Commands for a list of commands that are available by default.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
Mojolicious::Command::get inherits all attributes from Mojolicious::Command and implements the following new
ones.
.SS "description"
.IX Subsection "description"
.Vb 2
\& my $description = $get\->description;
\& $get = $get\->description(\*(AqFoo\*(Aq);
.Ve
.PP
Short description of this command, used for the command list.
.SS "usage"
.IX Subsection "usage"
.Vb 2
\& my $usage = $get\->usage;
\& $get = $get\->usage(\*(AqFoo\*(Aq);
.Ve
.PP
Usage information for this command, used for the help screen.
.SH "METHODS"
.IX Header "METHODS"
Mojolicious::Command::get inherits all methods from Mojolicious::Command and implements the following new ones.
.SS "run"
.IX Subsection "run"
.Vb 1
\& $get\->run(@ARGV);
.Ve
.PP
Run this command.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.