Utility: applib

Syntax

applib -c library {-d description} {-u} {-P} {-q} {-D} {-g} {-n} {-e}
      -p product_name -v major.minor
      {-l file_list} files ...

applib -t library {-q}

applib -x library {-q} {-b} {files ...}

Description

Compile an application library file.

Parameters

• files
  The files and/or directories to be compiled, or file name patterns of files to be extracted.

Directories are searched recursively and symbolic links are followed.

The file path names stored in the library will be converted to relative names. Any name, after this conversion, will be stripped of the leading "product_name/" prefix.

Switches

• -b
  Extract only the basenames to the current directory.

• -c library
  Compile a new application library file. The default name extension is ".mxa". Any existing file with the same name will be overwritten.

• -d description
  Set the description string of the created library to description.

• -D
  Create a demonstration application library. This switch has been deprecated and now has the same effect as -u.

• -e
  By default all text files within the archive are encrypted. The presence of this switch instructs applib to encrypt macro files only, i.e. files with the ".cmd" extension.

• -g
  By default, it is assumed that the library being created is a Fire application, and as such must contain start.cmd and stop.cmd macros. The presence of this switch defines the library to be a general purpose archive and as such does not require these macros to be present.

• -h
  Print applib command help on stderr.

• -l file_list
  Read the names of files and directories to be inserted into the library from file file_list.

• -n
  By default all text files within the archive are encrypted. The presence of this switch instructs applib not to encrypt text files.
  Encryption can be suppressed on an individual file basis by using the -l file_list flag and preceding with a ! the names in the list of files which are not to be encrypted.

• -P
  Create a privileged unlicensed application library. Any user can run such an application without requiring a license. Unless this option is specified, a licensed library will be created. A developer must have a valid mxprivileged license to create a privileged application. For all users other than the creator of the library, Fire will require a license for the product/version before mounting a licensed library.

• -p product_name
  Set the product name of the created library to product_name.This name will be used to identify the product for licensing purposes. The name may contain up to 16 alphanumeric lower case characters.

• -q
  Work quietly. Unless this option is specified, applib will output the names of the files added to, extracted from or contained in the library.

• -t library
  List a table of contents of library on stdout. The default name extension is ".mxa".

• -u
  Create an unlicensed application library. The application will run without requiring a license, except for the case of execution within the browser-deployed Fire plugin where privileged commands, e.g. writes to the local disk, will not be permitted. Unless this option is specified, a licensed library will be created. For all users other than the creator of the library, Fire will require a license for the product/version before mounting a licensed library.

• -v major.minor
  Set the version number of the created library to major.minor. The major part will be used to identify the product version for licensing purposes.

• -x library
  Extract files from the application library file library. Filenames matching the specified files patterns will be extracted. If no files are specified, all files will be extracted.

Required

applib is part of the Fire application compiler system and requires a Fire application compiler license (mxappdev) in order to run.

Notes

The unique “developer identification” (devid) obtained from your compiler license will be used to identify the creator/owner of the application library. The license server must be running and reachable when the applib command is used.

When the library is mounted using the Fire mount or start command, the files in the library may be referenced as "@product_name/filename".

If a file_list is specified, it should contain file names or directories - one per line. Comment lines beginning with # and leading white-space will be ignored. A file_list is processed in addition to any files specified on the command line.

Examples

Creates a licensed application library $LIBS/net1.mxa containing all the files in the current directory which contain a "." and all the files in directory data. The directory data will be searched recursively. File names will be listed as they are inserted into the library.

# Creating a compiled library.
applib -c $LIBS/net1 -p mxnet -v 2.1 *.* data

As above, but creates an unlicensed application library - quietly.

applib -q -u -c $LIBS/net1 -p mxnet -v 2.1 *.* data

In order to list the contents of a library, you must have the same "developer identification" (devid) as the creator of the library.

# Listing the table of contents of a library.
applib -t $LIBS/net1
applib -q -t $LIBS/net1

# Extracting files from an application library.
applib -x $LIBS/net1

Make

The following is an example of using the Unix make utility to create and maintain application libraries.

# mxnet/Makefile
# Usage:
# cd $DEVELOPMENT_SOURCE/mxnet
# make...
PRODUCT=mxnet
VERSION=2.3
APPDIR=/home/distribution
 
${APPDIR}/mxnet.mxa: *.* forms/*.*
chmod og+x start.cmd stop.cmd
 
applib -c $@ -p ${PRODUCT} -v ${VERSION} *.* forms
# End mxnet/Makefile.

See Also