Unix/GNU Windows

   
By Alexis Wilke
Started in Dec. 2006
   Home       Documentation       Download       Bugs   

Current
wpkg
Version:
0.5



Change Log
  

There are two set of command line flags in wpkg: commands and options. Exactly one command must be specified. Any number of options can be used.

Commands   Comments
--build
-b
  Build the specified package (i.e. generate the .deb file) [implemented since version 0.5, see Building a package for more info on how to build a package.]
--contents
-c
  Display the list of files available in packages. These are the files which will be installed.
--directory-size   Gather the size in kilo bytes of the files present in the set of paths specified after this command. This is similar to 'du -ks' without the name of the directory printed.
 
Rational: This let's us bypass the use of du which otherwise requires the MinGW library and requires a properly working sed to remove the directory name from the result. Also, this option can be tweaked as required to work properly for the target system.
--extract <dir>
-x <dir>
--vextract <dir>
-X <dir>
  Extract the specified package in the specified directory (dir). Use the --vextract (or -X) to see the file names as they are being extracted.
--field <package> <fields>
-f <package> <fields>
  Extract the specified fields from the specified package. When only one field is specified, only the content of the field is printed. When multiple fields are requested (separate their names with spaces), each is printed as it appears in the control file.
--info
-I
  Print out information about the specified packages. This includes the version of the package, the version of the software inside the package, the name of the package, and the other fields available in the control file.
--install
-i
  Installs the specified packages. It needs to either be non-specific to any architecture or have the architecture win32-i386. You can check the architecture of a package with the --info command line instruction.
--license
--licence
  Prints out the license of wpkg and exists.
--list   Prints out the name, version and status of installed packages. With the --verbose option, also prints out information about the uninstalled packages.
--purge
-P
  Remove a package and it's configuration files.
--remove
-r
  Remove a package except it's configuration files. Since version 0.3, a package can be removed only if no other packages depend on it.
WARNING: in version 0.5, --remove is just the same as --purge. This is not so much a problem at this time since packages under Win32 do not yet install configuration files.
--remove-database-lock   I added this option since once in a while the software either crashes or hangs (Since I'm still working on versions 0.x...) and thus the locking file stays in place. This may change in order to avoid problems by adding another tool to do that job.
--show
-W
  Show the name and version of the specified packages. The information comes from the control file Package and Version fields.
--version   Print the Version field of wpkg and exit.

 

Options   Comments
--admindir <path>   Specify the administration directory. This is where the database resides. You must have at most one administration directory. Do not change this path unless you know what you are doing. The default is /var/lib/wpkg.
--force-<name>   The --force options are used to transform errors in warnings so a command can proceed.

For instance, the --install fails if a file to be installed already exists on your system. The --force-overwrite option will let you install the package anyway.

--force-architecture
only warns about an incompatible Architecture field

--force-conflicts *
only warns about conflicting packages already installed

--force-depends *
only warns about missing dependencies or dependencies with the wrong version

--force-depends-version *
only warns about dependencies with the wrong version

--force-overwrite *
only warns about an existing file which is about to be overwritten

--force-remove-essential *
only warns about removing a package marked as required; this can break your system, though only wpkg is absolutly necessary for the correct functioning of the USYS system; everything else can be reinstalled from scratch

* options mark with a red asterisk are considered dangerous and should be used with great care

For each --force-<name> there is a corresponding --no-force-<name> and --refuse-<name> which, to the contrary, ensures that errors and not warnings occur; meaning that the function will not proceed.

--help
-h
  Print out a brief help screen about all the command line options.
--instdir <path>   Specify the path where the package will be installed. By default, this is the root (i.e. "/"). This should not be changed unless you know what you are doing.
--no-force-<name>   This option cancels the --force of the same name. All the --no-force have priority over the --force. In other words, if --no-force is specified once, the --force will have no effect whatever the order in which these are defined on the command line.
--package <package>
-p <package>
  Specify the list of packages to act on. This option does not need to be specified.
WARNING: when the --field command is used, the list of packages is actually the list of fields and the package name appears after the --field command.
--refuse-<name>   This option cancels the --force of the same name. All the --refuse have priority over the --force. In other words, if --refuse is specified once, the --force will have no effect whatever the order in which these are defined on the command line.
--tempdir <path>   This option defines an alternate path to the temporary directory wpkg shall use. This can also be set with the WPKG_TEMP, TEMP or TMP environment variables (checked in that order.) If all fails, wpkg tries with /tmp and if that is not a directory, it uses the current directory (i.e. ".").
--verbose
-v
  Make wpkg talkative. This option asks the different commands to print out information about the different actions they perform.