Initial import of the CDE 2.1.30 sources from the Open Group.

cde/programs/dthelp/dthelpgen/Imakefile

@@ -0,0 +1,17 @@
+XCOMM $XConsortium: Imakefile /main/6 1996/04/21 19:29:32 drk $
+PROGRAMS = dthelpgen
+
+    DEFINES = -DCDE_INSTALLATION_TOP=\"$(CDE_INSTALLATION_TOP)\" \
+              -DCDE_CONFIGURATION_TOP=\"$(CDE_CONFIGURATION_TOP)\"
+   INCLUDES = -I.
+
+DEPLIBS = $(DEPDTHELPLIB) $(DEPDTSVCLIB) $(DEPTTLIB) $(DEPXMLIB) $(DEPXTOOLLIB) $(DEPXPLIB) $(DEPXLIB)
+LOCAL_LIBRARIES = $(DTHELPLIB) $(DTSVCLIB) $(TTLIB) $(XMLIB) $(XTOOLLIB) $(XPLIB) $(XLIB)
+SYS_LIBRARIES = DtClientSysLibs $(CXXLIB)
+
+EXTRA_INCLUDES = -I$(DTHELPSRC)
+
+SRCS = helpgen.c version.c
+OBJS = helpgen.o version.o
+
+ComplexProgramTarget($(PROGRAMS))

cde/programs/dthelp/dthelpgen/dthelpgen.dtsh

@@ -0,0 +1,139 @@
+#! /usr/dt/bin/dtksh
+#####################################################################
+###  File:              dthelpgen.dtsh
+###
+###  Default Location:  /usr/dt/bin/dthelpgen.dtsh
+###
+###  Purpose:           Display a 'working' dialog for dthelpgen.
+###
+###  Description:       This shell script provides a graphical interface
+###                     to notify the user that the help browser is
+###                     being (re)generated.
+###
+###  Invoked by:        The the dthelpgen application.
+###
+###  Product:           @(#)Common Desktop Environment 1.0          
+###
+###  Note:              Please do not modify this file.
+###                     Later product updates will overwrite this file.
+###
+###  Revision:          $XConsortium: dthelpgen.dtsh /main/3 1995/11/07 13:13:18 rswiston $
+###
+###  Defect(s):         
+###
+#####################################################################
+set -u
+
+##################################################################
+###  Internal Globals
+###
+###  Actually, most variables in this script are global.
+###
+###  Most are defined in the Initialize() routine.
+###
+##################################################################
+COMMAND_NAME=dthelpgen
+#
+# Exit/Return codes
+#
+SUCCESS=0
+USAGE_EXIT=2
+NO_INIT_FILE_ERR=5
+
+failure_flag=$SUCCESS
+
+##################################################################
+###  Initialize()
+###
+###         Initialize the tile, msg and cat id.
+###
+##################################################################
+Initialize()
+{
+    CAT_MESG_TITLE=""
+    CAT_MESG_MSG=""
+
+    catopen CAT_ID $COMMAND_NAME
+
+}
+
+##################################################################
+###  Exit()
+###
+###	All exits should go through this routine.
+###
+##################################################################
+Exit() {
+        exit $1
+}
+
+##################   GUI Callbacks  ####################
+
+#
+# This is the callback for the 'OK' button.  It will exit the program
+#
+OkButton()
+{
+  XtUnmanageChild $_DT_WORKING_DIALOG_HANDLE
+  
+  XSync $DISPLAY True
+
+  Exit 0
+}
+
+#
+# This is the callback if the timer goes off
+#
+# TimerCB()
+# {
+# 
+# CAT_MESG_MSG=${CAT_MESG_MSG}"."
+# XtSetValues $_DT_WORKING_DIALOG_HANDLE \
+# 	messageString:"${CAT_MESG_MSG}"
+# 
+# XtAppAddTimeOut TIMER_ID $TIMER_CONTEXT $TIMER_TIME "TimerCB" ""
+# 
+# }
+
+##################################################################
+###  Main()
+###
+###  Display a 'working' dialog for dthelpgen.
+###
+##################################################################
+
+Initialize
+
+if [[ -r /usr/dt/lib/dtksh/DtFuncs.dtsh ]]
+then
+	. /usr/dt/lib/dtksh/DtFuncs.dtsh
+else
+    echo Sorry--cannot find initialization file.
+    Exit $NO_INIT_FILE_ERR
+fi
+
+XtInitialize TOPLEVEL dthelpgenDialog Dthelpgen ""
+
+XtDisplay DISPLAY $TOPLEVEL
+
+catgets CAT_MESG_TITLE $CAT_ID 2 6 "${COMMAND_NAME}"
+catgets CAT_MESG_MSG   $CAT_ID 2 7 \
+			"Generating browser information. Please wait."
+
+DtkshDisplayWorkingDialog "${CAT_MESG_TITLE}" \
+				"${CAT_MESG_MSG}"  \
+				"OkButton" "" ""   \
+				DIALOG_PRIMARY_APPLICATION_MODAL
+
+XtManageChild $_DT_WORKING_DIALOG_HANDLE
+
+# XtWidgetToApplicationContext TIMER_CONTEXT $_DT_WORKING_DIALOG_HANDLE
+# XtGetMultiClickTime TIMER_TIME $DISPLAY
+# XtAppAddTimeOut TIMER_ID $TIMER_CONTEXT $TIMER_TIME "TimerCB" ""
+
+XtMainLoop
+
+#
+#  Never reached.
+#
+#####################         eof       ##############################

cde/programs/dthelp/dthelpgen/dthelpgen.msg

@@ -0,0 +1,158 @@
+$ $XConsortium: dthelpgen.msg /main/3 1995/11/07 13:13:35 rswiston $
+$ *****************************************************************************
+$
+$ ***** NOTE FOR MESSAGE CATALOG TRANSLATORS *****
+$
+$ There may be three types of messages in this file:
+$
+$  1. Messages that appear in dialogs or are displayed to the user.
+$
+$     These messages are the default and they should ALL BE LOCALIZED.
+$     Note that these messages do NOT have any identification (see the
+$     comments for type 2 and 3 below).
+$
+$  2. Messages that only appear in the DT error log file ($HOME/.dt/errorlog).
+$
+$     The localization of these messages is OPTIONAL.  These messages are
+$     identified by the following:
+$
+$  MESSAGES xx-yy IN SET zz WILL ONLY APPEAR IN THE DT ERRORLOG FILE
+$
+$  3. Messages that should not be localized.
+$
+$     These messages are identified by the following:
+$
+$  DO NOT TRANSLATE or CHANGE or LOCALIZE MESSAGES xx-yy from set zz
+$
+$ ***** END (NOTE FOR MESSAGE CATALOG TRANSLATORS) *****
+$
+$ ******************************************************************************
+$
+$set 1
+$
+$ _DtMessage 1 is the usage message
+$
+$ Localize only the words 'directory', 'name', and 'language'.
+$ 'directory' means the directory name in which the resulting files
+$ will be placed. 'name' mean what base name to give the files placed
+$ in 'directory'. 'language' means which localized versions of help files
+$ to look for.
+$
+1 %s -dir <directory> [-generate] [-file <name>] [-lang <language>]\n
+
+$
+$ Mesages 2-18 are error messages.
+$
+2 %s: Element of %s is not a directory\n
+3 %s: Access denied for directory %s\nTry running as super user?\n
+4 %s: Element of %s does not exist\n
+5 %s: File system containing %s is full\n
+6 %s: Unable to access %s - error status number %d\n
+7 %s: File system containing %s is read only\n
+8 %s: Requires root permission to write to %s\n
+9 %s: Write to %s invalid\n
+10 %s: Search Path empty\n
+11 %s: 'title' resource missing\n
+12 %s: 'abstract' resource missing\n
+13 %s: 'volumes' resource missing\n
+14 %s: 'character' set resource missing\n
+15 %s: Destination directory missing\n
+16 %s: Zero Family files found\n
+17 %s: Zero Volume files found\n
+18 %s: Unable to access current working directory - error status number %d\n
+19 %s: Unable to allocate memory\n
+20 %s: Invalid system language specified %s\n
+
+$
+$set 2
+$
+$ Specifies the character set used to create this file
+$
+$ This must be localized for the various languages. That is
+$ for Japanese shift JIS, it would be 'ja_JP.SJIS'; for Japanese 
+$ EUC it would be 'ja_JP.eucJP'. For files written using
+$ HP Roman8 character set it would be '<lang+terr>.HP-ROMAN8', etc.
+$ The set of allowable locale strings can be found in
+$ /usr/dt/config/svc/CDE.lcx
+$
+1 C.ISO-8859-1
+
+$
+$ Specifies the title for the browser.
+$ It is used in the body of text displayed to the user.
+$
+2 Welcome to Help Manager
+
+$
+$ Specifies the body of text displayed in the browser.
+$
+$ When localizing, DO NOT alter any text between the "<" and ">" pairs.
+$ That is - DO NOT localize the tags such as <ABBREV> and <PARAGRAPH>.
+$           DO     localize the text between the tags.
+$
+3 <ABBREV>Welcome to the Help Manager</ABBREV>                          \
+<PARAGRAPH>Each of the titles listed below represents a\n               \
+<ANGLE italic> product family</>\n                                      \
+that has installed and registered its online help.  Each title\n        \
+(and icon) is a hyperlink that lists the help within the family.</>     \
+<PARAGRAPH after 0 first 1 left 3 label "<CHAR C.DT-SYMBOL-1><0xB7></>"> \
+To display a list of the help available for a product family, choose\n  \
+its title (underlined text) or icon.</PARAGRAPH>                        \
+<PARAGRAPH after 0 first 1 left 3 label "<CHAR C.DT-SYMBOL-1><0xB7></>"> \
+Within a product family, find the help you want to view, then\n         \
+choose its title.</PARAGRAPH>                                           \
+<PARAGRAPH first 1 left 3 label "<CHAR C.DT-SYMBOL-1><0xB7></>">        \
+If you need help while using help windows, press F1.</PARAGRAPH>
+
+$
+$ Specifies the Volume Title
+$
+4 Help - Top Level
+
+$
+$ Specifies the preamble to the help file if no volumes or family files
+$ are found.
+$
+$ When localizing, DO NOT alter any text between the "<" and ">" pairs.
+$ That is - DO NOT localize the tags such as <ABBREV> and <PARAGRAPH>.
+$           DO     localize the text between the tags.
+$
+5 <ABBREV>Welcome to the Help Manager</ABBREV>                           \
+<LINK 0 "Help4Help How-To-Register-Help">                                \
+<TYPE serif><WEIGHT bold><SIZE 12><ANGLE italic>                         \
+Note:\ \ \ No Help Registered                                            \
+</SIZE></WEIGHT></TYPE></></LINK>                                        \
+<PARAGRAPH leftindent 3 firstindent 3>                                   \
+<WEIGHT bold>No product families have registered their online help       \
+files for browsing.</>  Help may be available for some applications by   \
+choosing Help commands directly within the applications.</>
+
+$
+$ Specifies the title to use in the dthelpgen dtksh dialog.
+$
+6 dthelpgen
+
+$
+$ Specifies the message to display in the dthelpgen dtksh dialog.
+$ This message indicates that dthelpgen is building (or rebuilding)
+$ the browser information.
+$
+7 Generating browser information. Please wait.
+
+$
+$set 3
+$
+$ ******* Text Formatting Templates ********
+$ DO NOT TRANSLATE THESE MESSAGES
+$ DO NOT CHANGE THESE MESSAGES
+$ DO NOT LOCALIZE THESE MESSAGES
+$
+1 <TOPIC charset %s>
+2 <TITLE><TYPE serif><WEIGHT bold><SIZE 14>%s</SIZE></WEIGHT></TYPE></TITLE>
+3 <PARAGRAPH before 1 first 1 left 1>
+4 <CHARACTERSET %s>
+5 <TYPE serif><WEIGHT bold><SIZE 12><ANGLE italic>%s</></></></>
+6 <PARAGRAPH before 1 first 1 left 1 graphic %s glink %s gtypelink 0>
+7 <PARAGRAPH before 1 first 1 left 1 graphic %s glink "%s %s" gtypelink 1>
+
+

cde/programs/dthelp/dthelpgen/nlsMsgChk.txt

@@ -0,0 +1,172 @@
+# $XConsortium: nlsMsgChk.txt /main/2 1996/11/11 11:28:27 drk $
+helpgen is a non-Motif (terminal based) application. It creates three files,
+<filename>.hv, <filename>00.ht and <filename>01.ht in the target directory.
+The default target directory is '/usr/dt/help/<language>/Browser'. The
+default <filename> is 'browser'.
+
+1)  To get the usage message, type
+	helpgen -help
+
+    tests message:
+	Set 1  _DtMessage: 1
+
+2)  Specify a name using the -dir option that is not a directory. To do
+    this, create a file in the /tmp directory, then use it as if it were
+    a directory. For example, type:
+
+	touch /tmp/testdir
+	helpgen -dir /tmp/testdir/testfile
+
+    Remove /tmp/testdir when finished.
+
+    tests message:
+	Set 1  _DtMessage: 2
+
+3)  Attempt to write to a directory that only the super-user (system
+    administrator)  has permission to write to. To do this, check that
+    the directory /usr/vhelp/help exists and that write permission is
+    denied for the average user. For example, type:
+
+	ll -d /usr/vhelp/help.
+
+    If the permission shown do not allow the average user access, continue.
+    Otherwise, change them to disallow access or create and/or use another
+    directory that does not allow the average user access.
+
+    Upon finding a suitable directory for testing, type the following (this
+    example assumes /usr/vhelp/help is being used):
+
+	helpgen -dir /usr/vhelp/help/testdir.
+
+    tests message:
+	Set 1  _DtMessage: 3
+
+4)  Specify a name using the -dir option that is not a directory. To do
+    this, create a file in the /tmp directory, then use it as if it were
+    a directory. For example, type:
+
+	touch /tmp/testdir
+	helpgen -dir /tmp/testdir
+
+    Remove /tmp/testdir when finished.
+
+    tests message:
+	Set 1  _DtMessage: 6
+
+5)  Attempt to overwrite an existing read-only browser volume. To do this,
+    check the permissions on the files in the directory
+    /usr/dt/help/C/Browser. If the permissions allow the average user
+    to access these files, change the permissions to allow only the
+    super-user access. Type:
+
+	helpgen
+
+    tests message:
+	Set 1  _DtMessage: 8
+
+6)  Create a browser volume in a read-only directory. To do this, create
+    a directory without write permission. For example, type:
+
+	mkdir /tmp/testdir
+	chmod -w /tmp/testdir
+
+    Now use the read-only directory as the parameter to the -dir option:
+
+	helpgen -dir /tmp/testdir
+
+    Remove /tmp/testdir when finished.
+
+    tests message:
+	Set 1  _DtMessage: 9
+
+7)  Copy a family file to a work directory. Edit the file and remove
+    the 'title' resource from the file. Symbolically link this file
+    to the directory /usr/vhelp/families/<language>. Type:
+
+	helpgen -dir /tmp
+
+    Remove the symbolic link in /usr/vhelp/families/<language> and
+    the browser volumes in /tmp when done.
+
+    tests message:
+	Set 1  _DtMessage: 11
+
+8)  Copy a family file to a work directory. Edit the file and remove
+    the 'abstract' resource from the file. Symbolically link this file
+    to the directory /usr/vhelp/families/<language>. Type:
+
+	helpgen -dir /tmp
+
+    Remove the symbolic link in /usr/vhelp/families/<language> and
+    the browser volumes in /tmp when done.
+
+    tests message:
+	Set 1  _DtMessage: 12
+
+9)  Copy a family file to a work directory. Edit the file and remove
+    the 'volumes' resource from the file. Symbolically link this file
+    to the directory /usr/vhelp/families/<language>. Type:
+
+	helpgen -dir /tmp
+
+    Remove the symbolic link in /usr/vhelp/families/<language> and
+    the browser volumes in /tmp when done.
+
+    tests message:
+	Set 1  _DtMessage: 13
+
+10) Copy a family file to a work directory. Edit the file and remove
+    the 'charSet' resource from the file. Symbolically link this file
+    to the directory /usr/vhelp/families/<language>. Type:
+
+	helpgen -dir /tmp
+
+    Remove the symbolic link in /usr/vhelp/families/<language> and
+    the browser volumes in /tmp when done.
+
+    tests message:
+	Set 1  _DtMessage: 14
+
+11) Move the directory /usr/vhelp/familes to /usr/vhelp/familes.save.
+    NOTE: This requires the user to be super-user.
+    Type:
+
+	helpgen -dir /tmp
+
+    Restore the families directory by moving /usr/vhelp/families.save
+    to /usr/vhelp/families.
+
+    tests message:
+	Set 1  _DtMessage: 16
+
+12) Move the directory /usr/vhelp/volumes to /usr/vhelp/volumes.save.
+    NOTE: This requires the user to be super-user.
+    Type:
+
+	helpgen -dir /tmp
+
+    Restore the families directory by moving /usr/vhelp/volumes.save
+    to /usr/vhelp/volumes.
+
+    tests message:
+	Set 1  _DtMessage: 17
+
+13) Run helpgen as super-user. Run helpview. The application helpview,
+    can either be run from a terminal window or by selecting the icon on
+    the front panel showing books with a question mark over them. The
+    window that displays should show the browser volume created by helpgen.
+
+    The text localized in set 2 messages 2 through 4 should be displayed
+    at the top of the window. The text between the <ABBREV> tags in
+    set 2 message 3 will be displayed in the topic hierarchy. The last
+    hypertext link (underlined titles) should be from set 2 message 5.
+
+    The text will use the fonts associated with the character set
+    specified in set 2 message 1. Check that the app-defaults file
+    for helpview contains a font set associated with the character
+    set specified.
+
+    tests messages:
+	Set 2  Messages: 1-5
+	Set 3  Messages: 1-7
+

cde/programs/dthelp/dthelpgen/nlsREADME.txt

@@ -0,0 +1,14 @@
+# $XConsortium: nlsREADME.txt /main/2 1996/11/11 11:28:59 drk $
+#############################################################################
+#
+# Component:  helpgen
+#
+############################################################################
+
+_DtMessage catalog source:
+
+   File name:   helpgen.msg
+
+   Target:      /usr/lib/nls/%l/%t/helpgen.cat
+#
+#

cde/programs/dthelp/dthelpgen/version.c

@@ -0,0 +1,28 @@
+/********************************************************
+
+Copyright (c) 1988 by the Massachusetts Institute of Technology
+
+Permission to use, copy, modify, and distribute this software 
+and its documentation for any purpose and without fee is hereby 
+granted, provided that the above copyright notice appear in all 
+copies and that both that copyright notice and this permission 
+notice appear in supporting documentation, and that the names of 
+Hewlett-Packard or  M.I.T.  not be used in advertising or publicity 
+pertaining to distribution of the software without specific, written 
+prior permission.
+
+(c) Copyright 1996 Digital Equipment Corporation.
+(c) Copyright 1988,1996 Hewlett-Packard Company.
+(c) Copyright 1996 International Business Machines Corp.
+(c) Copyright 1996 Sun Microsystems, Inc.
+(c) Copyright 1996 Novell, Inc. 
+(c) Copyright 1996 FUJITSU LIMITED.
+(c) Copyright 1996 Hitachi.
+
+********************************************************/
+
+#include <include/hpversion.h>
+
+#ifndef	lint
+version_tag("dthelpgen:       $XConsortium: version.c /main/5 1996/08/30 15:39:04 drk $")
+#endif	/* lint */