Purpose of the '.IX' tags in manual pages?

Purpose of the '.IX' tags in manual pages?

Post by Jan Altenhoen » Fri, 31 Jan 1997 04:00:00



Hi,

I am working on a SPARC with SOLARIS 2.4, but the same problem exists for
SUNOS 4.1.1. Many of the basic manual pages contain the tag '.IX'. I think,
that these tags should define additional entries in the 'windex' (SOLARIS)
or 'whatis' (SUNOS) contents tables. I have included a section from 'cd.1'
as an example for the usage of the '.IX' tag:

  .IX "cd" "" "\fLcd\fP \(em shell built-in functions to change the current working directory"
  .IX "chdir" "" "\fLchdir\fP \(em shell built-in functions to change the current working directory"
  .IX "pushd" "" "\fLpushd\fP \(em shell built-in functions to change the current working directory"
  .IX "popd" "" "\fLpopd\fP \(em shell built-in functions to change the current working directory"
  .IX "dirs" "" "\fLdirs\fP \(em shell built-in functions to change the current working directory"
  .IX "shell command interpreter builtin-functions" cd "" "\(em \fLcd\fP"
  .IX "shell command interpreter builtin-functions" chdir "" "\(em \fLchdir\fP"
  .IX "shell command interpreter builtin-functions" pushd "" "\(em \fLpushd\fP"
  .IX "shell command interpreter builtin-functions" popd "" "\(em \fLpopd\fP"
  .IX "shell command interpreter builtin-functions" dirs "" "\(em \fLdirs\fP"

As far as I know, the shell-script '/usr/lib/makewhatis' is used to create
the on all contents tables 'windex' or 'whatis' on all systems. The script
does not recognize the '.IX' tag on all systems and seems to have remained
unchanged for a very long period of time. I have included the 'extracting'
lines from the script:

  sed  </tmp/whatisx.$$ \
        -e 's/\\-/-/' \
        -e 's/\\\*-/-/' \
        -e 's/ VAX-11//' \
        -e 's/\\f[PRIB0123]//g' \
        -e 's/\\s[-+0-9]*//g' \
        -e '/ - /!d' \
        -e 's/.TH [^ ]* \([^    ]*\).*  \(.*\) -/\2 (\1)         -/' \
        -e 's/   /      /g' | \
  awk '{        title = substr($0, 1, index($0, "- ") - 1)
        synop = substr($0, index($0, "- "))
        count = split(title, n, " ")
        for (i=1; i<count; i++) {
                if ( (pos = index(n[i], ",")) || (pos = index(n[i], ":")) )
                        n[i] = substr(n[i], 1, pos-1)
                printf("%s\t%s %s\t%s\n", n[i], n[1], n[count], synop)
        }
  }' >/tmp/whatis$$

Am I wrong in my opinion about the purpose of the '.IX' tag or why is the
tag not recognized in the '/usr/lib/makewhatis' shell script?

Thank you in advance,

Jan Altenh"oner

-------------------------------------------------------------------------------
       __
       \/             Jan Altenhoener                  Phone: 49-0711-821-47757
+---------------+     Department: VS/EWA1
| A L C A T E L |     70430 Stuttgart        
+---------------+     Germany

-------------------------------------------------------------------------------

 
 
 

Purpose of the '.IX' tags in manual pages?

Post by Michael Salmo » Wed, 05 Feb 1997 04:00:00



> Hi,

> I am working on a SPARC with SOLARIS 2.4, but the same problem exists for
> SUNOS 4.1.1. Many of the basic manual pages contain the tag '.IX'. I think,
> that these tags should define additional entries in the 'windex' (SOLARIS)
> or 'whatis' (SUNOS) contents tables. I have included a section from 'cd.1'
> as an example for the usage of the '.IX' tag:

>   .IX "cd" "" "\fLcd\fP \(em shell built-in functions to change the current working directory"
[...]
> Am I wrong in my opinion about the purpose of the '.IX' tag or why is the
> tag not recognized in the '/usr/lib/makewhatis' shell script?

man -s5 man says:

     .IX t          no     -          Index macro, for Sun internal use.

--
? 1995,1996,1997 Michael Salmon
All opinions expressed in this article remain the property of
Michael Salmon.  Permission is hereby granted for use in
followup articles, FAQ's and digests.

 
 
 

1. cvsup doesn't like tags 'ports-all' & 'doc-all'

Trying to cvsup RELENG_3_0_0_RELEASE completed with src tree updating,
but then started clobbering my ports and doc trees.  My cvsupfile
specifies src-base, src-bin,... , src-usrsbin, ports-all, doc-all (on
separate lines).  Has the specification for getting a top-level tree
changed, since these tags used to work with 3.0 betas?  Will I have to
enumerate each subdir for the ports-* and doc-* tree, like with src-*?
TIA!
--
Anthony Jenkins (aka Scoobi_doo at yahoo.com, Computer sections)
http://www.auburn.edu/~jenkian
------
Doh - Homer Simpson

2. Need example code for TLI

3. Acer Extensa 670CDT Where's the repair manual (not just a user's manual)?

4. Help! I can't execute "cc"?

5. MANual pages on ***ix machines, XFree and HTML

6. HELP : how to get user_id after login/passwd authentication.

7. What's 'side effects' of Ksh built-ins?

8. reboot: read-only file system!!!???

9. Solaris Answerbook inadequate (was Re: MANual pages on ***ix machines, XFree and HTML)

10. MANual pages on ***ix machines, XFree and HTML

11. 'info' displays hyphens in man pages as '^i' instead of '-'

12. dwww won't handle same-page tag references ?

13. Kernel messages: ``bad page table'' and ``swap_free: weirdness''