home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / txinf403.zip / texinfo4.zip / README-texinfo-4.0.os2 < prev    next >
Text File  |  2000-04-15  |  17KB  |  554 lines
  1. /*--------------- README -texinfo-4.0.os2 for zip archive ------------------ */
  2.  
  3.                                                                   
  4.                                 ***               ****            
  5.        *                        ***             *** **            
  6.        *                        ***             *** **            
  7.       **                                        ***               
  8.     ******    ****   ***** ******** **** ***   *****    ****      
  9.      ***     **  **   ***   *   ***  **** ***   ***    **  **     
  10.      ***    ***  ***   *** *    ***  ***  ***   ***   ***  ***    
  11.      ***    ***  ***    ***     ***  ***  ***   ***   ***  ***    
  12.      ***    ********     ***    ***  ***  ***   ***   ***  ***    
  13.      ***    ***         ****    ***  ***  ***   ***   ***  ***    
  14.      ***    ***    *    * ***   ***  ***  ***   ***   ***  ***    
  15.      ***  *  ***  *    *   ***  ***  ***  ***   ***    **  **     
  16.       ****    ****   **** *************** **** *****    ****      
  17.                                                               
  18.                                                  OS/2 port release 3
  19.  
  20.  
  21. Table of Contents
  22. =================
  23. Introduction                    @int
  24. New Features of OS/2 port       @new
  25. Required Environment            @req
  26. Installation                    @ins
  27. Compressed Info Files           @com
  28. Documentations and Manuals      @doc
  29. Sample Usage                    @sam
  30. Make from source                @mak
  31. Make rpm package                @rpm
  32.  
  33.  
  34.  
  35.  
  36. Introduction    @int
  37. ============
  38.  
  39.   GNU texinfo version 4.0 is an official release next to version 3.12. 
  40.   OS/2 porting of this Texinfo distribution was easy, because I was 
  41. able to utilize OS/2 patch for last officical version (3.11). 
  42.  
  43.   A good news for 8 bit code world (Japanese, Korean, etc..) is that by 
  44. default 8 bit code is accepted in this version. This means you can
  45. see Japanese Info mannual using "info". Upto now, we were not able to see 
  46. Japanese Info without mule (multi-lingualversion of emacs). 
  47.  
  48.  
  49.  
  50. New Features of OS/2 port    @new
  51. =========================
  52. Release 3
  53.   `makeinfo' accepts Japanese SJIS coded source file. 
  54.  
  55. Release 2
  56.  
  57.   ALT-key can be used as Meta-key (ESC) when argument of Meta-key is only one. 
  58.      c.f. "ALT + x " for "ESC x"
  59.  
  60.  
  61.   Japanese message is available. 
  62.  
  63.   
  64.   DEFAULT_INFO_PRINT_COMMAND is changed from 
  65.                  ">PRN" 
  66.             to 
  67.                  "expand --tabs=4 >>InfoLog.tmp"
  68.  
  69. Release 1
  70.  
  71.   `texindex.exe' can process Japanese Shift JIS code. 
  72.  
  73.   `info.exe' can be used in XFree86 for OS/2 terminals; kterm, xterm, rxvt...
  74.  
  75.     IF XINFO environment variable is not empty, or if TERM environment 
  76.     variable is equal to "xterm", "kterm", or "rxvt", `info' behaves 
  77.     as X client. 
  78.  
  79.  
  80. Required Environment    @req
  81. ====================
  82.  
  83.     Without emx 0.9d runtime, you cannot use precompiled executables. 
  84.     If your emx runtime version is 0.9c or older, get and install emx 0.9d
  85.   from ftp sites. 
  86.  
  87.        ftp://hobbes.nmsu.edu/pub/os2/dev/emx/v0.9d/emxrt.zip
  88.                         or
  89.        ftp://ftp.leo.org/pub/comp/os/os2/leo/gnu/emx+gcc/emxrt.zip
  90.            
  91.  
  92.  
  93.  
  94. Installation    @ins
  95. ============
  96.  
  97.   This manual is OS/2 ported GNU texinfo 4.0 for zip archive, not for rpm. 
  98.   
  99.   You will find in the current directory, `emx-texinfo.zip' which contains 
  100. all files to be installed and `texinfo-list.dat'listing files to be installed. 
  101.  
  102.  
  103. Standard Installation
  104. ~~~~~~~~~~~~~~~~~~~~~
  105.   If you have installed emx runtime in a drive 'x' with following directory 
  106. structure, you can easily install texinfo. 
  107.   
  108.       - emx executables are in `x:/emx/bin'
  109.       - emx DLLs            in `x:/emx/dll'
  110.       - Info manuals        in `x:/emx/info'
  111.       - Documents           in `x:/emx/doc'
  112.       - Man files           in `x:/emx/man'
  113.  
  114.       - "x:\emx\bin" is included in PATH environment variable
  115.       - LIBPATH contains "x:\emx\dll" in your `config.sys'
  116.  
  117.   Unzip `emx-texinfo.zip' in drive 'x'.
  118.   
  119.       \foo> unzip emx-texinfo -d x:\
  120.  
  121.  
  122. Custom Installation
  123. ~~~~~~~~~~~~~~~~~~~
  124.   If you do NOT want to install files in emx tree (x:/emx/bin, x:/emx/dll..), 
  125. unzip `emx-texinfo.zip' in the temporary directory and copy files to proper 
  126. directories like this. 
  127.  
  128.     \foo> unzip emx-texinfo -d c:\tmp
  129.     \foo> c:
  130.     c:\> cd tmp\emx
  131.     c:\tmp\emx> copy bin\* PATH_DIRECTORY          (c.f. "d:\usr\local\bin")
  132.     c:\tmp\emx> copy dll\* LIBPATH_DIRECTORY       (c.f. "c:\OS2\DLL")
  133.     c:\tmp\emx> copy bin\info INFOPATH_DIRECTORY   (c.f. "d:\usr\local\info")
  134.     c:\tmp\emx> xcopy /s doc\* DOC_DIRECTORY       (c.f. "d:\usr\local\doc")
  135.     c:\tmp\emx> xcopy /s man\* MAN_DIRECTORY       (c.f. "d:\usr\local\man")
  136.     c:\tmp\emx> xcopy /s share\locale\* LOCALE_DIRECTORY     
  137.                                                    (c.f. "d:\usr\local\locale")
  138.     c:\tmp\emx> xcopy /s src\* SRC_DIRECTORY       (c.f. "d:\usr\local\src")
  139.     c:\tmp\emx> xcopy /s etc\* ETC_DIRECTORY       (c.f. "d:\usr\local\etc")
  140.  
  141.   After you have installed files in such a way, you must setup or confirm, 
  142. environment variables (PATH, INFOPATH, GNULOCALEDIR, MANPATH) carefully. 
  143.  
  144.  
  145. Setup Language
  146. ~~~~~~~~~~~~~~
  147.  
  148.     Set environment variable `GNULOCALEDIR' in your `config.sys' like this
  149.     
  150.            set GNULOCALEDIR=c:/emx/share/locale
  151.            
  152.                              (Never use '\' in the variable)
  153.  
  154.     You can choose one language
  155.     
  156.            cs : Czech
  157.            de, de_AT : German
  158.            fr : French
  159.            ja : Japanese (SJIS)
  160.            nl : Dutch
  161.            no : Norwegian
  162.            ru : Russian
  163.            eo : Esperanto
  164.            
  165.  
  166.        See `COUNTRY' for complete list of languages
  167.  
  168.  
  169.     If you'd like to see Russain message:
  170.  
  171.            set LANGUAGE=ru           (in `config.sys')
  172.            
  173.  
  174.     If the environment variable `LANGUAGE' is not set, English messages 
  175.     are shown by programs. 
  176.  
  177.  
  178.   Setup environment variable for texinfo
  179.  
  180.      Confirm environment variables, TERMCAP and TERM, are already set. 
  181.            
  182.            If you are new to EMX RUNTIME and don't know how to setup
  183.           termcap, see `INSTALL.DOC' included in `emxrt.zip'. 
  184.  
  185.      Set the INFOPATH environment variable for info, like below
  186.  
  187.          set INFOPATH=.;c:/emx/info;k:/doc/info;l:/emacs-20.4/info;
  188.                                          
  189.      
  190.      Edit a textfile "dir_example" and copy it to "c:/emx/info/dir", 
  191.      only if you are setting up GNU info system for the firest time. 
  192.  
  193.           c:\emx\info> copy dir_example dir
  194.  
  195.   
  196. Setup for XFree86 
  197. ~~~~~~~~~~~~~~~~~
  198.     As mentioned above, if XINFO environment variable is not empty, or 
  199.     if TERM environment varialbe is one of "xterm", "kterm", and "rxvt", 
  200.      `info' behave like X client. 
  201.  
  202.     Add a line, 'set XINFO=SOME_STRING', 
  203.                to your `/XFree86/lib/x11/xinit/xinitrc.cmd' or 
  204.                `/XFree86/bin/startx.cmd' in X11ROOT drive. 
  205.  
  206.          NOTE1: Do not omit the letter ' at the beginning 
  207.                and the end of the line!!
  208.     
  209.          NOTE2: Do not set XINFO variable in `config.sys'. 
  210.  
  211.  
  212. Setup for Print Command
  213. ~~~~~~~~~~~~~~~~~~~~~~~
  214.   When you execute "M-x(ALT+x) print-node", `info' outputs a currend node 
  215. to a file named `InfoLog.tmp' in append mode. 
  216.      
  217.   If you'd like to change default output of "print-node", set environment 
  218. variable INFO_PRINT_COMMAND. 
  219.  
  220.  
  221.      IMPORTANT NOTICE
  222.  
  223.          You can't use '>' or '|' for environment variables in OS/2 command 
  224.          line or in batch file. 
  225.          
  226.          You can contain '>' or '|' in environment variables, when you set 
  227.          variables in `config.sys'. 
  228.  
  229.          If you use unix like shell (ksh, bash,..) for shell, you can freely 
  230.          use '>' or '|'. 
  231.  
  232.  
  233.   You can do like this.
  234.  
  235.          In `config.sys':
  236.  
  237.            set INFO_PRINT_COMMAND=expand --tabs=2 >>Info.log
  238.            set INFO_PRINT_COMMAND=>prn
  239.            set INFO_PRINT_COMMAND=a2ps -E -2 |gsos2 - -sDEVICE=bjc600 -c quit
  240.  
  241.  
  242.          In `~/.bashrc' for bash:
  243.  
  244.            export INFO_PRINT_COMMAND='expand --tabs=2 >>Info.log'
  245.            export INFO_PRINT_COMMAND='>prn'
  246.            export INFO_PRINT_COMMAND='a2ps -E -2 |gsos2 - -sDEVICE=bjc600 -c quit'
  247.  
  248.  
  249.  
  250. Compresed Info Files    @com
  251. ====================
  252.  
  253.     Compressed Info mannuals are available. 
  254.     Use 'gzip' or 'bzip2', and install gunzip.exe or bunzip2.exe if needed. 
  255.  
  256.     If you have gzip.exe or bzip2.exe and don't have gunzip.exe or bzip2.exe, 
  257.  
  258.                    $ copy gzip.exe gunzip.exe
  259.                               or
  260.                    $ copy bzip2.exe bunzip2.exe
  261.  
  262.  
  263.     When there are `a.info', `b.info', `c.info', ... `*.info' in INFO dire-
  264.     ctory. 
  265.  
  266.        DO like this
  267.           
  268.               $ for %a in (*.info) do gzip %a
  269.             
  270.         You'll get `a.info.gz', `b.info.gz', `c.info.gz', .... `*.info.gz'. 
  271.  
  272.  
  273.  
  274. Documentations and Manuals    @doc
  275. ==========================
  276.  
  277.    /emx/doc/texinfo-4.0
  278.         COPYING 
  279.         INTRODUCTION
  280.         README-texinfo-4.0.os2 (This manual you are reading)
  281.         README  
  282.         COUNTRY -  Pre-defined Country Codes 
  283.         FTP  ----  How to get GNU Software by Internet FTP or by UUCP
  284.         KEYS_emacs-jp.os2  # Read these file to know basic
  285.         KEYS_emacs.os2     # command of `info'. By default, key mode 
  286.         KEYS_vi-jp.os2     # If you invoke `info' with "info --vi-keys",
  287.         KEYS_vi.os2        # key mode become vi mode. These files are
  288.                            # are printed with  "ALT+x(M-x) print-node". 
  289.  
  290.    /emx/man/man1/*.1
  291.    /emx/man/man5/*.5
  292.    /emx/info/{info-stnd.info.gz,info.info.gz,texinfo.gz}
  293.  
  294.  
  295.   If you have not installed manpage system, you can get OS/2 ported copy 
  296. from following URLs. 
  297.   
  298.     English only version
  299.  
  300.       ftp://hobbes,hobbes.nmsu.edu/pub/os2/dev/help/
  301.          gnuman.zip        44610 1995/01/31  GNU man 1.0 (for use with groff)
  302.  
  303.       ftp://hobbes,hobbes.nmsu.edu/pub/os2/tex/
  304.          gnugroff.zip    2153647 1996/05/07  GNU groff v1.10
  305.  
  306.     Japanized version ( in my web page)
  307.  
  308.        http://www2s.biglobe.ne.jp/~vtgf3mpr/manpage/groff-man.tar.bz2
  309.           
  310.  
  311.  
  312. Sample Usage    @sam
  313. ============
  314.  
  315. About commands
  316. ~~~~~~~~~~~~~~
  317. Invoke `info' with "info", "info --vi-keys".......
  318.  
  319.  
  320. In emacs mode (default), type BACKSPACE or 'Ctrl+h' for help;
  321. type 'h' for tutorial
  322.  
  323. In vi mode, type `h' for help; type 'ESC h' or 'ALT + h' for tutorial
  324.  
  325.  
  326.   In the HELP screen, you'll see following lines (emacs mode)
  327.   
  328.      ESC b   (backward-word)         Move backward a word
  329.      ESC f   (forward-word)          Move forward a word
  330.      ESC r   (move-to-window-line)
  331.           Move the cursor to a specific line of the window
  332.      ESC v   (scroll-backward)       Scroll backward in this window
  333.      ESC x   (execute-command)
  334.           Read a command name in the echo area and execute it
  335.      ESC DEL (scroll-other-window-backward)  Scroll the other window backward
  336.  
  337.   OS/2 ported `info' release 2 is modified to accept ALT key as meta key, 
  338.   when an argument of meta key is only one. Exceptionally, you can't 
  339.   use 'ALT + TAB' and 'ALT + ESC' for info command, because these are 
  340.   trapped by OS/2 system. 
  341.   
  342.  
  343.   So, you can execute "backward-word" by typing `ALT' and `b' simultaneously, 
  344. instead of typing `ESC' followed by typing `b'. 
  345.   
  346.   Interpret 'ESC ONE_KEY' as 'ALT + ONE_KEY'. 
  347.   
  348.  
  349.  
  350. Processing texinfo source file
  351. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  352.     makeinfo.exe: You make an Info mannual or HTML document with makeinfo. 
  353.  
  354.      To create Info mannuals
  355.      
  356.        $ makeinfo --force --no-split TEXINFO_SOURCE
  357.  
  358.           NOTE: makeinfo cannot create Info from Japanese JIS or EUC sources.
  359.                 If needed, convert to Japanese SJIS. 
  360.  
  361.        
  362.      To create HTML documents
  363.      
  364.        $ makeinfo --force --no-split --html TEXINFO_SOURCE
  365.  
  366.           NOTE: makeinfo cannot create HTML from Japanese JIS or EUC sources.
  367.                 If needed, convert to Japanese SJIS. 
  368.  
  369.  
  370.     texindex.exe: Japanese Shift JIS is okay to process. 
  371.        To compile English Texinfo source to DVI
  372.      
  373.           $ tex FOO.texi
  374.           $ texindex FOO.??
  375.           $ tex FOO.texi
  376.           $ tex FOO.texi
  377.        
  378.        To compile Japanese Texinfo source to DVI
  379.  
  380.          KANJI code must be Shift JIS!! If needed, convert to SJIS and 
  381.          process Texinfo source like this. 
  382.           
  383.            $ ptex FOO.texi
  384.            $ texindex FOO.??
  385.            $ ptex FOO.texi
  386.            $ ptex FOO.texi
  387.      
  388.  
  389.  
  390.    You can also use `texi2dvi.cmd' to make DVI from TeX or LaTeX source. 
  391.  
  392.      If  you process Japanese TeX source, set environment variables like 
  393.      this in your `config.sys', in your batch file, or command line. 
  394.     
  395.               set TEX=ptex
  396.               set LATEX=platex
  397.               set BIBTEX=jbibtex
  398.               set MAKEINDEX=mendex
  399.  
  400.  
  401.  
  402. Make from source    @mak
  403. ================
  404.  
  405. <Without rpm>
  406.  
  407.   Get texinfo-4.0.tar.gz from following URLS. 
  408.      
  409.     <Primary site>
  410.  
  411.      ftp://ftp.gnu.org/gnu/texinfo/texinfo-4.0.tar.gz
  412.  
  413.     <Some Mirrors>
  414.  
  415.         California - labrea.stanford.edu/pub/gnu, gatekeeper.dec.com/pub/GNU
  416.         New York - ftp.cs.columbia.edu/archives/gnu/prep
  417.         Japan - tron.um.u-tokyo.ac.jp/pub/GNU/prep
  418.         Japan - ftp.cs.titech.ac.jp/pub/gnu
  419.         Japan - mirror.nucba.ac.jp/mirror/GNU/
  420.      
  421.       Read `FTP' for complete list of mirror sites. 
  422.      
  423.  
  424.   Unpack and apply patch, `texinfo-4.0-OS2.diff.gz'
  425.  
  426.         $ tar zxvf texinfo-4.0.tar.gz
  427.         $ cd texinfo-4.0
  428.         $ patch -p1 < c:/emx/src/redhat/SOURCRS/texinfo-4.0-OS2.diff.gz
  429.  
  430.  
  431.     Meaning of CFLAGS are:
  432.           -DINFOX: enable XFree86 feature
  433.           -DSJIS:  to process Japanese Shift JIS source ; makeinfo.c
  434.           -DEUC :  to process Japanese EUC source       ; makeinfo.c
  435.  
  436.  
  437.  
  438.     By default programs are compiled and linked with "-Zomf" option for gcc. 
  439.     If you'd like to do without "-Zomf", edit these line of `config.status'. 
  440.  
  441.          s%@CFLAGS@%-D__EMX__ -DOS2 -Zmtd -D__ST_MT_ERRNO__ -O2 -Zomf%g
  442.          s%@LDFLAGS@%-s -Zsysv-signals %g
  443.          s%@EMX_OBJ@%obj%g
  444.          s%@EMX_LIB@%lib%g
  445.          s%@EMX_AR@%emxomfar%g
  446.          s%@LIBOBJS@% strcasecmp.obj strncasecmp.obj%g
  447.  
  448.  
  449.     Compile and link like this way
  450.         
  451.         $ touch config.cache
  452.         
  453.         $ touch config.status
  454.         
  455.         $ sh config.status
  456.     
  457.         $ make
  458.  
  459.               If you want to run `configure' script, do like this. 
  460.               
  461.                         $ cp configure configure.orig
  462.                  
  463.                  Open `os2conf.cmd' by your editor, and modify it if needed
  464.  
  465.                         $ os2conf configure.orig > configure
  466.                         $ ksh
  467.                         ksh> ./configure
  468.                         
  469.                    Add lines to `config.status' 
  470.                        with "-Zomf"
  471.                             s%@EMX_OBJ@%obj%g 
  472.                             s%@EMX_LIB@%lib%g 
  473.                             s%@EMX_AR@%emxomfar%g
  474.                        without "-Zomf"
  475.                             s%@EMX_OBJ@%o%g 
  476.                             s%@EMX_LIB@%a%g 
  477.                             s%@EMX_AR@%ar%g
  478.                    Change two line of `config.status'
  479.                        with "-Zomf"
  480.                             s%@CFLAGS@%-D__EMX__ -DOS2 -Zmtd -D__ST_MT_ERRNO__ -O2 -Zomf%g
  481.                             s%@LIBOBJS@% strcasecmp.obj strncasecmp.obj%g
  482.  
  483.                         ksh> exit
  484.                         $ sh config.status
  485.                         $ make
  486.  
  487.     To check 
  488.  
  489.         $ make check
  490.         
  491.     To install
  492.      
  493.         $ make install prefix=SOMEWHERE
  494.  
  495.  
  496. <With rpm>
  497.  
  498.   Be sure that you already have a diff file and a spec file. 
  499.  
  500.      c:/emx/src/redhat/SOURCES/texinfo-4.0-OS2.diff.gz
  501.      c:/emx/src/redhat/SPECS/texinfo-4.0-os2.spec
  502.  
  503.   Get `texinfo-4.0.tar.gz' and install it in `c:/emx/src/redhat/SOURCES/'. 
  504.   
  505.   
  506.      x:\foo> rpm -bc c:/emx/src/redhat/SPECS/texinfo-4.0-os2.spec
  507.      x:\foo> c:
  508.      c:\> cd emx\src\redhat\BUILD
  509.      c:\emx\src\redhat\BUILD> dir /s *.exe
  510.  
  511.   If `dir' shows all executable names, do check. 
  512.  
  513.      c:\emx\src\redhat\BUILD> make ckeck
  514.  
  515.   
  516.   Installtion is simple
  517.   
  518.      c:\emx\src\redhat\BUILD> make install prefix=SOMEWHERE
  519.  
  520.  
  521.  
  522. Make rpm package    @rpm
  523. ================
  524.  
  525.   For binary rpm 
  526.   
  527.      x:\foo> rpm -bb --clean c:/emx/src/redhat/SPECS/texinfo-4.0-os2.spec
  528.  
  529.  
  530.   For binary and source rpm 
  531.   
  532.      x:\foo> rpm -ba --clean c:/emx/src/redhat/SPECS/texinfo-4.0-os2.spec
  533.  
  534.  
  535.   Or in source directory
  536.   
  537.     $ make -f Makefile.rpm rpm
  538.  
  539.  
  540. Comments, suggestions, or requests are alwary wellcome. 
  541.  
  542. Happy computing life with OS/2!!
  543.  
  544.  
  545. Thu Apr  6 18:15:31 JST 2000
  546.  
  547.  
  548.  
  549.                                              SAWATAISHI Jun, YOKOHAMA, JAPAN 
  550.                                                        <jsawa@attglobal.net>
  551.                              http://www2s.biglobe.ne.jp/~vtgf3mpr/indxos2.htm
  552.  
  553.  
  554.