DTHELPDIALOG(3)
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,DtHelpDialogposts the proper error message in its display area and modifies theDtNhelpTyperesource to reflect the current contents of the display area (that is, a string message). Applications and users should set theDtNhelpTyperesource to the appropriate value with each setting of theDtHelpDialogwidget. π
π 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:CDtNcolumnsβ Class:DtCColumnsΒ· Type:DimensionΒ· Default:70Β· Access:CSGDtNexecutionPolicyβ Class:DtCExecutionPolicyΒ· Type:unsigned charΒ· Default:DtHELP_EXECUTE_QUERY_UNALIASEDΒ· Access:CSGDtNhelpFileβ Class:DtCHelpFileΒ· Type:char *Β· Default:NULLΒ· Access:CSGDtNhelpOnHelpVolumeβ Class:DtCHelpOnHelpVolumeΒ· Type:char *Β· Default:See DefinitionΒ· Access:CDtNhelpPrintβ Class:DtCHelpPrintΒ· Type:char *Β· Default:See DefinitionΒ· Access:CSGDtNhelpTypeβ Class:DtCHelpTypeΒ· Type:unsigned charΒ· Default:See DefinitionΒ· Access:CSGDtNhelpVolumeβ Class:DtCHelpVolumeΒ· Type:char *Β· Default:NULLΒ· Access:CSGDtNhyperLinkCallbackβ Class:DtCHyperLinkCallbackΒ· Type:XtCallbackListΒ· Default:NULLΒ· Access:CDtNlocationIdβ Class:DtCLocationIdΒ· Type:char *Β· Default:See DefinitionΒ· Access:CSGDtNmanPageβ Class:DtCManPageΒ· Type:char *Β· Default:NULLΒ· Access:CSGDtNpaperSizeβ Class:DtCPaperSizeΒ· Type:unsigned charΒ· Default:See DefinitionΒ· Access:CDtNprinterβ Class:DtCPrinterΒ· Type:char *Β· Default:NULLΒ· Access:CSGDtNrowsβ Class:DtCRowsΒ· Type:DimensionΒ· Default:25Β· Access:CSGDtNscrollBarPolicyβ Class:DtCScrollBarPolicyΒ· Type:unsigned charΒ· Default:See DefinitionΒ· Access:CDtNstringDataβ Class:DtCStringDataΒ· Type:char *Β· Default:NULLΒ· Access:CSGDtNtopicTitleβ Class:DtCTopicTitleΒ· Type:char *Β· Default:NULLΒ· Access:CSGDtNvisiblePathCountβ 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 isDtCR_HELP_CLOSE. Bye bestie, but make it callback. πDtNcolumnsβ Sets the number of columns of text to display in the display area of theDtHelpDialogwidget. Width queen behavior. πDtNexecutionPolicyβ This one controls howExecutehypertext link types and embedded scripts get handled. The default value isDtHELP_EXECUTE_QUERY_UNALIASEDand supports different semantics based on the usage of a command alias. TheXCDE Help System Author's and Programmer's Guidehas 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 toExecute Anyway,Don't Executeor 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 whenDtNhelpTypeis set toDtHELP_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 theDtHelpDialogwidget when the user requests help from within the widget. The default value for this resource isHelp4Help, 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 thedthelpprint(1)utility used to print help topics, manual-page files or help messages from theDtHelpDialogwidget. 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 isDtHELP_TYPE_TOPIC, theDtNlocationIdandDtNhelpVolumeresources are used and the requested help topic is displayed. When the value isDtHELP_TYPE_STRINGorDtHELP_TYPE_DYNAMIC_STRING, theDtNstringDataresource is used and the requested string is displayed. When the value isDtHELP_TYPE_FILE, theDtNhelpFileresource is used and the requested text file is displayed. When the value isDtHELP_TYPE_MAN_PAGE, theDtNmanPageresource 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 theDtNlocationIdresource 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 theDtHelpDialogwidget. 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 isDtCR_HELP_LINK_ACTIVATE.DtNhyperLinkCallbackallows 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_PAGEorDtHELP_LINK_TEXT_FILE. ForDtHELP_LINK_TOPIC, the callback is made only when thewindowHintvalue in the callback structure isDtHELP_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.DtNhelpVolumemust be set to the help volume in which the corresponding location ID resides, andDtNhelpTypemust be set toDtHELP_TYPE_TOPIC. Location ID realness. π―DtNmanPageβ Specifies the system manual page to display in the currentDtHelpDialogwidget. This resource is used whenDtNhelpTypeis set toDtHELP_TYPE_MAN_PAGE. Man page moment, fr fr. πDtNpaperSizeβ controls the value used in the Help-Print dialog for paper size. Default isDtHELP_PAPERSIZE_LETTER. Other supported values areDtHELP_PAPERSIZE_LEGAL,DtHELP_PAPERSIZE_EXECUTIVE,DtHELP_PAPERSIZE_A4, andDtHELP_PAPERSIZE_B5. π¨οΈβ¨DtNprinterβ specifies the printer name to use when printing inside theDtHelpDialogwidget. If the value isNULL, the default is taken from theLPDESTenvironment 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 theDtHelpDialogwidget.DtNscrollBarPolicyβ controls the automatic placement of scroll bars in the text display area. If set toDtHELP_AS_NEEDED_SCROLLBARS, the scroll bars appear only if the display area exceeds the clip area in one or both dimensions. A value ofDtHELP_STATIC_SCROLLBARSmakes the display area show scroll bars whenever theDtHelpDialogwidget is managed, no matter the relationship between the clip window and the display area. A value ofDtHELP_NO_SCROLLBARSremoves scroll bars from theDtHelpDialogwidget. Default isDtHELP_AS_NEEDED_SCROLLBARS. scroll bar behavior, but make it fashion πDtNstringDataβ specifies the string data (char *) to display in the currentDtHelpDialogwidget. This resource is used whenDtNhelpTypeis set toDtHELP_TYPE_STRING.DtNtopicTitleβ specifies the topic title (char *) to be used with either theDtNstringDataorDtNhelpFileresource. 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β classXmCAllowOverlap, typeBoolean, defaultTrue, accessCSG.XmNautoUnmanageβ classXmCAutoUnmanage, typeBoolean, defaultTrue, accessCG.XmNbuttonFontListβ classXmCButtonFontList, typeXmFontList, defaultdynamic, accessCSG.XmNcancelButtonβ classXmCWidget, typeWidget, defaultdynamic, accessSG.XmNdefaultButtonβ classXmCWidget, typeWidget, defaultdynamic, accessSG.XmNdefaultPositionβ classXmCDefaultPosition, typeBoolean, defaultTrue, accessCSG.XmNdialogStyleβ classXmCDialogStyle, typeunsigned char, defaultdynamic, accessCSG.XmNdialogTitleβ classXmCDialogTitle, typeXmString, defaultNULL, accessCSG.XmNfocusCallbackβ classXmCCallback, typeXtCallbackList, defaultNULL, accessC.XmNlabelFontListβ classXmCLabelFontList, typeXmFontList, defaultdynamic, accessCSG.XmNmapCallbackβ classXmCCallback, typeXtCallbackList, defaultNULL, accessC.XmNmarginHeightβ classXmCMarginHeight, typeDimension, default10, accessCSG.XmNmarginWidthβ classXmCMarginWidth, typeDimension, default10, accessCSG.XmNnoResizeβ classXmCNoResize, typeBoolean, defaultFalse, accessCSG.XmNresizePolicyβ classXmCResizePolicy, typeunsigned char, defaultXmRESIZE_ANY, accessCSG.XmNshadowTypeβ classXmCShadowType, typeunsigned char, defaultXmSHADOW_OUT, accessCSG.XmNtextFontListβ classXmCTextFontList, typeXmFontList, defaultdynamic, accessCSG.XmNtextTranslationsβ classXmCTranslations, typeXtTranslations, defaultNULL, accessC.XmNunmapCallbackβ classXmCCallback, typeXtCallbackList, defaultNULL, accessC.
π XmManager Resource Set π
XmNbottomShadowColorβ classXmCBottomShadowColor, typePixel, defaultdynamic, accessCSG.XmNbottomShadowPixmapβ classXmCBottomShadowPixmap, typePixmap, defaultXmUNSPECIFIED_PIXMAP, accessCSG.XmNforegroundβ classXmCForeground, typePixel, defaultdynamic, accessCSG.XmNhelpCallbackβ classXmCCallback, typeXtCallbackList, defaultNULL, accessC.XmNhighlightColorβ classXmCHighlightColor, typePixel, defaultdynamic, accessCSG.XmNhighlightPixmapβ classXmCHighlightPixmap, typePixmap, defaultdynamic, accessCSG.XmNinitialFocusβ classXmCInitialFocus, typeWidget, defaultdynamic, accessCSG.XmNnavigationTypeβ classXmCNavigationType, typeXmNavigationType, defaultXmTAB_GROUP, accessCSG.XmNshadowThicknessβ classXmCShadowThickness, typeDimension, defaultdynamic, accessCSG.XmNstringDirectionβ classXmCStringDirection, typeXmString-Direction, defaultdynamic, accessCG.XmNtopShadowColorβ classXmCTopShadowColor, typePixel, defaultdynamic, accessCSG.XmNtopShadowPixmapβ classXmCTopShadowPixmap, typePixmap, defaultdynamic, accessCSG.XmNtraversalOnβ classXmCTraversalOn, typeBoolean, defaultTrue, accessCSG.XmNunitTypeβ classXmCUnitType, typeunsigned char, defaultdynamic, accessCSG.XmNuserDataβ classXmCUserData, typeXtPointer, defaultNULL, accessCSG.
π¦ Composite Resource Set π¦
XmNchildrenβ classXmCReadOnly, typeWidgetList, defaultNULL, accessG.XmNinsertPositionβ classXmCInsertPosition, typeXtOrderProc, defaultNULL, accessCSG.XmNnumChildrenβ classXmCReadOnly, typeCardinal, default0, accessG.
π Core Resource Set π
XmNacceleratorsβ classXmCAccelerators, typeXtAccelerators, defaultdynamic, accessN/A.XmNancestorSensitiveβ classXmCSensitive, typeBoolean, defaultdynamic, accessG.XmNbackgroundβ classXmCBackground, typePixel, defaultdynamic, accessCSG.XmNbackgroundPixmapβ classXmCPixmap, typePixmap, defaultXmUNSPECIFIED_PIXMAP, accessCSG.XmNborderColorβ classXmCBorderColor, typePixel, defaultXtDefaultForeground, accessCSG.XmNborderPixmapβ classXmCPixmap, typePixmap, defaultXmUNSPECIFIED_PIXMAP, accessCSG.XmNborderWidthβ classXmCBorderWidth, typeDimension, default0, accessCSG.XmNcolormapβ classXmCColormap, typeColormap, defaultdynamic, accessCG.XmNdepthβ classXmCDepth, typeint, defaultdynamic, accessCG.XmNdestroyCallbackβ classXmCCallback, typeXtCallbackList, defaultNULL, accessC.XmNheightβ classXmCHeight, typeDimension, defaultdynamic, accessCSG.XmNinitialResourcesPersistentβ classXmCInitialResourcesPersistent, typeBoolean, defaultTrue, accessC.XmNmappedWhenManagedβ classXmCMappedWhenManaged, typeBoolean, defaultTrue, accessCSG.XmNscreenβ classXmCScreen, typeScreen *, defaultdynamic, accessCG.XmNsensitiveβ classXmCSensitive, typeBoolean, defaultTrue, accessCSG.XmNtranslationsβ classXmCTranslations, typeXtTranslations, defaultdynamic, accessCSG.XmNwidthβ classXmCWidth, typeDimension, defaultdynamic, accessCSG.XmNxβ classXmCPosition, typePosition, default0, accessCSG.XmNyβ classXmCPosition, typePosition, default0, accessCSG.
π 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 theDtNhyperLinkCallbackfor theDtHelpDialogwidget, sets thehelpTypetoDtHELP_LINK_TOPIC, thewindowHinttoDtHELP_NEW_WINDOW, thehelpVolumeto the current volume name and thelocationIdto the selected item's location ID π«. And if there's noDtNhyperLinkCallbackhanging around? The action just gets ignored, no drama.&<MCtrl> &<KSpace>in Topic Tree Text β same deal as above, bestie:DtNhyperLinkCallbackgets invoked for theDtHelpDialogwidget,helpTypeset toDtHELP_LINK_TOPIC,windowHinttoDtHELP_NEW_WINDOW,helpVolumeto the current volume name,locationIdto the selected item's location ID. No callback supplied = action ignored, periodt.&<MCtrl> &<KActivate>in Topic Tree Text β invokes theDtNhyperLinkCallbackfor theDtHelpDialogwidget, setting thehelpTypetoDtHELP_LINK_TOPIC, thewindowHinttoDtHELP_NEW_WINDOW, thehelpVolumeto the current volume name and thelocationIdto the selected item's location ID. If noDtNhyperLinkCallbackis supplied, the action is ignored π«Ά&<MCtrl>or&<MShift>&<BSelect>in Display Area Hypertext Link Text β invokes theDtNhyperLinkCallbackfor theDtHelpDialogwidget, honoring all existing link settings, but forces thewindowHinttoDtHELP_NEW_WINDOW. If noDtNhyperLinkCallbackis 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 theLANGenvironment 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_WINDOWhas been selected, but the application has not supplied a hypertext callback to handle it. The link is handled like aDtHELP_CURRENT_WINDOWjump π« - "Nonexistent DtNlocationId." β the requested
DtNlocationIdis not present in the current help volume π³οΈ - "No DtNhyperLinkCallback supplied for widget." β a hypertext link of type
DtHELP_LINK_APP_DEFINEorDtHELP_LINK_MAN_PAGEis 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
- nixos 26.05: cde 2.5.3
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms