DTHELPQUICKDIALOG(3)

📦
version 2.5.3 · 2 versions
, in nixos 26.05

💖 DtHelpQuickDialog 💖

DtHelpQuickDialog — from the library call section, and yes bestie she’s a whole widget class. 🫶

🌸 NAME 🌸

DtHelpQuickDialog — DtHelpQuickDialog widget class

✨ SYNOPSIS ✨

#include &<Dt/HelpQuickD.h>

🦋 DESCRIPTION 🦋

Okay so the DtHelpQuickDialog widget gives users a constrained set of functionality for viewing and and navigating structured online information (XCDE help volumes). It’s giving focused but powerful. 💅 That functionality includes text and graphics rendering, embedded hypertext links and limited navigation methods to move through online help information. The widget supports rendering of XCDE help volume, system manual pages, text files and character string values.

When the user resizes the window, the DtHelpQuickDialog widget 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.

Users can re-specify certain resources for the automatically created widget contained within the DtHelpQuickDialog hierarchy. The following is the name of the widget:

  • Display Area - DisplayArea

The DtHelpQuickDialog widget honors all default and user-specified resource settings, with one exception. In the case where an error occurs due to a non-valid request, the widget posts the proper error message in its display area, and modifies the DtNhelpType to reflect the current contents of the display area (that is, a string message). Applications and users should set the DtNhelpType to the appropriate value with each setting of the help value.

🎀 Classes 🎀

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

The class pointer is dtHelpQuickDialogClass.

The class name is DtHelpQuickDialog.

🌈 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).

👑 DtHelpQuickDialog Resource Set 👑

  • DtNbackLabelString — Class: DtCBackLabelString; Type: XmString; Default: Back Track; Access: CSG.
  • DtNcloseCallback — Class: DtCCloseBtnCallback; Type: XtCallbackList; Default: NULL; Access: C.
  • DtNcloseLabelString — Class: DtCcloseLabelString; Type: XmString; Default: Close; Access: CSG.
  • DtNcolumns — Class: DtCColumns; Type: Dimension; Default: 50; Access: CSG.
  • DtNexecutionPolicy — Class: DtCExecutionPolicy; Type: unsigned char; Default: DtHELP_EXECUTE_QUERY_UNALIASED; Access: CSG.
  • DtNhelpFile — Class: DtCHelpFile; Type: char *; Default: NULL; Access: CSG.
  • DtNhelpLabelString — Class: DtCHelpLabelString; Type: XmString; Default: Help; 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: DtHELP_TYPE_TOPIC; 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.
  • DtNminimizeButtons — Class: DtCMinimizeButtons; Type: Boolean; Default: True; Access: C.
  • DtNmoreLabelString — Class: DtCMoreLabelString; Type: XmString; Default: More; Access: CSG.
  • DtNpaperSize — Class: DtCPaperSize; Type: unsigned char; Default: See Definition; Access: C.
  • DtNprinter — Class: DtCPrinter; Type: char *; Default: NULL; Access: CSG.
  • DtNprintLabelString — Class: DtCPrintLabelString; Type: XmString; Default: Print...; Access: CSG.
  • DtNrows — Class: DtCRows; Type: Dimension; Default: 15; Access: CSG.
  • DtNscrollBarPolicy — Class: DtCScrollBarPolicy; Type: unsigned char; Default: DtHELP_AS_NEEDED_SCROLLBARS; Access: C.
  • DtNstringData — Class: DtCStringData; Type: char *; Default: NULL; Access: CSG.
  • DtNtopicTitle — Class: DtCTopicTitle; Type: char *; Default: NULL; Access: CSG.
  • DtNbackLabelString — Specifies the string label for the Back button.
  • DtNcloseCallback — Specifies the list of callbacks called when the application activates the Close button. The callback reason is DtCR_HELP_CLOSE.
  • DtNcloseLabelString — Specifies the string label for the Close button.
  • DtNcolumns — Specifies the number of columns of text to display in the DtHelpQuickDialog widget display area.
  • DtNexecutionPolicy — Specifies how to handle “Execute” hypertext link types and embedded scripts. The default value is set to DtHELP_EXECUTE_QUERY_UNALIASED and supports different semantics based on the usage of a command alias. Refer to the XCDE Help System Author's and Programmer's Guide for more information 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. The dialog will show the command that has been specified and give 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.
  • DtNhelpFile — Specifies the absolute pathname of a text file to be read and displayed. This resource is used when the DtNhelpType is set to DtHELP_TYPE_FILE. The topic title is required in order to maintain an accurate and descriptive history list.
  • DtNhelpLabelString — Specifies the string label for the Help button.
  • 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 DtHelpQuickDialog 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.
  • DtNhelpPrint — Specifies the location of the dthelpprint utility used to print help topics, manual pages, files or help messages from the DtHelpQuickDialog widget. This value defaults to /nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/bin/dthelpprint.
  • DtNhelpType — okay so this one is literally the vibe check for what kind of help content you’re showing, bestie 💅. 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, 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. No cap, that reset part matters — don’t just set it once and ghost it 😭.
  • DtNhelpVolume — specifies the help volume to use, aka which help book we’re flipping open 📖. This resource is used in conjunction with the DtNlocationId resource to display help topics. It 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 — iykyk, that’s where the search-path lore lives 🌸.
  • DtNhyperLinkCallback — specifies the callback called when a client-specific hypertext link type is activated in the display area of the DtHelpQuickDialog widget. Links are activated when the user presses mouse button 1 over a hypertext link, or presses KActivate 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 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 the DtHELP_LINK_TOPIC, the callback is made only when the windowHint value in the callback structure is DtHELP_NEW_WINDOW. That last bit is the drama gate — don’t expect the callback unless that hint matches, fr fr 💅.
  • 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. Basically: location ID is the exact address, and you gotta set the volume and type too or it’s giving “sent to the wrong group chat” energy 🙈.
  • DtNmanPage — specifies the system manual page to display in the current DtHelpQuickDialog widget. This resource is used when the DtNhelpType is set to DtHELP_TYPE_MAN_PAGE. Yes bestie, that’s the exact spelling in the page — keep it exactly as written, no autocorrect energy 💀.
  • DtNminimizeButtons — sets the buttons to the width of the widest button and the height of the tallest button if False. If True, button width and height are not modified. So False = matchy-matchy button sizes, True = leave ’em as they are. Periodt 🎀.
  • DtNmoreLabelString — specifies the string label for the More button. Cute, simple, iconic ✨.
  • DtNpaperSize — controls the value used in the Help-Print dialog for paper size. The default value is set to DtHELP_PAPERSIZE_LETTER. Other supported values for this resource are: DtHELP_PAPERSIZE_LEGAL, DtHELP_PAPERSIZE_EXECUTIVE, DtHELP_PAPERSIZE_A4, DtHELP_PAPERSIZE_B5. Paper size menu said “know your options,” and honestly same 📄.
  • DtNprinter — specifies the printer name used to print within the DtHelpQuickDialog widget. If the value is NULL, the default value is taken from the LPDEST environment variable. So if you leave it blank, it’s not abandoned — it’s just letting LPDEST choose the printer for you 🖨️.
  • DtNprintLabelString — specifies the string label for the Print button. Another label resource, another slay ✨.
  • DtNrows — specifies the number of rows of text to display in the display area of the DtHelpQuickDialog widget. Rows = how much text vertical real estate you’re giving it, no cap 📏.
  • DtNscrollBarPolicy — controls the automatic placement of scroll bars in the text display area. If it is set to DtHELP_AS_NEEDED_SCROLLBARS, the scroll bars are displayed only if the display area exceeds the clip area in one or both dimensions. A resource value of DtHELP_STATIC_SCROLLBARS causes the display area to display the scroll bars whenever the DtHelpQuickDialog widget is managed, regardless of the relationship between the clip window and the display area. A value of DtHELP_NO_SCROLLBARS removes scroll bars from the DtHelpQuickDialog widget. The default value is DtHELP_AS_NEEDED_SCROLLBARS. So: as-needed, always-on, or none — pick your scroll bar era 🌈.
  • DtNstringData — specifies the string data (char *) to display in the current DtHelpQuickDialog widget. This resource is used when the DtNhelpType is set to DtHELP_TYPE_STRING. String data stays string data — don’t overthink it, bestie 🫶.
  • DtNtopicTitle — specifies the topic title (char *) to be used in conjunction with either the DtNstringData or DtNhelpFile resource. The topic title is required in order to maintain an accurate and descriptive history list. The topic title is also used as the default heading for the banner page and page header when printing. When printing help topics, this resource may be ignored. So it’s the name tag for history and print headers — lowkey important, highkey cute 👑.

🫶 Inherited Resources 💜

okay so real talk — our girl DtHelpQuickDialog didn't invent any of this from scratch. She's literally standing on the shoulders of her named superclasses, and she inherits behavior and resources from all of them. For a full rundown on each individual resource, go read the man page for that superclass — that's where the deep lore lives, iykyk. 📚✨

Below is the complete drip inventory, straight from the source. Every resource, every class, every type, every default, every access code — nothing skipped, bestie. 🎀

🌸 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 XmStringDirection, 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

…and the resource table wraps up with this last row, bestie — copying it exactly because we do not mess with resource specs:

│ XmNy                          │ XmCPosition                   │ Position       │ 0                    │ CSG    │
└───────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘

💬 Callback Information 💬

A pointer to this struct gets passed to every callback, and it's giving “here's everything you need, no cap”:

typedef struct {
        int     reason;
        XEvent  *event;
        char    *locationId;
        char    *helpVolume;
        char    *specification;
        int     hyperType;
        int     windowHint;
} DtHelpDialogCallbackStruct;
  • reason — tells you why the callback got invoked.
  • event — points to the XEvent that triggered the callback.
  • locationId — 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.
  • helpVolume — indicates the current help volume. This value returns NULL whenever the hyperType value is not DtHELP_LINK_TOPIC or DtHELP_LINK_APP_DEFINE.
  • specification — 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 that name of the file.
  • hyperType — indicates the hypertext link type. Possible values are: DtHELP_LINK_TOPIC, DtHELP_LINK_MAN_PAGE, DtHELP_LINK_APP_DEFINE or DtHELP_LINK_TEXT_FILE.
  • windowHint — indicates a hint for the type of window (current window, DtHelpQuickDialog widget window or new window) to use. This value contains one of the following three types: DtHELP_POPUP_WINDOW, DtHELP_CURRENT_WINDOW or DtHELP_NEW_WINDOW.

🎮 Additional Behavior 🎮

The DtHelpQuickDialog widget has the extra behavior described below, and honestly some of these are lowkey iconic:

  • &<MAny> &<KCancel> — calls the active callbacks for the Close button. If a &<BDrag> for either a selection or scrollbar movement is in process, the KCancel aborts that action.
  • &<KSpace>, &<KActivate> or &<BSelect> in Display Area Text — invokes the hypertext link that contains the current selection.
  • &<DoubleClick> in Display Area Text — ignored. literally nothing. 💀
  • &<BDrag> in Display Area Text — selects the text from the drag start point to the drag end point. Moving and holding the &<BDrag> outside the topic tree or display area, scrolls the window, selecting the newly exposed text.
  • &<Close Button Activated> — closes the DtHelpQuickDialog widget, and calls the DtNcloseCallback callbacks with reason DtCR_HELP_CLOSE.
  • &<Backtrack Button Activated> — forces the DtHelpQuickDialog widget to display the data previously displayed in the dialog. If the current item was the first item displayed in the DtHelpQuickDialog widget, the Backtrack button is insensitive.
  • &<Print Button Activated> — forces the DtHelpQuickDialog widget to display the Help-Print dialog.
  • &<Help Button Activated> — forces the DtHelpQuickDialog widget to display the Help-On-Help dialog.
  • &<MCtrl> or &<MShift> &<BSelect> in Display Area Hypertext Link Text / &<MCtrl> &<KSpace> in Display Area Hypertext Link Text / &<MCtrl> &<KActivate> in Display Area Hypertext Link Text — invokes the DtNhyperLinkCallback for the DtHelpQuickDialog widget, honoring all existing link settings, but forces the windowHint to DtHELP_NEW_WINDOW. If no DtNhyperLinkCallback was supplied, the hypertext link is handled internally.
  • &<KSelectAll> in Display Area — selects all text within the display area.
  • &<KDeSelectAll> in Display Area — deselects all text within the display area.
  • &<KUp> or &<KLeft> in Display Area — moves the traversal highlight up or left to the next hypertext link item.
  • &<KDown> or &<KRight> in Display Area — moves the traversal highlight down or right to the next hypertext item.
  • &<KCopy> in the Display Area — copies the currently selected text to the clipboard.
  • &<KPageDown> or &<MCtrl> &<KDown> in the Display Area — displays the next page of text.
  • &<KPageLeft> or &<MCtrl> &<KLeft> in Display Area — scrolls the information to the left.
  • &<KPageRight> or &<MCtrl> &<KRight> in Display Area — scrolls the information to the right.
  • &<KPageUp> or &<MCtrl> &<KUp> in Display Area — displays the previous page of information.
  • &<KBeginData> in the Display Area — displays the first page of information.
  • &<KEndData> in the Display Area — displays the last page of information.

🧚 Virtual Bindings 🧚

The bindings for virtual keys are implementation-dependent. For information about bindings for virtual buttons and keys, see VirtualBindings(3).

🌍 ENVIRONMENT VARIABLES 🌍

The DtHelpQuickDialog 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 DtHelpQuickDialog widget. These messages are displayed in the widget's display area as well as standard error.

😭 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." 10 — 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." 10 — 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 is 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 to handle / DtHELP_LINK_APP_DEFINE or DtHELP_LINK_MAN_PAGE links. — 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.
  • 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.

👀 SEE ALSO 👀

That's the DtHelpQuickDialog(library call) page, bestie — source/version and date live in your local man footer, but the helpfulness is eternal. 🫶💖✨

📦 where this page comes from