summaryrefslogtreecommitdiffstats
path: root/src/doc/man/cargo-generate-lockfile.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/doc/man/cargo-generate-lockfile.md')
-rw-r--r--src/doc/man/cargo-generate-lockfile.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/src/doc/man/cargo-generate-lockfile.md b/src/doc/man/cargo-generate-lockfile.md
new file mode 100644
index 0000000..3a2f52b
--- /dev/null
+++ b/src/doc/man/cargo-generate-lockfile.md
@@ -0,0 +1,49 @@
+# cargo-generate-lockfile(1)
+
+## NAME
+
+cargo-generate-lockfile --- Generate the lockfile for a package
+
+## SYNOPSIS
+
+`cargo generate-lockfile` [_options_]
+
+## DESCRIPTION
+
+This command will create the `Cargo.lock` lockfile for the current package or
+workspace. If the lockfile already exists, it will be rebuilt with the latest
+available version of every package.
+
+See also {{man "cargo-update" 1}} which is also capable of creating a `Cargo.lock`
+lockfile and has more options for controlling update behavior.
+
+## OPTIONS
+
+### Display Options
+
+{{#options}}
+{{> options-display }}
+{{/options}}
+
+### Manifest Options
+
+{{#options}}
+{{> options-manifest-path }}
+
+{{> options-locked }}
+{{/options}}
+
+{{> section-options-common }}
+
+{{> section-environment }}
+
+{{> section-exit-status }}
+
+## EXAMPLES
+
+1. Create or update the lockfile for the current package or workspace:
+
+ cargo generate-lockfile
+
+## SEE ALSO
+{{man "cargo" 1}}, {{man "cargo-update" 1}}