doc: improve cmd usage arguments

This commit is contained in:
André Roth
2024-11-28 12:03:42 +01:00
parent 397362bb1a
commit 83f7c869f0
4 changed files with 4 additions and 4 deletions

View File

@@ -91,7 +91,7 @@ func aptlyRepoAdd(cmd *commander.Command, args []string) error {
func makeCmdRepoAdd() *commander.Command { func makeCmdRepoAdd() *commander.Command {
cmd := &commander.Command{ cmd := &commander.Command{
Run: aptlyRepoAdd, Run: aptlyRepoAdd,
UsageLine: "add <name> <package file.deb>|<directory> ...", UsageLine: "add <name> (<package file.deb>|<directory>)...",
Short: "add packages to local repository", Short: "add packages to local repository",
Long: ` Long: `
Command adds packages to local repository from .deb, .udeb (binary packages) and .dsc (source packages) files. Command adds packages to local repository from .deb, .udeb (binary packages) and .dsc (source packages) files.

View File

@@ -86,7 +86,7 @@ func aptlyRepoInclude(cmd *commander.Command, args []string) error {
func makeCmdRepoInclude() *commander.Command { func makeCmdRepoInclude() *commander.Command {
cmd := &commander.Command{ cmd := &commander.Command{
Run: aptlyRepoInclude, Run: aptlyRepoInclude,
UsageLine: "include <file.changes>|<directory> ...", UsageLine: "include (<file.changes>|<directory>)...",
Short: "add packages to local repositories based on .changes files", Short: "add packages to local repositories based on .changes files",
Long: ` Long: `
Command include looks for .changes files in list of arguments or specified directories. Each Command include looks for .changes files in list of arguments or specified directories. Each

View File

@@ -84,7 +84,7 @@ func aptlySnapshotCreate(cmd *commander.Command, args []string) error {
func makeCmdSnapshotCreate() *commander.Command { func makeCmdSnapshotCreate() *commander.Command {
cmd := &commander.Command{ cmd := &commander.Command{
Run: aptlySnapshotCreate, Run: aptlySnapshotCreate,
UsageLine: "create <name> from mirror <mirror-name> | from repo <repo-name> | empty", UsageLine: "create <name> (from mirror <mirror-name> | from repo <repo-name> | empty)",
Short: "creates snapshot of mirror (local repository) contents", Short: "creates snapshot of mirror (local repository) contents",
Long: ` Long: `
Command create <name> from mirror makes persistent immutable snapshot of remote Command create <name> from mirror makes persistent immutable snapshot of remote

View File

@@ -131,7 +131,7 @@ func formatCommands(args []string) [][]string {
func makeCmdTaskRun() *commander.Command { func makeCmdTaskRun() *commander.Command {
cmd := &commander.Command{ cmd := &commander.Command{
Run: aptlyTaskRun, Run: aptlyTaskRun,
UsageLine: "run -filename=<filename> | <command1>, <command2>, ...", UsageLine: "run (-filename=<filename> | <commands>...)",
Short: "run aptly tasks", Short: "run aptly tasks",
Long: ` Long: `
Command helps organise multiple aptly commands in one single aptly task, running as single thread. Command helps organise multiple aptly commands in one single aptly task, running as single thread.