diff options
| author | Joshua Powers <josh.powers@canonical.com> | 2019-12-11 14:30:52 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-11 14:30:52 -0800 |
| commit | 37ffa8d2bf1d56769a40fea26228b82e33ab1fff (patch) | |
| tree | eeaef40e3f38d171f54897e4253e02a8ba15cc24 | |
| parent | e48081e7b88ae9add3c08cb248a2d3f99f863bd1 (diff) | |
| download | vyos-cloud-init-37ffa8d2bf1d56769a40fea26228b82e33ab1fff.tar.gz vyos-cloud-init-37ffa8d2bf1d56769a40fea26228b82e33ab1fff.zip | |
docs: add cloud-id manpage
| -rw-r--r-- | doc/man/cloud-id.1 | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/man/cloud-id.1 b/doc/man/cloud-id.1 new file mode 100644 index 00000000..98ce130c --- /dev/null +++ b/doc/man/cloud-id.1 @@ -0,0 +1,31 @@ +.TH CLOUD-ID 1 + +.SH NAME +cloud-id \- Report the canonical cloud-id for this instance + +.SH SYNOPSIS +.BR "cloud-id" " [-h] [-j] [-l] [-i <INSTANCE_DATA>]" + +.SH OPTIONS +.TP +.B "-h, --help" +Show help message and exit + +.TP +.B "-j, --json" +Report all standardized cloud-id information as json + +.TP +.B "-l, --long" +Report extended cloud-id information as tab-delimited string + +.TP +.BR "-i <data>, --instance-data <data>" +Path to instance-data.json file. Default is +/run/cloud-init/instance-data.json + +.SH COPYRIGHT +Copyright (C) 2020 Canonical Ltd. License GPL-3 or Apache-2.0 + +.SH SEE ALSO +Full documentation at: <https://cloudinit.readthedocs.io> |