Skip to content

Commit 14171cd

Browse files
committed
Update manpage
1 parent 1110304 commit 14171cd

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

man/shards.1

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ dependencies aren't satisfied.
4141
.PP
4242
\fBinit\fR
4343
.RS 4
44-
Initializes a shard folder and creates a default \fIshard.yml\fR.
44+
Initializes a default \fIshard.yml\fR in the current folder.
4545
.RE
4646
.PP
4747
\fBinstall\fR
@@ -56,37 +56,52 @@ a requirement, but may succeed if a new dependency was added, as long as it
5656
doesn't generate a conflict, thus generating a new \fIshard.lock\fR file.
5757
.RE
5858
.PP
59-
\fBlist\fR
59+
\fBlist [--tree]\fR
6060
.RS 4
61-
Lists the installed dependencies and their versions.
61+
Lists the installed dependencies and their versions. Specifying \fI--tree\fR
62+
will list nested dependencies in a tree manner, instead of a flattened list.
63+
.RE
64+
.PP
65+
\fBlock [--update [<shards>]]\fR
66+
.RS 4
67+
Resolves dependencies and creates or updates the \fIshard.lock\fR file as per
68+
the \fBinstall\fR command, but never installs the dependencies.
69+
.PP
70+
Specifying \fI--update\fR follows the same semantics as the \fBupdate\fR
71+
command.
6272
.RE
6373
.PP
6474
\fBprune\fR
6575
.RS 4
6676
Removes unused dependencies from \fIlib\fR folder.
6777
.RE
6878
.PP
69-
\fBupdate\fR
79+
\fBupdate [<shards>]\fR
7080
.RS 4
7181
Resolves and updates all dependencies into the \fIlib\fR folder again,
7282
whatever the locked versions and commits in the \fIshard.lock\fR file.
83+
.PP
84+
Specifying \fIshards\fR will update these dependencies only, trying to be as
85+
conservative as possible with other dependencies, respecting the locked versions
86+
and commits in the \fIshard.lock\fR file.
87+
.PP
7388
Eventually generates a new \fIshard.lock\fR file.
7489
.RE
7590
.PP
7691
\fBversion\fR [\fI<path>\fR]
7792
.RS 4
78-
Prints the current version of the shard.
93+
Print the current version of the shard located at \fIpath\fR.
7994
.RE
8095
.SH OPTIONS
8196
.PP
8297
\fB\-\-version\fR
8398
.RS 4
84-
Prints the \fIshards\fR version.
99+
Print the \fIshards\fR version.
85100
.RE
86101
.PP
87102
\fB\-h, \-\-help\fR
88103
.RS 4
89-
Prints usage synopsis.
104+
Print usage synopsis.
90105
.RE
91106
.PP
92107
\fB\-\-no-color\fR
@@ -103,12 +118,12 @@ locked dependencies will be installed. Commands will fail if dependencies in
103118
.PP
104119
\fB\-q, \-\-quiet\fR
105120
.RS 4
106-
Decreases the log verbosity, printing only warnings and errors.
121+
Decrease the log verbosity, printing only warnings and errors.
107122
.RE
108123
.PP
109124
\fB\-v, \-\-verbose\fR
110125
.RS 4
111-
Increases the log verbosity, printing all debug statements.
126+
Increase the log verbosity, printing all debug statements.
112127
.REAUTHOR
113128
Written by Julien Portalier.
114129
.SH "REPORTING BUGS"

0 commit comments

Comments
 (0)