-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
remove md_doc generation & add man docs
Signed-off-by: bupd <bupdprasanth@gmail.com>
- Loading branch information
Showing
38 changed files
with
1,732 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| .nh | ||
| .TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" | ||
|
|
||
| .SH NAME | ||
| .PP | ||
| harbor-artifact-delete - delete an artifact | ||
|
|
||
|
|
||
| .SH SYNOPSIS | ||
| .PP | ||
| \fBharbor artifact delete [flags]\fP | ||
|
|
||
|
|
||
| .SH DESCRIPTION | ||
| .PP | ||
| delete an artifact | ||
|
|
||
|
|
||
| .SH OPTIONS | ||
| .PP | ||
| \fB-h\fP, \fB--help\fP[=false] | ||
| help for delete | ||
|
|
||
|
|
||
| .SH OPTIONS INHERITED FROM PARENT COMMANDS | ||
| .PP | ||
| \fB--config\fP="/home/bupd/.harbor/config.yaml" | ||
| config file (default is $HOME/.harbor/config.yaml) | ||
|
|
||
| .PP | ||
| \fB-o\fP, \fB--output-format\fP="" | ||
| Output format. One of: json|yaml | ||
|
|
||
| .PP | ||
| \fB-v\fP, \fB--verbose\fP[=false] | ||
| verbose output | ||
|
|
||
|
|
||
| .SH SEE ALSO | ||
| .PP | ||
| \fBharbor-artifact(1)\fP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| .nh | ||
| .TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" | ||
|
|
||
| .SH NAME | ||
| .PP | ||
| harbor-artifact-info - Get info of an artifact | ||
|
|
||
|
|
||
| .SH SYNOPSIS | ||
| .PP | ||
| \fBharbor artifact info [flags]\fP | ||
|
|
||
|
|
||
| .SH DESCRIPTION | ||
| .PP | ||
| Get info of an artifact | ||
|
|
||
|
|
||
| .SH OPTIONS | ||
| .PP | ||
| \fB-h\fP, \fB--help\fP[=false] | ||
| help for info | ||
|
|
||
|
|
||
| .SH OPTIONS INHERITED FROM PARENT COMMANDS | ||
| .PP | ||
| \fB--config\fP="/home/bupd/.harbor/config.yaml" | ||
| config file (default is $HOME/.harbor/config.yaml) | ||
|
|
||
| .PP | ||
| \fB-o\fP, \fB--output-format\fP="" | ||
| Output format. One of: json|yaml | ||
|
|
||
| .PP | ||
| \fB-v\fP, \fB--verbose\fP[=false] | ||
| verbose output | ||
|
|
||
|
|
||
| .SH EXAMPLE | ||
| .EX | ||
| harbor artifact info <project>/<repository>/<reference> | ||
| .EE | ||
|
|
||
|
|
||
| .SH SEE ALSO | ||
| .PP | ||
| \fBharbor-artifact(1)\fP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| .nh | ||
| .TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" | ||
|
|
||
| .SH NAME | ||
| .PP | ||
| harbor-artifact-list - list artifacts within a repository | ||
|
|
||
|
|
||
| .SH SYNOPSIS | ||
| .PP | ||
| \fBharbor artifact list [flags]\fP | ||
|
|
||
|
|
||
| .SH DESCRIPTION | ||
| .PP | ||
| list artifacts within a repository | ||
|
|
||
|
|
||
| .SH OPTIONS | ||
| .PP | ||
| \fB-h\fP, \fB--help\fP[=false] | ||
| help for list | ||
|
|
||
|
|
||
| .SH OPTIONS INHERITED FROM PARENT COMMANDS | ||
| .PP | ||
| \fB--config\fP="/home/bupd/.harbor/config.yaml" | ||
| config file (default is $HOME/.harbor/config.yaml) | ||
|
|
||
| .PP | ||
| \fB-o\fP, \fB--output-format\fP="" | ||
| Output format. One of: json|yaml | ||
|
|
||
| .PP | ||
| \fB-v\fP, \fB--verbose\fP[=false] | ||
| verbose output | ||
|
|
||
|
|
||
| .SH SEE ALSO | ||
| .PP | ||
| \fBharbor-artifact(1)\fP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| .nh | ||
| .TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" | ||
|
|
||
| .SH NAME | ||
| .PP | ||
| harbor-artifact-scan-start - Start a scan of an artifact | ||
|
|
||
|
|
||
| .SH SYNOPSIS | ||
| .PP | ||
| \fBharbor artifact scan start [flags]\fP | ||
|
|
||
|
|
||
| .SH DESCRIPTION | ||
| .PP | ||
| Start a scan of an artifact in Harbor Repository | ||
|
|
||
|
|
||
| .SH OPTIONS | ||
| .PP | ||
| \fB-h\fP, \fB--help\fP[=false] | ||
| help for start | ||
|
|
||
|
|
||
| .SH OPTIONS INHERITED FROM PARENT COMMANDS | ||
| .PP | ||
| \fB--config\fP="/home/bupd/.harbor/config.yaml" | ||
| config file (default is $HOME/.harbor/config.yaml) | ||
|
|
||
| .PP | ||
| \fB-o\fP, \fB--output-format\fP="" | ||
| Output format. One of: json|yaml | ||
|
|
||
| .PP | ||
| \fB-v\fP, \fB--verbose\fP[=false] | ||
| verbose output | ||
|
|
||
|
|
||
| .SH EXAMPLE | ||
| .EX | ||
| harbor artifact scan start <project>/<repository>/<reference> | ||
| .EE | ||
|
|
||
|
|
||
| .SH SEE ALSO | ||
| .PP | ||
| \fBharbor-artifact-scan(1)\fP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| .nh | ||
| .TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" | ||
|
|
||
| .SH NAME | ||
| .PP | ||
| harbor-artifact-scan-stop - Stop a scan of an artifact | ||
|
|
||
|
|
||
| .SH SYNOPSIS | ||
| .PP | ||
| \fBharbor artifact scan stop [flags]\fP | ||
|
|
||
|
|
||
| .SH DESCRIPTION | ||
| .PP | ||
| Stop a scan of an artifact in Harbor Repository | ||
|
|
||
|
|
||
| .SH OPTIONS | ||
| .PP | ||
| \fB-h\fP, \fB--help\fP[=false] | ||
| help for stop | ||
|
|
||
|
|
||
| .SH OPTIONS INHERITED FROM PARENT COMMANDS | ||
| .PP | ||
| \fB--config\fP="/home/bupd/.harbor/config.yaml" | ||
| config file (default is $HOME/.harbor/config.yaml) | ||
|
|
||
| .PP | ||
| \fB-o\fP, \fB--output-format\fP="" | ||
| Output format. One of: json|yaml | ||
|
|
||
| .PP | ||
| \fB-v\fP, \fB--verbose\fP[=false] | ||
| verbose output | ||
|
|
||
|
|
||
| .SH EXAMPLE | ||
| .EX | ||
| harbor artifact scan stop <project>/<repository>/<reference> | ||
| .EE | ||
|
|
||
|
|
||
| .SH SEE ALSO | ||
| .PP | ||
| \fBharbor-artifact-scan(1)\fP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| .nh | ||
| .TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" | ||
|
|
||
| .SH NAME | ||
| .PP | ||
| harbor-artifact-scan - Scan an artifact | ||
|
|
||
|
|
||
| .SH SYNOPSIS | ||
| .PP | ||
| \fBharbor artifact scan [flags]\fP | ||
|
|
||
|
|
||
| .SH DESCRIPTION | ||
| .PP | ||
| Scan an artifact in Harbor Repository | ||
|
|
||
|
|
||
| .SH OPTIONS | ||
| .PP | ||
| \fB-h\fP, \fB--help\fP[=false] | ||
| help for scan | ||
|
|
||
|
|
||
| .SH OPTIONS INHERITED FROM PARENT COMMANDS | ||
| .PP | ||
| \fB--config\fP="/home/bupd/.harbor/config.yaml" | ||
| config file (default is $HOME/.harbor/config.yaml) | ||
|
|
||
| .PP | ||
| \fB-o\fP, \fB--output-format\fP="" | ||
| Output format. One of: json|yaml | ||
|
|
||
| .PP | ||
| \fB-v\fP, \fB--verbose\fP[=false] | ||
| verbose output | ||
|
|
||
|
|
||
| .SH EXAMPLE | ||
| .EX | ||
| harbor artifact scan start <project>/<repository>/<reference> | ||
| .EE | ||
|
|
||
|
|
||
| .SH SEE ALSO | ||
| .PP | ||
| \fBharbor-artifact(1)\fP, \fBharbor-artifact-scan-start(1)\fP, \fBharbor-artifact-scan-stop(1)\fP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| .nh | ||
| .TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" | ||
|
|
||
| .SH NAME | ||
| .PP | ||
| harbor-artifact-tags-create - Create a tag of an artifact | ||
|
|
||
|
|
||
| .SH SYNOPSIS | ||
| .PP | ||
| \fBharbor artifact tags create [flags]\fP | ||
|
|
||
|
|
||
| .SH DESCRIPTION | ||
| .PP | ||
| Create a tag of an artifact | ||
|
|
||
|
|
||
| .SH OPTIONS | ||
| .PP | ||
| \fB-h\fP, \fB--help\fP[=false] | ||
| help for create | ||
|
|
||
|
|
||
| .SH OPTIONS INHERITED FROM PARENT COMMANDS | ||
| .PP | ||
| \fB--config\fP="/home/bupd/.harbor/config.yaml" | ||
| config file (default is $HOME/.harbor/config.yaml) | ||
|
|
||
| .PP | ||
| \fB-o\fP, \fB--output-format\fP="" | ||
| Output format. One of: json|yaml | ||
|
|
||
| .PP | ||
| \fB-v\fP, \fB--verbose\fP[=false] | ||
| verbose output | ||
|
|
||
|
|
||
| .SH EXAMPLE | ||
| .EX | ||
| harbor artifact tags create <project>/<repository>/<reference> <tag> | ||
| .EE | ||
|
|
||
|
|
||
| .SH SEE ALSO | ||
| .PP | ||
| \fBharbor-artifact-tags(1)\fP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| .nh | ||
| .TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" | ||
|
|
||
| .SH NAME | ||
| .PP | ||
| harbor-artifact-tags-delete - Delete a tag of an artifact | ||
|
|
||
|
|
||
| .SH SYNOPSIS | ||
| .PP | ||
| \fBharbor artifact tags delete [flags]\fP | ||
|
|
||
|
|
||
| .SH DESCRIPTION | ||
| .PP | ||
| Delete a tag of an artifact | ||
|
|
||
|
|
||
| .SH OPTIONS | ||
| .PP | ||
| \fB-h\fP, \fB--help\fP[=false] | ||
| help for delete | ||
|
|
||
|
|
||
| .SH OPTIONS INHERITED FROM PARENT COMMANDS | ||
| .PP | ||
| \fB--config\fP="/home/bupd/.harbor/config.yaml" | ||
| config file (default is $HOME/.harbor/config.yaml) | ||
|
|
||
| .PP | ||
| \fB-o\fP, \fB--output-format\fP="" | ||
| Output format. One of: json|yaml | ||
|
|
||
| .PP | ||
| \fB-v\fP, \fB--verbose\fP[=false] | ||
| verbose output | ||
|
|
||
|
|
||
| .SH EXAMPLE | ||
| .EX | ||
| harbor artifact tags delete <project>/<repository>/<reference> <tag> | ||
| .EE | ||
|
|
||
|
|
||
| .SH SEE ALSO | ||
| .PP | ||
| \fBharbor-artifact-tags(1)\fP |
Oops, something went wrong.