InfoDock V4 UNIX/Linux Installation Instructions BeOpen.com 08/07/1999 1. To download the InfoDock software, from a shell: mkdir cd ftp ftp.beopen.com Name (ftp.beopen.com): anonymous Password: ftp> cd pub/infodock ftp> bin -- Enables binary transfers ftp> prompt -- Allows multiple downloads with one cmd ftp> mget * -- Download all files ftp> quit You should now have the following files: ID-INSTALL - The file which you are now reading ID-NEWS - What's new in each release of InfoDock ID-OP-SYSTEM - The operating system versions with which each architecture-specific InfoDock archive is compatible ID-README - Overview of InfoDock ID-SIZES - The compressed and uncompressed sizes of each InfoDock archive beopen-infodock-aux-$VERSION.tgz Auxiliary (external) libraries linked into some InfoDock binaries; all of these libraries are available separately from various sites on the Internet beopen-infodock-core-$VERSION.tgz Preformatted manuals and runtime data files beopen-infodock-el-$VERSION.tgz Source and compiled Lisp code used at runtime by InfoDock tools beopen-infodock-$ARCHITECTURE-$VERSION.tgz The InfoDock executable and supporting executables beopen-infodock-sdk-$VERSION.tgz Build scripts and InfoDock-specific Lisp source code tree. beopen-infodock-src-$VERSION.tgz C and Lisp source code for InfoDock's text editor. BeOpen.com provides all of its software in pre-built form. We provide support for these binaries. We do not support customer built binaries. The source is for your local reference and for expert modification. The `sdk' and `src' files are not needed in order to run InfoDock; if you prefer, you need not download these archives. beopen-infodock-update$UPDATE-NUMBER-$VERSION.tgz Unpack any of these archives after all others to update a few run-time files which have changed since the 4.0.8 release. $ARCHITECTURE reflects the system the binaries were built on (such as sparc-sun-solaris), and $VERSION is the InfoDock version number (such as 4.0.8). The archives beopen-infodock-core-$VERSION.tgz, beopen-infodock-el-$VERSION.tgz, and beopen-infodock-$ARCHITECTURE-$VERSION.tgz are the only ones required to run InfoDock. Any others are optional. 2. You will need the GNU gunzip program in order to unpack the InfoDock archives. You can get it from: "ftp://ftp.gnu.org/pub/gnu". Look for the gzip-* archive. 3. Choose a location, such as "/opt/beopen/infodock", under which to install InfoDock. This is where the InfoDock source and executable tree will be placed. Installation of all archives requires about 130 megabytes of storage. The C source code takes up about 30 megabytes of this space. We will call this root directory, , throughout the rest of this document (the <> imply a fill-in-the-blank name, not literal angle brackets). 4. Create the directory or if it exists, ensure that it is empty. Then move into it. mkdir cd rm -rf * .* 5. The following commands create all the subdirectories below and unpack the software there. For each tarred and gzipped file, , in (where you placed the InfoDock archives), execute the following command (or see the C-shell loop below to unpack all archives at once): gunzip -c / | tar xvf - OR Under the Bourne (sh), Korn (ksh) or Bash (bash) shells, the following loop will unpack all of the archives in sequence (do not `cd' anywhere): for f in /*.tgz do gunzip -c $f | tar xvf - done OR Under the C-shell (csh), the following loop will unpack all of the archives in sequence (do not `cd' anywhere): foreach f (/*.tgz) gunzip -c $f | tar xvf - end After unpacking all of the archives, move or copy the ID-INSTALL and ID-README files that you downloaded into the {INFODOCK} directory, replacing files by the same name there, since these versions are often newer than the ones in the distribution archives. 6. InfoDock contains a powerful rolodex program that is part of the Hyperbole subsystem. There is also a standalone rolodex script, "${INFODOCK}/scripts/wrolo.pl", that lets you search your rolodex file outside of InfoDock, from a shell. However, it requires that you have the Perl program installed. If you want to use this script, modify the first line in wrolo.pl to reflect the location of your Perl executable. 7. InfoDock contains a feature requested by several BeOpen.com clients which upon startup of InfoDock (and when quitting InfoDock) sends a logging e-mail message to BeOpen.com which simply details who started it, at what time and in what environment. This information is used solely for for supporting clients and for determining usage levels at particular sites (clients often need this information to inform management about support needs). The information in individual usage log entries will not be shared with any third party organizations. If you do not want these logging messages generated, you can disable them for yourself by adding the following line to your "~/.infodock" file (create it if necessary): (setq inhibit-usagelog t) Alternatively, you can disable these messages for all users of this installation of InfoDock by adding the above line to a file called "site-start.el" that should be placed in the "${INFODOCK}/lib/infodock/infodock-packages/lisp/site/" directory. 8. Set up your environment so that /bin is in your executable search path. Then the following command will run InfoDock: infodock Dependent on your network, processor, and disk speeds, InfoDock may take 15-60 seconds to load in all of its initial features. InfoDock will display a wheat-colored window (a frame in InfoDock parlance) after it starts (except on HP-UX where a gray and off-white window will appear for compatibility with CDE and Windows application appearances). This frame should contain a menubar whose first entry is `InfoDock' and whose last entry is `Mode-Menubars'. You should also see a toolbar of icons. Congratulations. You are now running InfoDock and have finished the installation. The rest of this document provides some tips for examining new features and understanding the organization of InfoDock's directories and user interface. 9. Pull down the `InfoDock -> Help' menu with any mouse button and select the `What-Is-New?' item. This displays a buffer summarizing the new features in this release of InfoDock. It is a bit dated at this point but will be updated throughout the next quarter. You may also print this out from: "${INFODOCK}/id-etc/ID-NEWS". 10.You may click with your middle mouse button on all of the double quoted pathnames in this document to jump to any of the paths mentioned. Within the InfoDock Directory-Editor, your middle button will also open directories and files for you to view. 11.The right mouse button displays mode-specific popup menus. If you use the `Mode-Menubars' button at the right of the menubar, then each tool (actually every major mode) in InfoDock will have its own unique menubar, similar to the mode-specific popup menus. Another click of this button will toggle back to a common menubar. 12.Typically, you should never need to start a second InfoDock session while you have one running. If you need a way to tell InfoDock to edit a file from a command-line, use: id-edit or to edit at a specific line number: id-edit + To send a Lisp expression to InfoDock, use: id-eval '' On UNIX/Linux systems, the EDITOR environment variable informs programs of what text editor to use. Set this to `id-edit' to use InfoDock as your editor. 13.Printed versions of the InfoDock Manual are available from BeOpen.com. The manual contains an architectural diagram of InfoDock and many screen shots to give you a feel for what it can do for you. You may want to read "(infodock)Setup", the Setup section in the InfoDock Manual for per user setup instructions. (Click your middle mouse button within the double quotes to browse the setup documentation.) -- The End --