# $OpenBSD: README,v 1.2 2011/01/05 16:13:53 stu Exp $

cat << "EOTEXT" > /dev/null

The OpenBSD port of the Tcl dynamic language was designed to balance
deriving the maximum value from the original software while keeping any
modifications to a minimum. This document describes these differences and
includes a handy guide and patch for adding Tcl and Tk to /etc/man.conf.

The principal change is to the locations of installed files. In order to
be able to install multiple versions of Tcl on OpenBSD without conflict,
some deviation from the original installation has been performed.


Tclsh / Wish

Tclsh and wish are installed as tclsh8.5 and wish8.5, respectively.
Many Tcl programs expect to find tclsh or wish.
They will have to be modified to launch the correct shell or links
tclsh and wish may be created which point to tclsh8.5 and wish8.5,
respectively. These links may have already been created by the
system administrator. It is of course also possible to create one's
own links.


Files / Directories

Library files
scripts, encoding files, etc.
normally in
/usr/local/lib/tcl8.5, /usr/local/lib/tk8.5
now in
/usr/local/lib/tcl/tcl8.5, /usr/local/lib/tcl/tk8.5

Configuration files
tclConfig.sh, tkConfig.sh
normally in
/usr/local/lib
now in
/usr/local/lib/tcl/tcl8.5, /usr/local/lib/tcl/tk8.5

Header files
*.h
normally in
/usr/local/include
now in
/usr/local/include/tcl8.5, /usr/local/include/tk8.5

Manual pages
*.1, *.3, *.n
normally in
/usr/local/man
now in
/usr/local/man/tcl8.5, /usr/local/man/tk8.5

Demos
*.tcl, *
normally in
/usr/local/lib/tk8.5/demos
now in
/usr/local/share/examples/tk8.5

Bundled Modules
*.tm
normally in
/usr/local/lib/tcl8/...
now in
/usr/local/lib/tcl/tcl8.5/modules/...

Module Paths
normally
/usr/local/lib/tcl8/...
now
/usr/local/lib/tcl/modules/...


Additional Header Files

Additional ('private') header files are installed
in /usr/local/include/tcl8.5 and /usr/local/include/tk8.5.


Libraries

On architectures that support shared libraries, additional static
libraries (libtcl85.a, libtk85.a) are built from the -fPIC compiled
object (.o) files.  A soft link from any lib.a is created to lib_pic.a
in order to satisfy libtool.


Manual Page Configuration

Changes to /etc/man.conf are required so that OpenBSD's man(1) and
related commands can find the Tcl and Tk manual pages.

Additional _whatdb entries are needed which point to the Tcl and Tk
whatis.db files. The Tcl and Tk manual page directories need to be added
to the _default and n sections. Additional sections tcl and tk point to
the Tcl and Tk manual page directories.

Following this text is a patch (with instructions) that will perform
the aforementioned changes on an unmodified /etc/man.conf. If not
used directly it can serve as a guide.


Tcl/Tk resources:

Newsgroup: nntp://comp.lang.tcl
Wiki:      http://wiki.tcl.tk
Tutorial:  http://www.tcl.tk/man/tcl8.5/tutorial/tcltutorial.html
Wikibook:  http://en.wikibooks.org/wiki/Programming:Tcl
Book:      Practical Programming in Tcl and Tk, 4th Edition
           ISBN: 0-13-038560-3



EOTEXT

#
# Patch to add Tcl and Tk to /etc/man.conf
#
# Run:
# "$ sh /usr/local/share/doc/pkg-readmes/tcl-8.5.9 > man.conf.new"
# Examine and install as /etc/man.conf
# if it appeases you.
#
cat << "EOPATCH" | patch -p0 -s -o - /etc/man.conf
--- man.conf.orig
+++ man.conf
@@ -7,6 +7,8 @@
 _whatdb		/usr/share/man/whatis.db
 _whatdb		/usr/local/man/whatis.db
 _whatdb		/usr/X11R6/man/whatis.db
+_whatdb		/usr/local/man/tcl8.5/whatis.db
+_whatdb		/usr/local/man/tk8.5/whatis.db
 
 # Subdirectories for paths ending in '/', IN SEARCH ORDER.
 _subdir		cat1 man1 cat8 man8 cat6 man6 cat2 man2 cat3 man3 cat5 man5 cat7 man7 cat4 man4 cat9 man9 cat3p man3p cat3f man3f catn mann
@@ -31,12 +33,14 @@
 # directory with all of the subdirectories listed for the keyword _subdir.
 
 # default
-_default	/usr/{share,X11R6,local}/man/
+_default	/usr/{share,X11R6,local}/man/{,{tcl,tk}8.5/}
 
 # Other sections that represent complete man subdirectories.
 X11		/usr/X11R6/man/
 X11R6		/usr/X11R6/man/
 local		/usr/local/man/
+tcl		/usr/local/man/tcl8.5/
+tk		/usr/local/man/tk8.5/
 
 # Specific section/directory combinations.
 1		/usr/{share,X11R6,local}/man/{cat,man}1
@@ -52,4 +56,4 @@
 7		/usr/{share,X11R6,local}/man/{cat,man}7
 8		/usr/{share,X11R6,local}/man/{cat,man}8
 9		/usr/share/man/{cat,man}9
-n		/usr/local/man/{cat,man}n
+n		/usr/local/man/{,{tcl,tk}8.5/}{cat,man}n
EOPATCH

# EOF
