This is papaya.info, produced by makeinfo version 4.0 from
papaya.texinfo.

   This file documents the `The Papaya Utilities'.  The `The Papaya
Utilities' is a collection of utility programs for the software
development.

   Copyright (C) 2001 Steel Wheels Project

   Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

   Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided that
the entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

   Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be stated in a
translation approved by the Foundation.
INFO-DIR-SECTION Utilities
START-INFO-DIR-ENTRY
* papaya: (papaya).             The Papaya Utilities
END-INFO-DIR-ENTRY


File: papaya.info,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)

   This file documents the `The Papaya Utilities' which is a collection
of utility programs for the software development..

* Menu:

* Introduction::                What is `The Papaya Utilities'.
* Copying::                     How you can copy and share `The Papaya Utilities'.
* Overview::                    Preliminary information.
* Manual::			The manuals for each utility.
* Problems::                    Reporting bugs.
* Indexes::               	Index of concepts, functions, ...


File: papaya.info,  Node: Introduction,  Next: Copying,  Prev: Top,  Up: Top

What is `The Papaya Utilities'
******************************

   The `The Papaya Utilities' is a collection of utilities for software
development on UNIX (or UNIX like) systems.  All utilities are written
by the script language (such as `sh', `sed', `perl').  The size of each
program is very small.  And the each utility is used for specific
circumstances.

   The `The Papaya Utilities' is produced by Steel Wheels Project
(webpage: `http://www.asahi-net.or.jp/~em7t-hmd/').  And it is
distributed under GNU public license.  This package will be required by
other Steel Wheels Products (such as the coconut library).

   This document is based on `The Papaya Utilities', version 0.1.0.


File: papaya.info,  Node: Copying,  Next: Overview,  Prev: Introduction,  Up: Top

Copying
*******

   This package is distributed under GNU Public License.  For more
details, see the file COPYING located on top directory of this package.


File: papaya.info,  Node: Overview,  Next: Manual,  Prev: Copying,  Up: Top

Overview
********

   The utilities contained by the `The Papaya Utilities' are
categorized into the following list.

   * Document converter - modify the text file

   * File handler - execute file operation

   * Libraries - script library for utilities


File: papaya.info,  Node: Manual,  Next: Problems,  Prev: Overview,  Up: Top

Manual
******

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

* Menu:

* Utility Manual::	Manuals for utility
* Library Manual::	Manuals for library


File: papaya.info,  Node: Utility Manual,  Next: Library Manual,  Prev: Manual,  Up: Manual

Manuals for utilities
=====================

* Menu:

* add-html-signature::	insert signature file into html file
* compare-version::	compare version numbers
* copy-if-changed::	when the source file was modified, copy it to destination
* default-configure::	estimate the options for configure and execute it
* default-make::	execute gnu make or BSD make
* extract-package::	extract *.tar.gz, *.tgz, *.tar.bz2 package
* find-include-dir::	find include directory on the system
* get-tarball-version::	get version number from tar-ball file name
* insert-date-string::	replace keyword by the output of data command
* insert-executer::	replace command name following #!.
* make-install::	execute make install command (for sudo)
* papaya-config::	printout the configuration of installed utilities
* plain-to-html::	convert plain text to <pre> formatted html
* recursive-make::	execute make command for all subdirectories
* search-exec::		search exec file (replacement which command)
* texi2html-wrapper::	covert texi file into html file


File: papaya.info,  Node: add-html-signature,  Next: compare-version,  Prev: Utility Manual,  Up: Utility Manual

add-html-signature
------------------

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

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.


File: papaya.info,  Node: compare-version,  Next: copy-if-changed,  Prev: add-html-signature,  Up: Utility Manual

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.


File: papaya.info,  Node: copy-if-changed,  Next: default-configure,  Prev: compare-version,  Up: Utility Manual

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.

synopsis
--------

     	copy-if-changed source-file destination-file


File: papaya.info,  Node: default-configure,  Next: default-make,  Prev: copy-if-changed,  Up: Utility Manual

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.


File: papaya.info,  Node: default-make,  Next: extract-package,  Prev: default-configure,  Up: Utility Manual

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.


File: papaya.info,  Node: extract-package,  Next: find-include-dir,  Prev: default-make,  Up: Utility Manual

extract-package
---------------

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

synopsis
--------

     	extract-package tarball1 tarball2 ...


File: papaya.info,  Node: find-include-dir,  Next: get-tarball-version,  Prev: extract-package,  Up: Utility Manual

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.

synopsis
........

     	find-include-dir


File: papaya.info,  Node: get-tarball-version,  Next: insert-date-string,  Prev: find-include-dir,  Up: Utility Manual

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)".

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.

bug
---

   The naming rule for tarball file is limited.


File: papaya.info,  Node: insert-date-string,  Next: insert-executer,  Prev: get-tarball-version,  Up: Utility Manual

insert-date-string
------------------

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

synopsis
........

     	insert-date-string keyword
   The KEYWORD parameter can not contain '!' code.  This is not a bug.
It a spec !!


File: papaya.info,  Node: insert-executer,  Next: make-install,  Prev: insert-date-string,  Up: Utility Manual

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.

synopsis
........

     	insert-executer command1 command2 ...
   The first command which is exist on the system will be the target
`COMMAND'.


File: papaya.info,  Node: make-install,  Next: papaya-config,  Prev: insert-executer,  Up: Utility Manual

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).

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.


File: papaya.info,  Node: papaya-config,  Next: plain-to-html,  Prev: make-install,  Up: Utility Manual

papaya-config
-------------

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

synopsis
........

     	papaya-config [options] [arguments]

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'.


File: papaya.info,  Node: plain-to-html,  Next: recursive-make,  Prev: papaya-config,  Up: Utility Manual

plain-to-html
-------------

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

synopsis
........

     	plain-to-html title

option
......

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


File: papaya.info,  Node: recursive-make,  Next: search-exec,  Prev: plain-to-html,  Up: Utility Manual

recursive-make
--------------

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

synopsis
........

     	recursive-make


File: papaya.info,  Node: search-exec,  Next: texi2html-wrapper,  Prev: recursive-make,  Up: Utility Manual

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.

synopsis
........

     	search-exec file

option
......

   none

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.


File: papaya.info,  Node: texi2html-wrapper,  Prev: search-exec,  Up: Utility Manual

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.

synopsis
........

     	texi2html-wrapper texifile1 texifile2 ...

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...


File: papaya.info,  Node: Library Manual,  Prev: Utility Manual,  Up: Manual

   Manual

Manuals for libraries
=====================

* Menu:

* papaya-lib.pl::	perl library
* papaya-lib.sh::	sh library


File: papaya.info,  Node: papaya-lib.pl,  Next: papaya-lib.sh,  Prev: Library Manual,  Up: Library Manual

papaya-lib.pl
-------------


File: papaya.info,  Node: papaya-lib.sh,  Prev: papaya-lib.pl,  Up: Library Manual

papaya-lib.sh
-------------


File: papaya.info,  Node: Problems,  Next: Indexes,  Prev: Manual,  Up: Top

Reporting Bugs
**************

   If you find a bug in `The Papaya Utilities', please send electronic
mail to `wheel@osaka.email.ne.jp'.  Include in your message the output
that the program produced and the output you expected.

   If you have other questions, comments or suggestions about `The
Papaya Utilities', contact the author via electronic mail to
`wheel@osaka.email.ne.jp'.


File: papaya.info,  Node: Indexes,  Prev: Problems,  Up: Top

Indexes
*******

* Menu:

* bugs:                                  Problems.
* overview:                              Introduction.
* problems:                              Problems.

* Menu:

* add-html-signature:                    add-html-signature.
* compare-version:                       compare-version.
* copy-if-changed:                       copy-if-changed.
* default-configure:                     default-configure.
* find-include-dir:                      find-include-dir.
* get-tarball-version:                   get-tarball-version.
* insert-date-string:                    insert-date-string.
* insert-executer:                       insert-executer.
* make-install:                          make-install.
* papaya-config:                         papaya-config.
* plain-to-html:                         plain-to-html.
* recursive-make:                        recursive-make.
* search-exec:                           search-exec.
* texi2html-wrapper:                     texi2html-wrapper.



Tag Table:
Node: Top926
Node: Introduction1496
Node: Copying2266
Node: Overview2508
Node: Manual2844
Node: Utility Manual3155
Node: add-html-signature4282
Node: compare-version4791
Node: copy-if-changed5197
Node: default-configure5561
Node: default-make6710
Node: extract-package7191
Node: find-include-dir7470
Node: get-tarball-version7822
Node: insert-date-string8611
Node: insert-executer9010
Node: make-install9512
Node: papaya-config9988
Node: plain-to-html11042
Node: recursive-make11432
Node: search-exec11691
Node: texi2html-wrapper12257
Node: Library Manual12876
Node: papaya-lib.pl13082
Node: papaya-lib.sh13220
Node: Problems13335
Node: Indexes13799

End Tag Table
