Skip to content

Commit 4e5a757

Browse files
authored
Merge pull request #36 from lumarogit/readme
2 parents b831ff5 + fb3406d commit 4e5a757

File tree

2 files changed

+97
-102
lines changed

2 files changed

+97
-102
lines changed

README.md

Lines changed: 92 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,13 @@ Available options:
8888
makeflags: Enable makeflags (MAKEFLAGS).
8989
9090
### pkgbuild
91-
`pkgbuild` is a tool to build package from ports. Is will source `spkgbuild` to get build information before creating package. Package is created into `<name>-<version>-<release>.spkg.txz` format. To build package, you need `cd` into port directory before run `pkgbuild` command.
91+
`pkgbuild` is a tool to build package from ports. Is will source `spkgbuild` to get build information before creating package. Package is created into `<name>-<version>-<release>.spkg.xz` format. To build package, you need `cd` into port directory before run `pkgbuild` command.
9292

9393
Usage:
9494
pkgbuild [ <options> <arguments> ]
9595

9696
Options:
97+
-q --quiet show only status messages and errors
9798
-i, --install install package into system
9899
-u, --upgrade upgrade package
99100
-r, --reinstall reinstall package
@@ -104,23 +105,19 @@ Available options:
104105
-g, --genmdsum generate md5sum
105106
-o, --download download only source file
106107
-x, --extract extract only source file
108+
-p, --pkgfiles generate list files in package
107109
-w, --keep-work keep working directory
108-
-l, --log log build process
109110
-h, --help show this help message
111+
--clean remove downloaded sources and prebuilt packages
110112
--config=<config> use custom config file
111113
--srcdir=<path> override directory path for sources
112114
--pkgdir=<path> override directory path for compiled package
113-
--logdir=<path> override directory path for build logs
114115
--workdir=<path> override directory path for working dir
115-
--no-preinstall skip preinstall script before install package
116-
--no-postinstall skip postinstall script after install package
117-
--no-preupgrade skip preupgrade script before upgrade package
118-
--no-postupgrade skip postupgrade script after upgrade package
119116
--no-backup skip backup configuration file when upgrading package
120-
--redownload re-download source file
117+
121118

122119
Example:
123-
pkgbuild -iw this will build, install package and keep working directory
120+
pkgbuild -iw this will build, install package and keep working directory
124121

125122
Note:
126123
* use pkgbuild without any options will only download source and build package by using other default options
@@ -129,29 +126,26 @@ Available options:
129126
130127
### pkgadd
131128
`pkgadd` is a tool to install and upgrade package created by `pkgbuild`. Install package is simply extract
132-
`<name>-<version>-<release>.spkg.txz` by using tar into real system then save list extracted file into package `PKGDB_DIR`.
129+
`<name>-<version>-<release>.spkg.xz` by using tar into real system then save list extracted file into package `PKGDB_DIR`.
133130
Upgrading package is also using same extract as install, it will replace old files then compare list file from old and new
134131
package and remove old file which not exist in new package (like Slackware pkgtool does).
135132

136133
Usage:
137-
pkgadd package.spkg.txz <options>
134+
pkgadd [ <options> <package.spkg.txz> ]
138135

139136
Options:
140137
-u, --upgrade upgrade package
141138
-r, --reinstall reinstall package
142139
-c, --ignore-conflict ignore conflict when installing package
143140
-v, --verbose print files installed
144141
-h, --help show this help message
145-
--no-preinstall skip preinstall script before build/install package
146-
--no-postinstall skip postinstall script after install package
147-
--no-preupgrade skip preupgrade script before upgrade package
148-
--no-postupgrade skip postupgrade script after upgrade package
149142
--no-backup skip backup when upgrading package
150-
--root=<path> install to custom root directory
143+
--print-dbdir print package database path
144+
--root=<path> install to custom root directory
151145

152146
Example:
153-
pkgadd foobar-1.0-1.spkg.txz -uc --no-backup upgrade package foobar-1.0-1 without backup its
154-
old configuration files and skip conflict check
147+
pkgadd foobar-1.0-1.spkg.txz -uc --no-backup upgrade package foobar-1.0-1 without backup its
148+
old configuration files and skip conflict check
155149
156150
### pkgdel
157151
`pkgdel` is a tool to remove package from system. It will read file listed in package `PKGDB_DIR` and remove it.
@@ -162,8 +156,6 @@ package and remove old file which not exist in new package (like Slackware pkgto
162156
Options:
163157
-h, --help show this help message
164158
-v, --verbose print removed files
165-
--no-preremove don't run pre-remove script
166-
--no-postremove don't run post-remove script
167159
--root=<path> remove package from custom root directory
168160

169161
Example:
@@ -175,78 +167,74 @@ pkgadd to install package into system. Its also has some extra functions like se
175167
orphan package, duplicate ports, list installed package and etc. Run `scratch help` to see available functions.
176168

177169
Usage:
178-
scratch [ mode ] [ <pkgname> <options> ]
179-
180-
mode:
181-
install <packages> install packages and its dependencies
182-
upgrade <packages> upgrade packages and install new dependencies (if any)
183-
build <package> build only packages
184-
remove <packages> remove packages in system
185-
depends <package> show depends of a package
186-
deplist <packages> show list dependencies of a package
187-
search <pattern> search packages in port's repos
188-
lock <packages> lock packages from upgrade
189-
unlock <packages> unlock packages from upgrade
190-
listport <repo> list ports of a repo
191-
cat <package> view a package build scripts
192-
dependent <package> show package's dependent
193-
own <file> show package's owner of file
194-
pkgtree <package> show list files of installed package
195-
path <package> show package's buildscripts path
196-
sync update port's repo
197-
sysup full system update
198-
dup print duplicate ports in repo
199-
readme print readme file if exist
200-
listinst list installed package in system
201-
listorphan list orphan package
202-
integrity check integrity of package's files
203-
outdate check for outdate packages
204-
cache print leftover cache
205-
rmcache remove leftover cache
206-
missingdep check for mising dependency of installed package
207-
foreignpkg print package installed without port in repo
208-
listlocked print locked packages
209-
help print this help message
210-
211-
options for:
212-
build
213-
-f, --force-rebuild force rebuild
214-
-m, --skip-mdsum skip md5sum check for sources
215-
-d, --no-dep skip dependency check
216-
-e, --extract extract only
217-
-w, --keep-work keep woring directory
218-
-o, --download download source files only
219-
--redownload re-download source files
220-
--srcdir=<path> override default SOURCE_DIR
221-
--pkgdir=<path> override default PACKAGE_DIR
222-
--no-preinstall skip pre-install script
223-
224-
install
225-
-d, --no-dep skip installing dependencies
226-
-c, --ignore-conflict skip file conflict check
227-
-r, --reinstall reinstall installed package
228-
-v, --verbose print install process
229-
--no-preinstall skip pre-install script
230-
--no-postinstall skip post-install script
231-
232-
upgrade
233-
-d, --no-dep skip installing dependencies (new dependencies)
234-
-c, --ignore-conflict skip file conflict check
235-
-v, --verbose print install process
236-
--no-backup skip backup configuration file
237-
--no-preupgrade skip pre-upgrade script
238-
--no-postupgrade skip post-upgrade script
239-
240-
remove
241-
-d, --no-dep skip dependency check
242-
-v, --verbose print removed files
243-
--no-preremove skip pre-remove script
244-
--no-postremove skip post-remove script
245-
246-
global options:
247-
--no-color disable colour for output
248-
--debug debug scratch script
249-
170+
scratch <options> [<arg>]
171+
172+
Options:
173+
install <ports> <arg> install ports (use pkgbuild arg, except '-i' & '-u')
174+
-r reinstall
175+
-n skip dependencies
176+
-y skip ask user confirmation
177+
-o fetch sources only
178+
--exclude=* exclude dependencies, comma separated
179+
180+
upgrade <ports> <arg> upgrade ports (use pkgbuild arg, except '-i' & '-r')
181+
-n skip dependencies
182+
-y skip ask user confirmation
183+
-o fetch sources only
184+
--exclude=* exclude dependencies, comma separated
185+
186+
remove <ports> <arg> remove installed ports (use pkgdel arg)
187+
-y skip ask user confirmation
188+
189+
sysup <arg> full system upgrade (use pkgbuild arg, except '-i', '-r' & '-u')
190+
-n skip dependencies
191+
-y skip ask user confirmation
192+
-o fetch sources only
193+
--exclude=* exclude dependencies, comma separated
194+
195+
deplist <ports> print all dependencies for ports
196+
-q skip installed ports
197+
--exclude=* exclude dependencies, comma separated
198+
199+
build <ports> <arg> build ports (use pkgbuild arg, except '-i', '-u', '-r', '-g', & '-p')
200+
--log log build process (/var/log/pkgbuild.log)
201+
202+
trigger [ports] run system trigger
203+
search <pattern> find ports in repo
204+
cat <port> print spkgbuild
205+
depends <port> print dependencies
206+
dependent <port> print dependent
207+
path <port> print path in repo
208+
provide <file> print port's provided file
209+
readme <port> print readme file, if exist
210+
files <port> print files installed
211+
info <port> print information
212+
locate <file> print location of file in ports repo
213+
isinstalled <port> check whether port is installed (status 0=installed, 1=not installed)
214+
purge [ports] remove installed ports and its orphan dependencies
215+
world [ports] print/add/remove world list
216+
sync update ports database
217+
outdate print outdated ports
218+
cache print and clear old pkg and src caches
219+
integrity check installed port integrity
220+
dup print duplicate ports in repo
221+
installed print all installed ports
222+
missingdep print missing dependencies
223+
orphan print orphan installed ports
224+
foreign print foreign ports
225+
printconfig <opts> print scratchpkg configs
226+
help print this help msg
227+
228+
Global options:
229+
--append-repo=<repo path> append custom local repo path (can use multiple times)
230+
--prepend-repo=<repo path> prepend custom local repo path (can use multiple times)
231+
--override-repo=<repo path> override repo in /etc/scratchpkg.repo with custom local repo (can use multiple times)
232+
--repo-file=<repo file> use custom repo file (default: /etc/scratchpkg.repo)
233+
--config-file=<config file> use custom config file (default: /etc/scratchpkg.conf)
234+
--alias-file=<alias file> use custom alias file (default: /etc/scratchpkg.alias)
235+
--mask-file=<mask file> use custom mask file (default: /etc/scratchpkg.mask)
236+
--nocolor disable colour for output
237+
250238
Example:
251239
scratch install firefox gvfs -cv build and install required dependencies and target package itself,
252240
ignore file conflict check and be verbose.
@@ -258,8 +246,8 @@ orphan package, duplicate ports, list installed package and etc. Run `scratch he
258246
Extra tools is some scripts come with scratchpkg to help users do things more easier. More extra scripts may added from time to
259247
time.
260248

261-
* `vchroot`: Chroot script.
262-
* `pkglibdepends`: Script to list package depends by shared libraries.
249+
* `xchroot`: Chroot script.
250+
* `pkgdepends`: Script to list package depends by shared libraries.
263251
* `portcreate`: Script to create template port.
264252
* `updateconf`: Script to update configuration files (*.spkgnew).
265253
* `revdep`: A reverse dependency script (like in Gentoo and CRUX, but my version), need to run after upgrade and remove package to check broken package(s). Specify package name if want to check single package only.
@@ -315,11 +303,16 @@ Example of install script for `dbus`:
315303
# <repo directory> <repo url for sync>
316304
#
317305

318-
/usr/ports/core https://raw.githubusercontent.com/venomlinux/ports/master/core
319-
/usr/ports/xorg https://raw.githubusercontent.com/venomlinux/ports/master/xorg
320-
/usr/ports/extra https://raw.githubusercontent.com/venomlinux/ports/master/extra
321-
/usr/ports/multilib https://raw.githubusercontent.com/venomlinux/ports/master/multilib
322-
/usr/ports/community https://raw.githubusercontent.com/venomlinux/ports/master/community
306+
# your local repo
307+
/usr/ports/myrepo
308+
309+
# official venom repo
310+
/usr/ports/core https://github.com/venomlinux/ports/tree/4.0/core
311+
/usr/ports/main https://github.com/venomlinux/ports/tree/repos/main
312+
/usr/ports/multilib https://github.com/venomlinux/ports/tree/repos/multilib
313+
/usr/ports/nonfree https://github.com/venomlinux/ports/tree/repos/nonfree
314+
#/usr/ports/testing https://github.com/venomlinux/ports/tree/repos/testing
315+
323316

324317
*Note: url is optional. Add if need to sync it.*
325318

scratchpkg.repo

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
# <repo directory> <repo url for sync>
66
#
77
# example:
8-
# /usr/ports/core https://raw.githubusercontent.com/emmett1/ports/master/core
9-
# /usr/ports/localports
10-
#
8+
# /usr/ports/myrepo
9+
# /usr/ports/core https://github.com/venomlinux/ports/tree/4.0/core
10+
# /usr/ports/main https://github.com/venomlinux/ports/tree/repos/main
11+
# /usr/ports/multilib https://github.com/venomlinux/ports/tree/repos/multilib
12+
#

0 commit comments

Comments
 (0)