The Papaya Utilities: 4 Manual

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

# 4 Manual

The `The Papaya Utilities` contains some utilities and libraries. This section describes about each utilities and libraries

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

## 4.1 Manuals for utilities

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.1 add-html-signature

The `add-html-signature` script insert the file before </BODY> tag in the source file.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.1.1 synopsis

    	add-html-signature source-file signature-file

The parameter source-file is a html text file which contains </BODY> tag. The content of signature-file are inserted before the tag. If the tag is not found, this utility exit with error.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.2 compare-version

The `compare-version` script compares two version strings given as arguments and return the result.

    	compare-version ver1 ver2

If the ver1 is older than (the number is smaller than) ver2, this script exits with 1. In another case, exit with 0.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.3 copy-if-changed

The `copy-if-changed` script copies the source file to destination when the destination file is not exist or it was differ from source one.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.4 synopsis

    	copy-if-changed source-file destination-file

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.5 default-configure

The `default-configure` estimate the options for `configure` script by the given rule name. The options generated by this script depend on the help message of the `configure` script.

Following rules are supported:

- usr Install the files into the ‘`/usr`’ directory. The programs installed under ‘`/usr`’ directory are system basic programs.
- local Install the files into the ‘`/usr/local`’ directory. It means optional software or application for user (not system administrator).
- X11R6 Install the files into the ‘`/usr/X11R6`’ directory. The programs installed here uses X Window System.
- gnome The application based on gnome (Gnu Network Object Environment) are installed into ‘`/usr/gnome`’ directory. The reason why gnome application is separated with X Window System program is the large number of utilities, libraries.

The system configuration file (determined by `sysconfdir` option) is stored under ‘`/etc/package-name`’ directory.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.6 default-make

The `default-make` executes `06 make` or `gnu make`.

    	default-make [-p|-g] [args-for-make ...]

If the `-p` option is given, 06 make (`pmake`) is used as a make command. If the `-g` option is given, gnu make (`gmake`) is used as a make command. If the option is not given or the are no commands, default `make` command is used.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.7 extract-package

The `extract-package` script uncompress and extract package file.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.8 synopsis

    	extract-package tarball1 tarball2 ...

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.9 find-include-dir

The `find-include-dir` script print the 06 of the “include” directories. These 06 are started by “/usr” or “/opt” and do not include “src” directory.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.9.1 synopsis

    	find-include-dir

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.10 get-tarball-version

The `get-tarball-version` gets the version number from tar-ball name. The tar-ball name must be “name-X.Y.Z.tar.gz(or tar.bz2, .tgz)”.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.11 synopsis

    	get-tarball-version [options] tarball-file

If the option ‘–major’ given, the major version number is printed to standard output. The ‘–minor’ option prints minor version number. The ‘–micro’ option prints micro version number. The ‘–name’ option prints the package name (which does not include version number) instead of versions. if no options are given, all version (such as X.Y.Z) is printed.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.12 bug

The naming rule for tarball file is limited.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.13 insert-date-string

The `insert-date-string` replace the keyword in the standard input by the output of date command.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.13.1 synopsis

    	insert-date-string keyword

The keyword parameter can not contain ’!’ code. This is not a bug. It a spec !!

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.14 insert-executer

The `insert-executer` insert the line "#!COMMAND" line into the head of input stream. The `COMMAND` is given by the list of arguments of this script. The line includes "#!" in input stream will be ignored.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.14.1 synopsis

    	insert-executer command1 command2 ...

The first command which is exist on the system will be the target `COMMAND`.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.15 make-install

The `make-install` command executes `make install`. You can select the make command from gnu make (gmake), 06 make (pmake) and default (make).

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.16 synopsis

    	make-install [-p|-g]

If the `-p` option is given, `pmake` command is used. And the `-g` means `gmake`. This command is designed to be called from `sudo` command.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.17 papaya-config

The `papaya-config` print the configuration of installed `The Papaya Utilities`.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.17.1 synopsis

    	papaya-config [options] [arguments]

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.17.2 options

- `--bin-path [command]` : Print out the directory which contains the executable files of `The Papaya Utilities`. If the argument command is given, the full path of the command is printed. (The command must be the name of utility of `The Papaya Utilities`.)
- `--data-path`: Print the directory which contains the data file of `The Papaya Utilities`.
- `--exec command [arg1 arg2 ...]`: Execute the `command`, the command will be searched in the directory by `papaya-config --bin-path`.
- `--lib-path`: Print the directory which contains the library file of `The Papaya Utilities`.
- `--libexec-path`: Print the directory which contains the executable library file of `The Papaya Utilities`.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.18 plain-to-html

The `plain-to-html` convert plain text from standard input to the <pre> formatted html to output.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.18.1 synopsis

    	plain-to-html title

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.18.2 option

- title The title of the html (which may be displayed on the window title bar).

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.19 recursive-make

Execute make command for all subdirectories which contains file ‘`Makefile`’.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.19.1 synopsis

    	recursive-make

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.20 search-exec

The `search-exec` command search executable file and print it (if it exist). This command is used in the shell script instead of `which` command.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.20.1 synopsis

    	search-exec file

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.20.2 option

none

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.20.3 description

If the target `file` is found and it is executable, this command print the full path of the `file`. If the `file` is not found, this command print nothing and exit with error code 0.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.1.21 texi2html-wrapper

The `texi2html-wrapper` convert the texi file into html file. The generated html files are put into ‘`html`’ subdirectory. If the `html` directory is not exist, the error is occurred.

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.21.1 synopsis

    	texi2html-wrapper texifile1 texifile2 ...

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

#### 4.1.21.2 description

The `texi2html-wrapper` uses `texi2html` or `makeiinfo` program. If both program exist, `texi2html` is used. The generated html file’s <BODY> tag will be replaced to change foreground/background color etc...

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

## 4.2 Manuals for libraries

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.2.1 papaya-lib.pl

[ << ] | [ < ] | [] | [ > ] | [ >> ] |  |  |  |  | [] | [] | [] | [ ? ]

### 4.2.2 papaya-lib.sh

[ << ] | [ >> ] |  |  |  |  |  | [] | [] | [] | [ ? ]