prototype(F) 19 June 1992 prototype(F) Name prototype - package information file Description prototype is an ASCII file used to specify package information. Each entry in the file describes a single deliverable object. An object may be a data file, directory, source file, executable object, etc. This file is generated by the package developer. Entries in a prototype file consist of several fields of information separated by white space. Comment lines begin with a ``#'' and are ignored. The fields are described below and must appear in the order shown. part An optional field designating the part number in which the object resides. A part is a collection of files, and is the atomic unit by which a package is processed. A developer can choose criteria for grouping files into a part (for example, based on class). If this field is not used, part 1 is assumed. ftype A one-character field which indicates the file type. Valid values are: f a standard executable or data file e a file to be edited upon installation or removal v volatile file (one whose contents are expected to change) d directory x an exclusive directory l linked file p named pipe c character special device b block special device i installation script or information file s symbolic link class The installation class to which the file belongs. This name must contain only alphanumeric characters and be no longer than 12 characters. The field is not specified for installation scripts. (admin and all classes beginning with capital letters are reserved class names.) pathname The pathname where the file will reside on the target machine, for example, /usr/bin/mail or /bin/ras_proc. Relative path- names (those that do not begin with a slash) indicate that the file is relocatable. The form path1=path2 may be used for two purposes: to define a link and to define local pathnames. For linked files, path1 indicates the destination of the link and path2 indicates the source file. (This format is mandatory for linked files.) For symbolically linked files, path2 can be a relative path- name, such as ./ or ../. For example, if you enter a line such as s /foo/bar/etc/mount=../etc/mount path2 (/foo/bar/etc/mount) will be a symbolic link to ../etc/mount. For local pathnames, path1 indicates the pathname an object should have on the machine where the entry is to be installed and path2 indicates either a relative or fixed pathname to a file on the host machine which contains the actual contents. A pathname may contain a variable specification, which will be resolved at the time of installation. This specification should have the form $[A-Z]. major The major device number. The field is only specified for block or character special devices. minor The minor device number. The field is only specified for block or character special devices. mode The octal mode of the file (for example, 0664). A question mark (?) indicates that the mode will be left unchanged, imply- ing that the file already exists on the target machine. This field is not used for linked files or packaging information files. owner The owner of the file (for example, bin or root). The field is limited to 14 characters in length. A question mark (?) indi- cates that the owner will be left unchanged, implying that the file already exists on the target machine. This field is not used for linked files or packaging information files. Can be a variable specification in the form of $[A-Z]. Will be resolved at installation time. group The group to which the file belongs (for example, bin or sys). The field is limited to 14 characters in length. A question mark (?) indicates that the group will be left unchanged, implying that the file already exists on the target machine. This field is not used for linked files or packaging informa- tion files. Can be a variable specification in the form of $[A-Z]. Will be resolved at installation time. An exclamation point (!) at the beginning of a line indicates that the line contains a command. These commands are used to incorporate files in other directories, to locate objects on a host machine, and to set per- manent defaults. The following commands are available: search Specifies a list of directories (separated by white space) to search for when looking for file contents on the host machine. The basename of the ``path'' field is appended to each directory in the ordered list until the file is located. include Specifies a pathname which points to another prototype file to include. Note that search requests do not span ``include'' files. default Specifies a list of attributes (mode, owner, and group) to be used by default if attribute information is not pro- vided for prototype entries which require the information. The defaults do not apply to entries in ``include'' proto- type files. param=value Places the indicated parameter in the current environment. The above commands may have variable substitutions embedded within them, as demonstrated in the two example prototype files below. Before files are overwritten during installation, they are copied to a temporary pathname. The exception to this rule is files whose mode includes execute permission, unless the file is editable (that is, ``ftype'' is e). For files which meet this rule, the existing version is linked to a temporary pathname, and the original file is removed. This allows processes which are executing during installation to be overwrit- ten. Examples Example 1: !PROJDIR=/usr/proj !BIN=$PROJDIR/bin !CFG=$PROJDIR/cfg !LIB=$PROJDIR/lib !HDRS=$PROJDIR/hdrs !search /usr/myname/usr/bin /usr/myname/src /usr/myname/hdrs i pkginfo=/usr/myname/wrap/pkginfo i depend=/usr/myname/wrap/depend i version=/usr/myname/wrap/version d none /usr/wrap 0755 root bin d none /usr/wrap/usr/bin 0755 root bin ! search $BIN f none /usr/wrap/bin/INSTALL 0755 root bin f none /usr/wrap/bin/REMOVE 0755 root bin f none /usr/wrap/bin/addpkg 0755 root bin !default 755 root bin f none /usr/wrap/bin/audit f none /usr/wrap/bin/listpkg f none /usr/wrap/bin/pkgmk # The logfile starts as a zero length file, since the source # file has zero length. Later, the size of logfile grows. v none /usr/wrap/logfile=/usr/wrap/log/zero_length 0644 root bin # the following specifies a link (dest=src) l none /usr/wrap/src/addpkg=/usr/wrap/bin/rmpkg ! search $SRC !default 644 root other f src /usr/wrap/src/INSTALL.sh f src /usr/wrap/src/REMOVE.sh f src /usr/wrap/src/addpkg.c f src /usr/wrap/src/audit.c f src /usr/wrap/src/listpkg.c f src /usr/wrap/src/pkgmk.c d none /usr/wrap/data 0755 root bin d none /usr/wrap/save 0755 root bin d none /usr/wrap/spool 0755 root bin d none /usr/wrap/tmp 0755 root bin d src /usr/wrap/src 0755 root bin Example 2: # this prototype is generated by 'pkgproto' to refer # to all prototypes in my src directory !PROJDIR=/usr/dew/projx !include $PROJDIR/src/cmd/prototype !include $PROJDIR/src/cmd/audmerg/protofile !include $PROJDIR/src/lib/proto See also pkginfo(F), pkgmk(ADM) Notes Normally, if a file is defined in the prototype file but does not exist, that file is created at the time of package installation. However, if the file pathname includes a directory that does not exist, the file will not be created. For example, if the prototype file has the following entry: f none /usr/dev/bin/command and that file does not exist, it will be created if the directory /usr/dev/bin already exists or if the prototype also has an entry defin- ing the directory: d none /usr/dev/bin