Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update the doc

  • Loading branch information...
commit 1294031ed88bb98f20cf8990d1d293451256c173 1 parent 7f79f25
@samoht samoht authored
View
10 doc/man/opam-config.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-CONFIG" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-CONFIG" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
@@ -30,14 +30,14 @@ Use sh\-compatible mode for configuring OPAM.
\fB\-\-csh\fR
Use csh\-compatible mode for configuring OPAM.
.TP 4
-\fB\-\-dot\-profile\fR=\fIFILENAME\fR (absent=/Users/tgazagna/.profile)
-Name of the configuration file to update (if necessary).
+\fB\-\-dot\-profile\fR=\fIFILENAME\fR
+Name of the configuration file to update instead of \fI~/.profile\fR or \fI~/.zshrc\fR based on shell detection.
.TP 4
\fB\-e\fR \fIVAL\fR
Backward\-compatible option, equivalent to \fBopam config env\fR.
.TP 4
\fB\-g\fR, \fB\-\-global\fR
-Enbale all the global configuration options.
+Enable all the global configuration options.
.TP 4
\fB\-l\fR, \fB\-\-list\fR
List the current configuration.
@@ -52,7 +52,7 @@ Do not install `opam\-switch\-eval` to switch & eval using a single command.
Modify ~/.ocamlinit to make `#use "topfind"` works in the toplevel.
.TP 4
\fB\-\-profile\fR
-Modify ~/.profile to setup an OPAM\-friendly environment when starting a new shell.
+Modify ~/.profile (or ~/.zshrc if running zsh) to setup an OPAM\-friendly environment when starting a new shell.
.TP 4
\fB\-R\fR, \fB\-\-rec\fR
Recursive query.
View
2  doc/man/opam-help.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-HELP" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-HELP" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-info.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-INFO" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-INFO" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
8 doc/man/opam-init.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-INIT" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-INIT" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
@@ -14,7 +14,7 @@ opam\-init \- Initialize OPAM state.
.P
The \fBinit\fR command creates a fresh client state. This initializes OPAM configuration in \fI~/.opam\fR and configures a default package repository.
.P
-Once the fresh client has been created, OPAM will ask the user if he wants \fI~/.profile\fR and \fI~/.ocamlinit\fR to be updated. If \fB\-\-auto\-setup\fR is used, OPAM will modify the configuration files automatically, without asking the user. If \fB\-\-no\-setup\fR is used, OPAM will *NOT* modify anything outside of \fI~/.opam\fR.
+Once the fresh client has been created, OPAM will ask the user if he wants \fI~/.profile\fR (or i,~/.zshrc, depending on his shell) and \fI~/.ocamlinit\fR to be updated. If \fB\-\-auto\-setup\fR is used, OPAM will modify the configuration files automatically, without asking the user. If \fB\-\-no\-setup\fR is used, OPAM will *NOT* modify anything outside of \fI~/.opam\fR.
.P
Additional repositories can be added later by using the \fBopam repository\fR command.
.P
@@ -51,8 +51,8 @@ Save the CUDF request sent to the solver to \fIFILENAME\fR\-<n>.cudf.
\fB\-d\fR, \fB\-\-build\-doc\fR
Build the package documentation. This is equivalent to setting \fB$OPAMBUILDDOC\fR to a non\-empty string.
.TP 4
-\fB\-\-dot\-profile\fR=\fIFILENAME\fR (absent=/Users/tgazagna/.profile)
-Name of the configuration file to update (if necessary).
+\fB\-\-dot\-profile\fR=\fIFILENAME\fR
+Name of the configuration file to update instead of \fI~/.profile\fR or \fI~/.zshrc\fR based on shell detection.
.TP 4
\fB\-\-dry\-run\fR
Simply call the solver without actually performing any build/install operations.
View
2  doc/man/opam-install.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-INSTALL" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-INSTALL" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-list.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-LIST" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-LIST" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-pin.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-PIN" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-PIN" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-reinstall.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-REINSTALL" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-REINSTALL" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-remote.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-REMOTE" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-REMOTE" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-remove.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-REMOVE" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-REMOVE" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-repository.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-REPOSITORY" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-REPOSITORY" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-search.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-SEARCH" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-SEARCH" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-switch.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-SWITCH" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-SWITCH" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-update.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-UPDATE" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-UPDATE" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-upgrade.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-UPGRADE" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-UPGRADE" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam-upload.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM-UPLOAD" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM-UPLOAD" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
View
2  doc/man/opam.1
@@ -1,6 +1,6 @@
.\" Pipe this output to groff -man -Tutf8 | less
.\"
-.TH "OPAM" 1 "" "Opam 0.9.5" "Opam Manual"
+.TH "OPAM" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
Please sign in to comment.
Something went wrong with that request. Please try again.