summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTatsuhiko Miyagawa <miyagawa@bulknews.net>2013-07-23 02:00:51 -0700
committerTatsuhiko Miyagawa <miyagawa@bulknews.net>2013-07-23 02:00:51 -0700
commitbc43709244ac732d8e094bfa83a168f934969e92 (patch)
treee222a88d8ce5f266bd1a6940671391dbcc2aed76
parent8603ef3f3fbc9d1b2ae7986401199e6255515bb7 (diff)
downloadcarton-cpanfile-location.tar.gz
Document --cpanfilecpanfile-location
-rw-r--r--lib/Carton/Doc/Install.pod14
1 files changed, 13 insertions, 1 deletions
diff --git a/lib/Carton/Doc/Install.pod b/lib/Carton/Doc/Install.pod
index 7644228..785a6e2 100644
--- a/lib/Carton/Doc/Install.pod
+++ b/lib/Carton/Doc/Install.pod
@@ -52,9 +52,21 @@ dependencies.
Force the deployment mode and carton will ignore I<cpanfile> contents.
+=item --cpanfile
+
+Specify the alternate path for cpanfile. By default, C<carton install>
+will look for the file C<cpanfile> in the current directory, then
+upwards till the root directory, in case the command runs from a sub
+directory.
+
+Carton assumes the directory where your cpanfile (or altenate path)
+exists as a project root directory, and will look for the lock file as
+well as install directory (C<local>) and C<vendor/cache> relative to it.
+
=item --path
-Specify the path to install modules to. Defaults to I<local> in the current directory.
+Specify the path to install modules to. Defaults to I<local> in the
+directory relative to where C<cpanfile> is.
=item --without