Skip to content

Commit 99e9a39

Browse files
committed
help improvements
1 parent bf3721e commit 99e9a39

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

Sources/quickpkg/QuickPkg.swift

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,15 @@ let quickpkgVersion = "2.0.0"
77
struct QuickPkg: AsyncParsableCommand {
88
static let configuration = CommandConfiguration(
99
commandName: "quickpkg",
10-
abstract: "Build packages quickly from applications, disk images, or archives.",
10+
abstract: "Build packages quickly from installed applications, disk images, or zip archives.",
1111
discussion: """
1212
Quickly build a package from an installed application, a disk image file,
1313
or zip/xip archive with an enclosed application bundle.
1414
15-
The tool extracts the application name and version to name the resulting pkg file.
15+
The tool extracts the application name, version, and other metadata from the application
16+
for the package installer metadata and to name the resulting pkg file.
17+
18+
Example: quickpkg /path/to/installer_item
1619
""",
1720
version: quickpkgVersion
1821
)
@@ -24,7 +27,9 @@ struct QuickPkg: AsyncParsableCommand {
2427

2528
// MARK: - Installation Scripts
2629

27-
@Option(help: "Path to a folder with scripts")
30+
@Option(help: ArgumentHelp(
31+
"Path to a folder with scripts.",
32+
discussion: "If combined with --preinstall or --postinstall, scripts will be merged when possible."))
2833
var scripts: String?
2934

3035
@Option(name: [.long, .customLong("pre")], help: "Path to the preinstall script")
@@ -38,14 +43,16 @@ struct QuickPkg: AsyncParsableCommand {
3843
@Option(name: .customLong("install-location"), help: "Install location")
3944
var installLocation: String = "/Applications"
4045

41-
@Option(help: "Ownership setting: recommended, preserve, or preserve-other")
46+
@Option(help: "Ownership setting")
4247
var ownership: Ownership?
4348

44-
@Option(help: "Compression type: latest or legacy")
49+
@Option(help: "Compression type")
4550
var compression: Compression = .latest
4651

47-
@Option(name: [.customLong("output"), .customLong("out"), .short],
48-
help: "Output path (supports {name}, {version}, {identifier} placeholders)")
52+
@Option(name: [.customLong("output"), .short],
53+
help: ArgumentHelp(
54+
"Output path for the package.",
55+
discussion: "Supports {name}, {version}, {identifier} placeholders. (default filename: {name}-{version}.pkg)"))
4956
var output: String?
5057

5158
// MARK: - Flags

0 commit comments

Comments
 (0)