summaryrefslogtreecommitdiff
path: root/lib/Carton/Doc/List.pod
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Carton/Doc/List.pod')
-rw-r--r--lib/Carton/Doc/List.pod23
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/Carton/Doc/List.pod b/lib/Carton/Doc/List.pod
new file mode 100644
index 0000000..40c54e0
--- /dev/null
+++ b/lib/Carton/Doc/List.pod
@@ -0,0 +1,23 @@
+=head1 NAME
+
+Carton::Doc::List - List dependencies tracked in the cpanfile.snapshot file
+
+=head1 SYNOPSIS
+
+ carton list
+
+=head1 DESCRIPTION
+
+List the dependencies and version information tracked in the
+I<cpanfile.snapshot> file. This command by default displays the name of the
+distribution (e.g. I<Foo-Bar-0.01>) in a flat list.
+
+=head1 OPTIONS
+
+=over 4
+
+=item --distfile
+
+Displays the list of distributions in a distfile format (i.e. C<AUTHOR/Dist-1.23.tar.gz>)
+
+=back