FlagShip Installation Notes --------------------------- On this ftp server (ftp://fship.com/pub/multisoft), fully functional Demo versions of the FlagShip package for several Unix systems are available. Check the current directory for the operating , then read the requirements in the .../flagship/demos//requir.doc file. The full FlagShip package (license) is available from your dealer, distributor or from multisoft GmbH, phone (xx49-89) 6490040. FlagShip is available for all common Unix systems. On this ftp server, we have posted free FlagShip demos for the most used Unix systems; additional ports are available from your distributor or dealer upon request. For some systems (like SCO Unix, Linux, HP-UX, IBM-AIX etc.), different ports are available according to the Release of the used Operating System. See the description 'Where are the differences...' in the 'README' file for additional information. Installation from Internet -------------------------- FlagShip may easily be installed. You will need superuser (or root) priviledges to perform the installation. Detailed instructions to download and install the FlagShip Demo package from the ftp://fship.com/pub/multisoft/flagship/demos server: 1. Read or download the documentation in the /pub/multisoft/flagship/docu directory, or at least in the ./README and ./License.doc files. 2. Select the required Operating System (e.g. 'cd sco325' when you own the SCO Unix OS-5, release 3.2.5), read the requirements in the ./requir.doc file. Download the 'fsdemo.tar' file to your computer by using a binary transfer protocol (with terminal oriented ftp program, set 'BIN' and 'HASH', then download by 'GET fsdemo.tar'. With X or Window oriented ftp, set the 'Binary transfer' option and select the displayed file with the mouse). 3. Log into your Unix system as super-user (or root): $ su (UNIX shell prompt) Password: john_miller (not displayed) # (UNIX su prompt) ! Caution: Before installing the DEMO version of FlagShip, make sure that the date and time are correctly set on your system. Check this or set it by using: # date -or- # date mmddHHMMyy -e.g. date 0621154896 for the 21-Jun-96 at 3:48pm - 4. Create and change into an empty directory of your choice, e.g. # mkdir /tmp/FS # cd /tmp/FS Un-tar the downloaded file into this empty directory. The following example assumes, you downloaded the fsdemo.tar file into the directory /var/downloads; modify this entry according to your settings: # tar xvf /var/downloads/fsdemo.tar 5. Invoke the installation script # ./FSinstall -or- # ./FSinstall -h (hor help) -or- # ./FSinstall -e (for English messages) -or- # ./FSinstall -d (for German messages) The installation script will interact with you. 6. During the installation, you may specify directories, where the FlagShip package should be installed. Usually, you should use the default settings, unless you have important reasons not to do so. In such a case, you will probably need to set additional environment variables or use additional compiler switches to reach non-default directories. If so, you will receive additional informations during the installation. 7. The FlagShip installation is now finished. Log into your computer as an ordinary user: # exit (leave the su state now) $ (std. UNIX shell) Now, you are ready to use the FlagShip development system. Please invoke the FlagShip on-line manual first by e.g. $ newfscons fsman -being on console, or- $ newfswin fsman -being in Xwindow system, or- $ fsman see details in the Unix man pages $ man flagship $ man fsman One of the most important section is the REL (Release Notes) and FSC (com- piler). If you are not very familiar in Xbase programming yet, read care- fully the section LNG (Language) and study the complete programming examples there. For an advanced programmer, the chapter QRF (quick reference) gives you a quick overview and the reference part (CMD and FUN) describes in detail all commands or functions, including the difference (if any) to other Xbase dialects. Note: For your convenience, a printed manual (over 1500 pages including slip case) is available from your dealer for a small surcharge. The printed manual is included in the distribution for all FlagShip full licenses (except for Linux, where optional). Before starting with your application, you should check the current environment settings (stty, TERM, ttymap etc.) according to chapter Runtime Requirements, section FSC and REL, and the configuration file /etc/FSconfig. In the /usr/FSsrc directory, some small program examples are available. You may study and try them out yourself, e.g. $ cd $ cp /usr/FSsrc/fsadr* . (copy to home directory) $ FlagShip fsadress.prg -ofsadress (compile) $ newfscons ./fsadress (execute) You will find additional information and examples in the FlagShip manual, sections LNG, CMD and FUN. If the colors or special keys work other than expected, check the section SYS or use the semi-automatic checking program fscheck.prg stored in the /usr/FSsrc directory. Copy it into your working directory, compile and run it. It will check and display the input and output mappings, the default settings and so on: $ cd /usr/home/john (or simple cd ) $ cp /usr/FSsrc/fscheck.prg . $ FlagShip fscheck.prg (see section FSC) $ export FSTERM=fslinux (on Linux, see release notes) $ FSTERM=FSansi ; export FSTERM (on other systems) $ a.out -or- $ ./a.out -or- $ newfscons ./a.out Deinstallation -------------- All of the files installed by 'FSinstall' may be removed selectively at any time by entering $ su # FSuninstall -e (using English messages) # FSuninstall -d (using German messages) The FlagShip manual (files in the /usr/FSsrc/manual directory) as well as the terminfo entries and the two "man" pages will not be deleted. Additional Infos ---------------- For other Unix systems, FlagShip demos/test drives are available on floppies, tape or CD-ROM for a nominal fee. Ask your distributor, or contact the manufacturer. ========================================================================== FlagShip General FlagShip Infos NAME FlagShip installation and usage DESCRIPTION FlagShip is a Database Development and Xbase Porting System for UNIX. It offers a full source code compatibility to CA/Clipper (from the newest release 5.3 down to Summer'87) and other xBASE systems as well as binary data compatibility (.dbf, .dbt, .mem and other files). AVAILABILITY FlagShip is ported to all common UNIX systems (more than 50 systems are available). There are three different FlagShip LICENSES available: 1. "FlagShip Pro" is intended as the regular license kit for software developers who will resell their executables, and for large inhouse systems, accessed simultaneously by any number of users. - The application supports an unlimited number of simultaneous proces- ses or users (or a limited number of users upon request), - The developer may sell the application compiled by "FlagShip Pro" as often as he likes, since - No run-times fees or royalties exist. - Discounted additional licenses for other platforms are available. Of course, neither the FlagShip compiler, nor cc is required on the customer's site, but the executable only. 2. The "Personal FlagShip" is intended as a low cost Starter Kit for personal, company internal/inhouse and software developer use, as well as the presentation of applications. Personal FlagShip has all the fea- tures of FlagShip Pro, except: - Personal FlagShip supports the execution of the same application or allows access to the same shared database by two different users (or processes) simultaneously. - Since used "personally" or in-house, executables need to run on the system where the compiler resides, but are also usable in other environments for thirty days, e.g. for presentation purposes. There are no run-time licenses or other limitations. You may upgrade to FlagShip Pro at any time. 3. The FREE "FlagShip Demo/Test Drive" is fully functional, and lets you evaluate FlagShip with your applications without any risc. Compared to the full FlagShip license, it is limited only as follows: - The compiler and with it produced executables run for 30 days, but may be freely reinstalled again. - The produced executable has a 1 hour run-time limit and supports four users simultaneously. - Any number of records are supported, but only the first hundred re- cords are writable. - No printed documentation is included in the DEMO version, but the on-line manual "fsman" only. With the Personal or PRO version, a printed manual with more than 1500 pages and binder is included (ex- cept for Linux, where it is optional). The executable produced by this Demo cannot be distributed. The Test Drive is available for a FREE download on Internet or CompuServe. For a small handling fee, you may purchase it on CD-ROM or floppies too. Please call your local distributor (see addresses in "fsman") or multisoft Datentechnik GmbH at +49-89-6490040 for the license pricing. SW AND HW REQUIREMENTS The requirements for FlagShip to work properly on your computer are: - that your hardware and your version of UNIX corresponds to the label on the distributed media, - an already installed UNIX operating system, - at least 15 MB free disk capacity for the installation, - at least 4 MB total RAM (depending on the operating system, 8 to 16 MB RAM are highly recommended). To compile and link the application you will need also - C compiler (cc) and system libraries, - linker (ld). These are usually delivered with the UNIX operating system, but some- times you must order them separately as a "developer's package". If available, you should also install the "8-bit supplement" or "international supplement" to display and manage the full PC character set. Note: on the ftp distribution, the requirements and additional infos are available in the .../FlagShip/demos//requir.doc file. INSTALLATION See the installation instructions above. FlagShip is installed by default mainly in five different public directories: - The executables and scripts in /usr/bin/* - The library in /usr/lib/* (or /usr/lib/386/* on some systems) - The header files in /usr/include/* - FlagShip dependent sources and infos in /usr/FSsrc/* The FlagShip on-line manual in /usr/FSsrc/manual/* - The FlagShip compiler settings in /etc/FSconfig For a complete index of the files and their destination, refer to the on-line manual "fsman", section GEN.3.2. The deinstallation may be performed automatically using the FSuninstall script, see the FlagShip manual GEN.3.4. THE FlagShip ON-LINE MANUAL The FlagShip on-line manual "fsman" is automatically installed using the ./FSinstall or ./FSinstCD installation script. During the instal- lation procedure, the required indices are build automatically. When the installation is finished, you should invoke the FlagShip on- line manual to become familiar with using FlagShip. Enter: $ [ newfswin | newfscons | newfsterm ] fsman Refer to the manual page "man fsman" for more details. If you are short on disk space on the /usr file system, you may copy the FlagShip online manual to any other directory or file system of your choice. If so, follow the instruction in the "man" page "fsman" or in the /usr/FSsrc/manual/fsman.doc file and set the exported envi- ronment variable FSMAN to the new directory. PREDEFINED TERMINAL SETTING FlagShip fully supports the terminal independent environment using the Unix curses and 'terminfo' facilities assigned by the TERM environment variable. Since the usually predefined terminals, like 'ansi', 'vt100' etc. do not support all the required function keys, an extended terminal specification for the most used terminals comes with FlagShip. These extended terminal names start with FSxxx (or fsxxx on Linux), e.g. FSansi instead of 'ansi'. HINTS TO PORT DOS APPLICATIONS TO UNIX Since FlagShip is fully source-code compatible to the latest CA/Clipper release 5.3 (and earlier) and therefore also to most of the other xBASE, no special program changes are needed. You may insert the statement #include "fspreset.fh" at the beginning of your main program to instruct FlagShip to make all the conversions (lowercase for file and path names etc.) auto- matically. See also online manual "fsman", section LNG.9. Shortly: copy your sources and databases to UNIX (e.g. using DOS flop- pies and the FSload utility on UNIX, or manually using e.g. the doscp program). Be sure to copy the binary data files (.dbf, .dbt, .mem) without CR/LF translation! Then start the FlagShip compiler by $ FlagShip mymain.prg - or - $ FlagShip *.prg -m -Mmymain which is similar to "CLIPPER mymain.prg ; RTLINK/Blinker fi mymain" or to "Clipper @myprg.clp /M ; RTLINK/Blinker fi *.obj" on MS-DOS. Refer to the FlagShip manual section FSC.1.2 for additional information and other compiler options. If the name of the executable is not specified, UNIX creates it with the default name "a.out". Now, you are ready to execute your program the same way as in DOS, e.g. by entering $ a.out -or- $ ./a.out -if the local search path is not specified in PATH- If in Mofif/X11 use the preferred $ newfswin a.out -or- $ newfswin ./a.out With Motif/X11 inactive, on the console terminal use the preferred $ newfscons a.out -or- $ newfscons ./a.out When on a serial line, or other remote system use $ newfsterm $ a.out -or- $ ./a.out $ exit These automatically set the right environment. REQUIREMENTS FOR THE FlagShip COMPILER Carefully read the License Agreement & Warranty in the on-line manual chapter GEN.2 or in the supplied ascii file. You may fill out the Re- gistration Card (the REGCARD file remains in your installation direc- tory, or is available in /usr/FSsrc/REGCARD* and in the FlagShip manual) and send it off. Check and/or set the exported environment variable PATH to be able to access the /usr/bin and the local directory, e.g. $ env (-or- printenv) $ OLDPATH=$PATH ; export OLDPATH $ PATH="$PATH::/usr/bin" ; export PATH On SUN-OS (Solaris 1), you have to add the directory /usr/5bin into the PATH if not there, by using $ PATH="/usr/5bin:$PATH::/usr/bin" ; export PATH Check the settings in the /etc/FSconfig file according your used system, set the environment variable FSCONFIG according to your installation path, if not installed in the /etc (or in the current) directory, e.g. $ FSCONFIG=/my/install/path ; export FSCONFIG For more information, refer to the on-line or printed manual, section FSC and the system dependant release notes REL. REQUIREMENTS FOR EXECUTING THE COMPILED APPLICATION Prior to the program execution, you should check the environment variables and the system for correct settings, see chapters FSC.3.1 and FSC.3.2, especially: PATH Standard UNIX search path. For your convenience, it should also include the directory containing the current executable and/or "::" for the current directory search. TERM Definition of the currently used terminal (preferably an FSxxx one, for full support of special keys and the extended character set. See also section REL: Predefined Terminals and system dependent notes). Additional environment variables, e.g. LINES, COLUMNS, LANG, TERMINFO, TZ, FSOUTPUT, SCRMAP and x_FSDRIVE may also affect the executable, see FlagShip manual, section FSC.3.3. With dynamic libraries, also the LD_RUN_PATH and LD_LIBRARY_PATH environment variables may be required, see details in fsman, section FSC.1.7 and FSC.3.3 For additional information on RAM requirements, UNIX security size restrictions, swapping and kernel tuning, refer to the section SYS in your FlagShip printed manual or in the on-line manual "fsman". Note: If the "Demo version" was used to compile the application, the following message is displayed at program start: This program was developed with the DEMO version of FlagShip (c) Copyright 1989..1996 by multisoft GmbH Munich/Germany Of course, this or a similar message does NOT appear automatically with the regular FlagShip license, but upon request (a.out -FSversion) only. For more information, refer to the FlagShip manual, section FSC.3. LICENSE AGREEMENT AND WARRANTY Read the file .../FlagShip/docu/license.doc (or ./german/lizenz.doc) or the section GEN.2 in the FlagShip manual BEFORE starting work with FlagShip. SEE ALSO UNIX man pages "fsman" or the equivalent file /usr/FSsrc/manual/ fsman.doc FlagShip on-line manual program "fsman", select sections "Manual", "GENeral", "RELease Notes". TECH SUPPORT Available for registered users for FREE at your dealer or distributor within the initial period of at least three monhts (country dependant). See also the section REL and GEN.4 in the FlagShip manual. COPYRIGHT FlagShip is copyright (c) 1996 by multisoft Datentechnik GmbH, Gruen- wald/Munich, Germany. All rights reserved worldwide. Refer to the on- line manual for a full address of your local distributor or call/write to: -------------------------------------------------------------------------- multisoft Datentechnik GmbH Telephone (+49-89) 649-0040 POBox 312 Fax (+49-89) 641-2974 82027 Gruenwald/Munich CompuServe 74431,552 and GO FLAGSHIP Germany Internet info@fship.com www.fship.com -------------------------------------------------------------------------- Enjoy FlagShip!