.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::routes 3pm"
.TH Mojolicious::Command::routes 3pm 2024-05-15 "perl v5.38.2" "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::routes \- Routes command
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  Usage: APPLICATION routes [OPTIONS]
\&
\&    ./myapp.pl routes
\&    ./myapp.pl routes \-v
\&
\&  Options:
\&    \-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
\&    \-m, \-\-mode <name>   Operating mode for your application, defaults to the
\&                        value of MOJO_MODE/PLACK_ENV or "development"
\&    \-v, \-\-verbose       Print additional details about routes, flags indicate
\&                        C=Conditions, P=Partial, U=Under and W=WebSocket
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mojolicious::Command::routes lists all your application routes.
.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 "COMMANDS" in Mojolicious::Commands for a list of commands that are available by default.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
Mojolicious::Command::routes inherits all attributes from Mojolicious::Command and implements the following new
ones.
.SS description
.IX Subsection "description"
.Vb 2
\&  my $description = $routes\->description;
\&  $routes         = $routes\->description(\*(AqFoo\*(Aq);
.Ve
.PP
Short description of this command, used for the command list.
.SS usage
.IX Subsection "usage"
.Vb 2
\&  my $usage = $routes\->usage;
\&  $routes   = $routes\->usage(\*(AqFoo\*(Aq);
.Ve
.PP
Usage information for this command, used for the help screen.
.SH METHODS
.IX Header "METHODS"
Mojolicious::Command::routes inherits all methods from Mojolicious::Command and implements the following new
ones.
.SS run
.IX Subsection "run"
.Vb 1
\&  $routes\->run(@ARGV);
.Ve
.PP
Run this command.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.