DTHELPDIALOG(3)

πŸ“¦
version 2.5.3 Β· 2 versions
, in nixos 26.05

okay bestie, welcome to the DtHelpDialog manual page β€” yep, it's a library call β€” and it's literally the docs for the DtHelpDialog widget class. This is part 1, and we're keeping every single detail, no cap. πŸ’–


πŸ’– NAME πŸ’–

DtHelpDialog β€” the widget class, the library call, the main character β€” is what this whole page is about. Periodt. ✨

πŸ¦‹ SYNOPSIS πŸ¦‹

#include &<Dt/HelpDialog.h>

✨ DESCRIPTION ✨

okay so the DtHelpDialog widget gives users the full toolkit for viewing and navigating structured online information (XCDE help volumes). We're talking text and graphics rendering, embedded hypertext links, and various navigation methods to move through online help information. It supports rendering of XCDE help volumes, system manual pages, text files and character string values. Obsessed. πŸ’…

When the user resizes the window, DtHelpDialog dynamically reformats its contents to fit the new window size if the DtNhelpType of the contents is DtHELP_TYPE_TOPIC or DtHELP_TYPE_DYNAMIC_STRING. If the DtNhelpType of the contents is DtHELP_TYPE_STRING, DtHELP_TYPE_MAN_PAGE or DtHELP_TYPE_FILE, the contents are not reformatted. Instead, scroll bars may appear when the user resizes the window smaller than the help contents. The exact scrollbar behavior is controlled by the DtNscrollBarPolicy resource. Lowkey important, bestie. πŸŒ€

Users can re-specify certain resources for the automatically created widgets and gadgets contained within the DtHelpDialog widget hierarchy. The names of these widgets (or gadgets) are:

  • Topic Tree β€” TocArea
  • Display Area β€” DisplayArea
  • Button Box β€” BtnBox

The DtHelpDialog widget honors all default and user-specified resource settings, with one exception.

bestie, this is the exception, so pay attention: if an error occurs due to an invalid request, DtHelpDialog posts the proper error message in its display area and modifies the DtNhelpType resource to reflect the current contents of the display area (that is, a string message). Applications and users should set the DtNhelpType resource to the appropriate value with each setting of the DtHelpDialog widget. 😭

πŸŽ€ Classes πŸŽ€

The DtHelpDialog widget inherits behavior and resources from the Core, Composite, Constraint, XmManager and XmBulletinBoard classes.

The class pointer is dtHelpDialogClass.

The class name is DtHelpDialog. Iconic behavior. πŸ‘‘

🌈 New Resources 🌈

To reference a resource by name or by class in a .Xdefaults file, the application must remove the DtN or DtC prefix and use the remaining letters. To specify one of the defined values for a resource in a .Xdefaults file, the application must remove the Dt prefix and use the remaining letters (in either lower case or upper case, but including any underscores between words). The codes in the access column indicate if the given resource can be set at creation time (C), set by using XtSetValues (S), retrieved by using XtGetValues (G), or is not applicable (N/A). Cute spreadsheet energy, but make it terminal. πŸ’…

πŸ“Š DtHelpDialog Resource Set πŸ“Š

Each row is giving Name Β· Class Β· Type Β· Default Β· Access, and we're keeping every crumb:

  • DtNcloseCallback β€” Class: DtCCloseCallback Β· Type: XtCallbackList Β· Default: NULL Β· Access: C
  • DtNcolumns β€” Class: DtCColumns Β· Type: Dimension Β· Default: 70 Β· Access: CSG
  • DtNexecutionPolicy β€” Class: DtCExecutionPolicy Β· Type: unsigned char Β· Default: DtHELP_EXECUTE_QUERY_UNALIASED Β· Access: CSG
  • DtNhelpFile β€” Class: DtCHelpFile Β· Type: char * Β· Default: NULL Β· Access: CSG
  • DtNhelpOnHelpVolume β€” Class: DtCHelpOnHelpVolume Β· Type: char * Β· Default: See Definition Β· Access: C
  • DtNhelpPrint β€” Class: DtCHelpPrint Β· Type: char * Β· Default: See Definition Β· Access: CSG
  • DtNhelpType β€” Class: DtCHelpType Β· Type: unsigned char Β· Default: See Definition Β· Access: CSG
  • DtNhelpVolume β€” Class: DtCHelpVolume Β· Type: char * Β· Default: NULL Β· Access: CSG
  • DtNhyperLinkCallback β€” Class: DtCHyperLinkCallback Β· Type: XtCallbackList Β· Default: NULL Β· Access: C
  • DtNlocationId β€” Class: DtCLocationId Β· Type: char * Β· Default: See Definition Β· Access: CSG
  • DtNmanPage β€” Class: DtCManPage Β· Type: char * Β· Default: NULL Β· Access: CSG
  • DtNpaperSize β€” Class: DtCPaperSize Β· Type: unsigned char Β· Default: See Definition Β· Access: C
  • DtNprinter β€” Class: DtCPrinter Β· Type: char * Β· Default: NULL Β· Access: CSG
  • DtNrows β€” Class: DtCRows Β· Type: Dimension Β· Default: 25 Β· Access: CSG
  • DtNscrollBarPolicy β€” Class: DtCScrollBarPolicy Β· Type: unsigned char Β· Default: See Definition Β· Access: C
  • DtNstringData β€” Class: DtCStringData Β· Type: char * Β· Default: NULL Β· Access: CSG
  • DtNtopicTitle β€” Class: DtCTopicTitle Β· Type: char * Β· Default: NULL Β· Access: CSG
  • DtNvisiblePathCount β€” Class: DtCVisiblePathCount Β· Type: int Β· Default: 7 Β· Access: C

The original table also has tgroup dispwid="7.63in" hanging out after that last row β€” keeping it exactly, no edits. 🫢

now the resource-by-resource tea, bestie: β˜•

  • DtNcloseCallback β€” This is the list of callbacks called when the user activates the Close button. The callback reason is DtCR_HELP_CLOSE. Bye bestie, but make it callback. πŸ‘‹
  • DtNcolumns β€” Sets the number of columns of text to display in the display area of the DtHelpDialog widget. Width queen behavior. πŸ“
  • DtNexecutionPolicy β€” This one controls how Execute hypertext link types and embedded scripts get handled. The default value is DtHELP_EXECUTE_QUERY_UNALIASED and supports different semantics based on the usage of a command alias. The XCDE Help System Author's and Programmer's Guide has the full lore on command alias usage. With the default value and no command alias, a query dialog will be posted upon user selection of an execute hypertext link. That dialog shows the command that has been specified and gives the user the option to Execute Anyway, Don't Execute or request help for more information. When a command alias is present for the selected link, the command will execute silently, and no query dialog will be posted.

Other values for this resource are DtHELP_EXECUTE_NONE, DtHELP_EXECUTE_ALL and DtHELP_EXECUTE_QUERY_ALL. DtHELP_EXECUTE_NONE forces all execute hypertext links to be ignored. DtHELP_EXECUTE_ALL allows all execute hypertext links to be executed silently upon link selection by the user, and DtHELP_EXECUTE_QUERY_ALL forces the query dialog to be posted with every link invocation. Execute policy realness. πŸ”₯

  • DtNhelpFile β€” Specifies the absolute pathname of a text file to be read and displayed. This resource is used when DtNhelpType is set to DtHELP_TYPE_FILE. File path moment. πŸ“‚
  • DtNhelpOnHelpVolume β€” Specifies the help volume that contains the help topics for the help user-interface components in the widget. This is displayed in an instance of the DtHelpDialog widget when the user requests help from within the widget. The default value for this resource is Help4Help, which refers to the default-supported help volume. This resource supports absolute pathnames and pathless help volume names. When just a volume name is used, the volume must be placed or linked to one of the default search locations, or one of the two help search path environment variables must be properly set. See the ENVIRONMENT VARIABLES section for more information on setting and modifying these variables. Help-ception, but make it cute. 🫢
  • DtNhelpPrint β€” Specifies the location of the dthelpprint(1) utility used to print help topics, manual-page files or help messages from the DtHelpDialog widget. This value defaults to /nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/bin/dthelpprint. Print it, bestie. πŸ–¨οΈ
  • DtNhelpType β€” Specifies the current topic type. When the value is DtHELP_TYPE_TOPIC, the DtNlocationId and DtNhelpVolume resources are used and the requested help topic is displayed. When the value is DtHELP_TYPE_STRING or DtHELP_TYPE_DYNAMIC_STRING, the DtNstringData resource is used and the requested string is displayed. When the value is DtHELP_TYPE_FILE, the DtNhelpFile resource is used and the requested text file is displayed. When the value is DtHELP_TYPE_MAN_PAGE, the DtNmanPage resource is used and the requested system manual page is displayed.

The initial default value is DtHELP_TYPE_TOPIC; however, each time there is a request to display a help topic, text file, manual page or text string, the user should reset DtNhelpType to the proper type. Do not forget the reset, bestie β€” it's giving required behavior. 😭

  • DtNhelpVolume β€” Specifies the help volume to use. This resource is used in conjunction with the DtNlocationId resource to display help topics. This resource supports absolute pathnames and pathless help volume names. When using just a volume name, the volume must be placed in or linked to one of the default search locations, or one of the two help search path environment variables must be properly set. See the ENVIRONMENT VARIABLES section for more information on setting and modifying these variables. Volume selection is highkey a whole vibe. πŸ“š
  • DtNhyperLinkCallback β€” Specifies the callback that is called when a client-specific hypertext link is activated in the display area of the DtHelpDialog widget. Links are activated when the user presses mouse button 1 over a hypertext link, or presses return with the keyboard focus on the hypertext link item. The callback reason is DtCR_HELP_LINK_ACTIVATE. DtNhyperLinkCallback allows applications to register a callback procedure that is used to process one of four hypertext link types: DtHELP_LINK_APP_DEFINE, DtHELP_LINK_TOPIC, DtHELP_LINK_MAN_PAGE or DtHELP_LINK_TEXT_FILE. For DtHELP_LINK_TOPIC, the callback is made only when the windowHint value in the callback structure is DtHELP_NEW_WINDOW. Link activation icon behavior. πŸ”—
  • DtNlocationId β€” Specifies a help topic to display. Applications reference topics within a help volume using a location ID. Location IDs are author-defined at help volume creation time. Applications use these location IDs to display the desired help topic. The default value for this resource is _HOMETOPIC, which refers to the help volume's top level topic. DtNhelpVolume must be set to the help volume in which the corresponding location ID resides, and DtNhelpType must be set to DtHELP_TYPE_TOPIC. Location ID realness. 🎯
  • DtNmanPage β€” Specifies the system manual page to display in the current DtHelpDialog widget. This resource is used when DtNhelpType is set to DtHELP_TYPE_MAN_PAGE. Man page moment, fr fr. πŸ“–
  • DtNpaperSize β€” controls the value used in the Help-Print dialog for paper size. Default is DtHELP_PAPERSIZE_LETTER. Other supported values are DtHELP_PAPERSIZE_LEGAL, DtHELP_PAPERSIZE_EXECUTIVE, DtHELP_PAPERSIZE_A4, and DtHELP_PAPERSIZE_B5. πŸ–¨οΈβœ¨
  • DtNprinter β€” specifies the printer name to use when printing inside the DtHelpDialog widget. If the value is NULL, the default is taken from the LPDEST environment variable. bestie, that's the whole printer vibe right there.
  • DtNrows β€” specifies the number of rows of text to display in the display area of the DtHelpDialog widget.
  • DtNscrollBarPolicy β€” controls the automatic placement of scroll bars in the text display area. If set to DtHELP_AS_NEEDED_SCROLLBARS, the scroll bars appear only if the display area exceeds the clip area in one or both dimensions. A value of DtHELP_STATIC_SCROLLBARS makes the display area show scroll bars whenever the DtHelpDialog widget is managed, no matter the relationship between the clip window and the display area. A value of DtHELP_NO_SCROLLBARS removes scroll bars from the DtHelpDialog widget. Default is DtHELP_AS_NEEDED_SCROLLBARS. scroll bar behavior, but make it fashion πŸ’…
  • DtNstringData β€” specifies the string data (char *) to display in the current DtHelpDialog widget. This resource is used when DtNhelpType is set to DtHELP_TYPE_STRING.
  • DtNtopicTitle β€” specifies the topic title (char *) to be used with either the DtNstringData or DtNhelpFile resource. The topic title is required to keep an accurate and descriptive history list. It's also used as the default heading for the banner page and page header when printing. When printing help topics, this resource may be ignored. history list staying iconic ✨
  • DtNvisiblePathCount β€” specifies the number of items to display in the topic tree area of the widget.

🧬 Inherited Resources 🧬

The DtHelpDialog widget inherits behavior and resources from these named superclasses. For a complete description of each resource, see the man page for that superclass. yes, go read the parent lore too 🫢

🌸 XmBulletinBoard Resource Set 🌸

  • XmNallowOverlap β€” class XmCAllowOverlap, type Boolean, default True, access CSG.
  • XmNautoUnmanage β€” class XmCAutoUnmanage, type Boolean, default True, access CG.
  • XmNbuttonFontList β€” class XmCButtonFontList, type XmFontList, default dynamic, access CSG.
  • XmNcancelButton β€” class XmCWidget, type Widget, default dynamic, access SG.
  • XmNdefaultButton β€” class XmCWidget, type Widget, default dynamic, access SG.
  • XmNdefaultPosition β€” class XmCDefaultPosition, type Boolean, default True, access CSG.
  • XmNdialogStyle β€” class XmCDialogStyle, type unsigned char, default dynamic, access CSG.
  • XmNdialogTitle β€” class XmCDialogTitle, type XmString, default NULL, access CSG.
  • XmNfocusCallback β€” class XmCCallback, type XtCallbackList, default NULL, access C.
  • XmNlabelFontList β€” class XmCLabelFontList, type XmFontList, default dynamic, access CSG.
  • XmNmapCallback β€” class XmCCallback, type XtCallbackList, default NULL, access C.
  • XmNmarginHeight β€” class XmCMarginHeight, type Dimension, default 10, access CSG.
  • XmNmarginWidth β€” class XmCMarginWidth, type Dimension, default 10, access CSG.
  • XmNnoResize β€” class XmCNoResize, type Boolean, default False, access CSG.
  • XmNresizePolicy β€” class XmCResizePolicy, type unsigned char, default XmRESIZE_ANY, access CSG.
  • XmNshadowType β€” class XmCShadowType, type unsigned char, default XmSHADOW_OUT, access CSG.
  • XmNtextFontList β€” class XmCTextFontList, type XmFontList, default dynamic, access CSG.
  • XmNtextTranslations β€” class XmCTranslations, type XtTranslations, default NULL, access C.
  • XmNunmapCallback β€” class XmCCallback, type XtCallbackList, default NULL, access C.

🌈 XmManager Resource Set 🌈

  • XmNbottomShadowColor β€” class XmCBottomShadowColor, type Pixel, default dynamic, access CSG.
  • XmNbottomShadowPixmap β€” class XmCBottomShadowPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG.
  • XmNforeground β€” class XmCForeground, type Pixel, default dynamic, access CSG.
  • XmNhelpCallback β€” class XmCCallback, type XtCallbackList, default NULL, access C.
  • XmNhighlightColor β€” class XmCHighlightColor, type Pixel, default dynamic, access CSG.
  • XmNhighlightPixmap β€” class XmCHighlightPixmap, type Pixmap, default dynamic, access CSG.
  • XmNinitialFocus β€” class XmCInitialFocus, type Widget, default dynamic, access CSG.
  • XmNnavigationType β€” class XmCNavigationType, type XmNavigationType, default XmTAB_GROUP, access CSG.
  • XmNshadowThickness β€” class XmCShadowThickness, type Dimension, default dynamic, access CSG.
  • XmNstringDirection β€” class XmCStringDirection, type XmString-Direction, default dynamic, access CG.
  • XmNtopShadowColor β€” class XmCTopShadowColor, type Pixel, default dynamic, access CSG.
  • XmNtopShadowPixmap β€” class XmCTopShadowPixmap, type Pixmap, default dynamic, access CSG.
  • XmNtraversalOn β€” class XmCTraversalOn, type Boolean, default True, access CSG.
  • XmNunitType β€” class XmCUnitType, type unsigned char, default dynamic, access CSG.
  • XmNuserData β€” class XmCUserData, type XtPointer, default NULL, access CSG.

πŸ¦‹ Composite Resource Set πŸ¦‹

  • XmNchildren β€” class XmCReadOnly, type WidgetList, default NULL, access G.
  • XmNinsertPosition β€” class XmCInsertPosition, type XtOrderProc, default NULL, access CSG.
  • XmNnumChildren β€” class XmCReadOnly, type Cardinal, default 0, access G.

πŸ‘‘ Core Resource Set πŸ‘‘

  • XmNaccelerators β€” class XmCAccelerators, type XtAccelerators, default dynamic, access N/A.
  • XmNancestorSensitive β€” class XmCSensitive, type Boolean, default dynamic, access G.
  • XmNbackground β€” class XmCBackground, type Pixel, default dynamic, access CSG.
  • XmNbackgroundPixmap β€” class XmCPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG.
  • XmNborderColor β€” class XmCBorderColor, type Pixel, default XtDefaultForeground, access CSG.
  • XmNborderPixmap β€” class XmCPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG.
  • XmNborderWidth β€” class XmCBorderWidth, type Dimension, default 0, access CSG.
  • XmNcolormap β€” class XmCColormap, type Colormap, default dynamic, access CG.
  • XmNdepth β€” class XmCDepth, type int, default dynamic, access CG.
  • XmNdestroyCallback β€” class XmCCallback, type XtCallbackList, default NULL, access C.
  • XmNheight β€” class XmCHeight, type Dimension, default dynamic, access CSG.
  • XmNinitialResourcesPersistent β€” class XmCInitialResourcesPersistent, type Boolean, default True, access C.
  • XmNmappedWhenManaged β€” class XmCMappedWhenManaged, type Boolean, default True, access CSG.
  • XmNscreen β€” class XmCScreen, type Screen *, default dynamic, access CG.
  • XmNsensitive β€” class XmCSensitive, type Boolean, default True, access CSG.
  • XmNtranslations β€” class XmCTranslations, type XtTranslations, default dynamic, access CSG.
  • XmNwidth β€” class XmCWidth, type Dimension, default dynamic, access CSG.
  • XmNx β€” class XmCPosition, type Position, default 0, access CSG.
  • XmNy β€” class XmCPosition, type Position, default 0, access CSG.

πŸ“ž Callback Information πŸ“ž

A pointer to this struct gets passed to each callback:

typedef struct {
        int     reason;
        XEvent  *event;
        char    *locationId;
        char    *helpVolume;
        char    *specification;
        int     hyperType;
        int     windowHint;
} DtHelpDialogCallbackStruct;

The reason argument tells you why the callback was invoked. the why of it all πŸ’…

The event argument points to the XEvent that triggered the callback.

The locationId argument indicates the DtNlocationId for the current topic. This value is NULL whenever the hyperType value is not DtHELP_LINK_TOPIC or DtHELP_LINK_APP_DEFINE.

The helpVolume argument indicates the current help volume. This value is NULL whenever the hyperType value is not DtHELP_LINK_TOPIC or DtHELP_LINK_APP_DEFINE.

The specification argument indicates any author-defined data contained within the selected hypertext link. This value returns NULL if no author-defined data was given. For hyperlinks of type DtHELP_MAN_PAGE, the specification argument contains the name of the manual page. For hyperlinks of type DtHELP_LINK_TEXT_FILE, the specification argument contains the name of the file.

The hyperType argument indicates the hypertext link type. Possible values are DtHELP_LINK_TOPIC, DtHELP_LINK_MAN_PAGE, DtHELP_LINK_APP_DEFINE, or DtHELP_LINK_TEXT_FILE.

The windowHint argument indicates a hint for the type of window to use (quick help, existing window, or new window). This value contains one of these three types: DtHELP_POPUP_WINDOW, DtHELP_CURRENT_WINDOW, or DtHELP_NEW_WINDOW.


🎬 Additional Behavior 🎬

The DtHelpDialog widget has the extra behavior described below, bestie:

  • &<MAny> &<KCancel> β€” calls the active callbacks for the Close button. If a &<BDrag> for either a selection or scrollbar movement is in process, &<KCancel> aborts that action. emergency cancel energy 🚨
  • &<KSpace>, &<KActivate>, or &<BSelect> in Topic Tree Text β€” opens the help topic currently selected, displays that topic in the display area, and updates the topic tree to match the newly displayed topic. topic tree glow-up unlocked ✨
  • &<KSpace>, &<KActivate>, or &<BSelect> in Display Area Text β€” invokes the hypertext link that contains the current selection.
  • &<DoubleClick> in Topic Tree or Display Area Text β€” ignored. literally nothing, bestie πŸ™ˆ
  • &<BDrag> in Topic Tree or Display Area Text β€” selects the text from the drag start point to the drag end point. Moving and holding &<BDrag> outside the topic tree or display area scrolls the window, selecting the newly exposed text. drag, scroll, select, repeat πŸŒ€
  • &<MCtrl> or &<MShift> &<BSelect> in Topic Tree Text β€” fires off the DtNhyperLinkCallback for the DtHelpDialog widget, sets the helpType to DtHELP_LINK_TOPIC, the windowHint to DtHELP_NEW_WINDOW, the helpVolume to the current volume name and the locationId to the selected item's location ID πŸ’«. And if there's no DtNhyperLinkCallback hanging around? The action just gets ignored, no drama.
  • &<MCtrl> &<KSpace> in Topic Tree Text β€” same deal as above, bestie: DtNhyperLinkCallback gets invoked for the DtHelpDialog widget, helpType set to DtHELP_LINK_TOPIC, windowHint to DtHELP_NEW_WINDOW, helpVolume to the current volume name, locationId to the selected item's location ID. No callback supplied = action ignored, periodt.
  • &<MCtrl> &<KActivate> in Topic Tree Text β€” invokes the DtNhyperLinkCallback for the DtHelpDialog widget, setting the helpType to DtHELP_LINK_TOPIC, the windowHint to DtHELP_NEW_WINDOW, the helpVolume to the current volume name and the locationId to the selected item's location ID. If no DtNhyperLinkCallback is supplied, the action is ignored 🫢
  • &<MCtrl> or &<MShift> &<BSelect> in Display Area Hypertext Link Text β€” invokes the DtNhyperLinkCallback for the DtHelpDialog widget, honoring all existing link settings, but forces the windowHint to DtHELP_NEW_WINDOW. If no DtNhyperLinkCallback is supplied, the hypertext link is handled internally ✨
  • &<KSelectAll> in Display Area or Topic Tree β€” selects all text within the topic tree area or display area. select all, copy all, that's the vibe πŸ’…
  • &<KDeSelectAll> in Display Area or Topic Tree β€” deselects all text within the topic tree area or display area. the un-select-all. the de-slay, if you will πŸ™ˆ
  • &<KUp> or &<KLeft> in Display Area or Topic Tree β€” moves the traversal highlight up or left to the next hypertext link item ⬆️⬅️
  • &<KDown> or &<KRight> in Display Area or Topic Tree β€” moves the traversal highlight down or right to the next hypertext item β¬‡οΈβž‘οΈ
  • &<KCopy> in the Display Area or Topic Tree β€” copies the currently selected text to the clipboard πŸ“‹ iconic behavior tbh
  • &<KPageDown> or &<MCtrl> &<KDown> in Display Area or Topic Tree β€” displays the next page of text πŸ“„
  • &<KPageLeft> or &<MCtrl> &<KLeft> in Display Area or Topic Tree β€” scrolls the information to the left πŸ‘ˆ
  • &<KPageRight> or &<MCtrl> &<KRight> in Display Area or Topic Tree β€” scrolls the information to the right πŸ‘‰
  • &<KPageUp> or &<MCtrl> &<KUp> in Display Area or Topic Tree β€” displays the previous page of information πŸ“ƒ
  • &<KBeginData> in the Display Area or Topic Tree β€” displays the first page of information. back to the top, babe ⭐
  • &<KEndData> in the Display Area or Topic Tree β€” displays the last page of information. straight to the bottom 🌈

πŸ’« Virtual Bindings πŸ’«

The bindings for virtual keys are implementation-dependent β€” meaning it's giving "your mileage may vary" energy, no cap πŸ¦‹. For information about bindings for virtual buttons and keys, see VirtualBindings(3).


🌸 ENVIRONMENT VARIABLES 🌸

The DtHelpDialog widget uses two environment variables for locating help volumes within the desktop environment:

  • DTHELPSEARCHPATH β€” the system search path environment variable for locating help volumes on local and remote NFS mounted systems 🌐
  • DTHELPUSERSEARCHPATH β€” the search path environment variable for locating user-specific help volumes on local and remote NFS mounted systems πŸ™‹β€β™€οΈ

The environment variables contain colon-separated lists of directory paths. Each directory path can contain both environment variable names as well as special field descriptors that are expanded at runtime ⚑.

Field descriptors consist of a percent-sign character (%) followed by a single character. Field descriptors and their substitution values are:

  • %H β†’ replaced with the current volume name being searched for πŸ”Ž
  • %L β†’ replaced with the current value of the LANG environment variable πŸ—£οΈ
  • %% β†’ replaced with a single % πŸ’―

The default value for DTHELPUSERSEARCHPATH is:

$HOME/.dt/help/$DTUSERSESSION/%H:
$HOME/.dt/help/$DTUSERSESSION/%H.sdl:
$HOME/.dt/help/$DTUSERSESSION/%H.hv:
$HOME/.dt/help/%H:
$HOME/.dt/help/%H.sdl:
$HOME/.dt/help/%H.hv

The DTHELPUSERSEARCHPATH is first searched for the requested volume πŸ‘‘. If the volume is not found, the DTHELPSEARCHPATH value is searched.

The default value for DTHELPSEARCHPATH path is:

/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/etc/appconfig/help/%L/%H:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/etc/appconfig/help/%L/%H.sdl:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/etc/appconfig/help/%L/%H.hv:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/etc/appconfig/help/C/%H:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/etc/appconfig/help/C/%H.sdl:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/etc/appconfig/help/C/%H.hv:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/appconfig/help/%L/%H:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/appconfig/help/%L/%H.sdl:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/appconfig/help/%L/%H.hv:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/appconfig/help/C/%H:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/appconfig/help/C/%H.sdl:
/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/appconfig/help/C/%H.hv

πŸ”₯ APPLICATION USAGE πŸ”₯

The following messages can be generated as a result of an error or improperly set resource value in the DtHelpDialog widget. These messages are displayed in the widget's display area as well as standard error πŸ‘€ (so yeah, double the chaos, you'll see them twice).

πŸ’€ Error Messages πŸ’€

  • "String data could not be formatted." β€” the error occurred when formatting help information of type DtHELP_TYPE_STRING.
  • "Dynamic string data could not be formatted." β€” the error occurred when formatting help information of type DtHELP_TYPE_DYNAMIC_STRING.
  • "Man Page could not be formatted. The requested man page is either not present, or corrupt." β€” the error occurred when formatting help information of type DtHELP_TYPE_MAN_PAGE.
  • "Text file could not be formatted. The requested text file is either not present, or corrupt." β€” the error occurred when formatting help information of type DtHELP_TYPE_FILE.
  • "Non-supported DtNhelpType value used." β€” the application used a non-supported DtNhelpType πŸ™…β€β™€οΈ
  • "Help topic could not be formatted." β€” the application attempted to access a corrupt runtime help file 😭
  • "No DtNhyperLinkCallback supplied for widget." β€” a hypertext link of type DtHELP_NEW_WINDOW has been selected, but the application has not supplied a hypertext callback to handle it. The link is handled like a DtHELP_CURRENT_WINDOW jump 🫠
  • "Nonexistent DtNlocationId." β€” the requested DtNlocationId is not present in the current help volume πŸ•³οΈ
  • "No DtNhyperLinkCallback supplied for widget." β€” a hypertext link of type DtHELP_LINK_APP_DEFINE or DtHELP_LINK_MAN_PAGE is selected, but the application has not supplied a hypertext callback to handle these link types πŸ’€ (yes it's the same message as above, she's versatile like that)
  • "Could not find DtNhelpVolume." β€” the Help System is unable to find the help volume requested πŸ”
  • "Could not open DtNhelpVolume." β€” the Help System found the requested help volume, but does not have the permission to open it πŸ”’ rude but okay

πŸŽ€ SEE ALSO πŸŽ€

Dt/HelpQuickD.h - DtHelpQuickD(5), Dt/Help.h - DtHelp(5), DtCreateHelpQuickDialog(3), DtHelpSetCatalogName(3); XmManager(3), XmBulletinBoard(3), Core(3), Composite(3), Constraint(3), dthelptagdtd(4) πŸ¦‹


okay that's literally the whole page bestie, you made it to the end 🏁✨ this was the DtHelpDialog(library call) manual page, straight out of the cde 2.5.3 build in the Nix store β€” go forth and hyperlink responsibly, mwah πŸ’–πŸ‘‘

πŸ“¦ where this page comes from