Skip to content

Commit fb3eb0f

Browse files
committed
updated Readme for 0.3
1 parent 88c2793 commit fb3eb0f

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,42 @@ quickpkg ~/Downloads/Things.zip
3232

3333
Pass a folder with scripts that are passed to `pkgbuild`'s `--scripts` option. If the there is a `preinstall` and/or `postinstall` script they will be run at the respective and can call other scripts in this folder.
3434

35+
### `--postinstall postinstall_script`
36+
37+
Use the script file given as a postinstall script. If given together with the `-scripts` option will attempt to merge the two and error if a `postinstall` script is already present.
38+
39+
### `--preinstall preinstall_script`
40+
41+
Use the script file given as a preinstall script. If given together with the `-scripts` option will attempt to merge the two and error if a `preinstall` script is already present.
42+
43+
### `--ownership {recommended,preserve,preserve-other}`
44+
45+
This parameter will be passed into `pkgbuild`. Default is `recommended`. See `man pkgbuild` for details.
46+
47+
### `--output pkgpath`
48+
49+
Will write the resulting package to `pkgpath` instead of the current working directory. If `pkgpath` is a directory, then the default package name (`{name}-{version}.pkg`) is used. You can also give the complete path, including a name. You can use the placeholders `{name}`, `{version}` and `{identifier}` in the name.
50+
51+
Examples:
52+
53+
```
54+
quickpkg /Applications/Numbers.app --output ~/Packages/
55+
```
56+
57+
Will create `Numbers-X.Y.Z.pkg` in `~/Packages`.
58+
59+
```
60+
quickpkg /Applications/Numbers.app --output Numbers_latest.pkg
61+
```
62+
63+
will create `Numbers_latest.pkg` in the current working directory.
64+
65+
```
66+
quickpkg /Applications/Numbers.app --output ~/Packages/{identifier}_{version}.pkg
67+
```
68+
69+
will create `com.apple.Numbers_X.Y.Z.pkg` in `~/Packages`.
70+
3571
## Background
3672

3773
OS X has had the `pkgbuild` tool since Xcode 3.2 on Snow Leopard. With pkgbuild you can directly build a installer package from an application in the `/Applications` folder:
@@ -56,11 +92,11 @@ However, while `pkgbuild` does automatically name the package, it does not inclu
5692

5793
This tool is not meant to replace [`autopkg`](https://github.com/autopkg/autopkg). `autopkg` will automate the download, the re-packaging (if necessary) and the upload to and configuration of your client management system. It can also handle much more complex setups than `quickpkg`. `autopkg` is far superior and should be your tool of choice.
5894

59-
However, there are situations where `autopkg` does not work well. The most common reason is if the download cannot be automated because the download page is behind a paywall. Also `autopkg` requires a recipe for a given piece of software. If no recipe exists, `quickpkg` may be a simple alternative. (Though if `quickpkg` works, creating an `autopkg` recipe should not be hard.)
95+
However, there are situations where `autopkg` does not work well. The most common reason is if the download cannot be automated because the download page is behind a paywall. Or maybe you are just experimenting with a test server and do not want to change your production `autopkg` setup. Also `autopkg` requires a recipe for a given piece of software. If no recipe exists, `quickpkg` may be a simple alternative. (Though if `quickpkg` works, creating an `autopkg` recipe should not be hard.)
6096

61-
## `quickpkg` vs `munki-pkg`
97+
## `quickpkg` vs `munkipkg`
6298

63-
`quickpkg` is meant for 'quick' packaging. No configuration, no options. Download the application from the AppStore or the dmg or zip from the web and go. (I started working on it because I could never remember the exact options needed for `pkgbuild`.) [`munki-pkg`](https://github.com/munki/munki-pkg/) is a tool that makes it easier to access the complex options of `pkgbuild` and `packagebuild`, but it still supports complex projects.
99+
`quickpkg` is meant for 'quick' packaging. No configuration, no options. Download the application from the AppStore or the dmg or zip from the web and go. (I started working on it because I could never remember the exact options needed for `pkgbuild`.) [`munkipkg`](https://github.com/munki/munki-pkg/) is a tool that makes it easier to access the complex options of `pkgbuild` and `packagebuild`, but it still supports complex projects.
64100

65101
If you prefer a UI rather than a command line tool, then use [Stéphane Sudre's Packages](http://s.sudre.free.fr/Software/Packages/about.html).
66102

0 commit comments

Comments
 (0)