2 <!DOCTYPE xsldoc SYSTEM "xsldoc.dtd">
5 Author: Keith Isdale <k_isdale@tpg.com.au>
6 Description: Xml Data to be processed generate help text and other
8 Copyright Reserved Under GPL
12 <header>xsldbg help</header>
14 <para>xsldbg is similar to gdb. It has three modes of execution
17 <li>Run the whole stylesheet</li>
18 <li>Step to next xsl instruction</li>
19 <li>Continue to next break point is found</li>
22 <para title="xsldbg command line">
23 On systems with readline library available you can use the back/forward
24 keys to navigate the history of entered commands.
25 On all systems the last entered command can be repeated by just pressing
26 the <ENTER> key.
28 <para title="Legend :">
29 <list><li>TEMPLATENAME : a valid template name</li>
30 <li>FILENAME : a valid URL for a stylesheet</li>
31 <li>LINENO : a valid line number in associated FILENAME</li>
32 <li>NUMBER_OF_FRAMES : a valid line number frames to change position by</li>
33 <li>BREAKPOINT_ID : a valid break point number</li>
34 <li>SPEED: speed to walk through code at, between 0 to 9</li>
35 <li><comment>(Comment)</comment>: a comment about command meaning or usage</li>
36 <li>{ opt1 | opt2 | opt2 .. etc} : Choose one of the opt's</li>
37 <li>XPATH : a xpath selection of node(s)</li>
38 <li>PARAM_ID : a valid parameter number as indicated by showparam command</li>
39 <li>PATH : a path to change working directory to</li>
40 <li>TEXT : free form text <comment>(no restricttions)</comment></li>
41 <li>COMMAND : a valid command for the xsdbg</li>
42 <li>QNAME : a valid variable/parameter name</li>
43 <li>SOURCE : the stylesheet being/tobe executed</li>
44 <li>DATA : the xml data being/tobe processed by the stylesheet
49 <!-- - - - - Start help summary - - - - - -->
50 <para title="Within xsldbg these commands are available:">
53 <li>Help related : help</li>
55 <li>Running related : {<link href="bye">bye</link>|<link href="exit">exit</link>|
56 <link href="quit">quit</link>}, <link href="step">step</link>,
57 <link href="stepup">stepup</link>, <link href="stepdown">stepdown</link>,
58 <link href="continue">continue</link>, <link href="run">run</link>,
59 <link href="trace">trace</link>
62 <li>Libxslt parameter related :
63 <link href="addparam">addparam</link>,<link href="delparam">delparam</link>,
64 <link href="showparam">showparam</link>
67 <li>Template related : <link href="templates">templates</link>,
68 <link href="where">where</link>, <link href="frame">frame</link>
71 <li>Break point related : <link href="break">break</link>,
72 <link href="showbreak">showbreak</link>,
73 <link href="delete">delete</link>, <link href="enable">enable</link>
76 <li>Expression viewing(xpath) : <link href="cat">cat</link></li>
77 <li>Node viewing : <link href="ls">ls</link>, <link href="dir">dir</link>,
78 <link href="du">du</link>, <link href="cat">cat</link>, <link href="pwd">pwd</link></li>
79 <li>Variable viewing : <link href="globals">globals</link>,
80 <link href="locals">locals</link>,
81 <link href="cat">cat</link>
84 <li>Node selection : <link href="source">source</link>,
85 <link href="data">data</link>,
86 <link href="cd">cd</link>
89 <li>Searching :<link href="search">search</link>
92 <li>Operating system related :
93 <link href="chdir">chdir</link>,
94 <link href="shell">shell</link>
98 <link href="validate">validate</link>, <link href="load">load</link>,
99 <link href="save">save</link>, <link href="write">write</link>,
100 <link href="free">free</link>
104 <para>nb: At the moment the file related commands as disabled because
105 they are not completed.</para>
111 <!-- - - - - - Help related commands - - - - - - - - - - -->
112 <cmd name="help" title="Help">
113 <summary>Display help on command or overiew</summary>
115 <li>help <comment>(Show overview of product)</comment></li>
116 <li>help <COMMAND> <comment>(Show help about a command)</comment></li>
120 <!-- - - - - - - Running related commands - - - - - - - - -->
121 <cmd name="bye" title="Bye">
122 <summary>Exit processing stylesheet as soon as possible.</summary>
130 <cmd name="quit" title="Quit">
131 <summary>Exit processing stylesheet as soon as possible.</summary>
132 <para>Shortcut name: q</para>
140 <cmd name="exit" title="Exit">
141 <summary>Exit processing stylesheet as soon as possible.</summary>
149 <cmd name="step" title="Step">
150 <summary>Step until next stylesheet instruction.</summary>
152 <para>Shortcut name: s</para>
161 <cmd name="stepup" title="Stepup">
162 <summary>Step up to a older "call frame". </summary>
164 <para>Shortcut name: up</para>
169 <comment>(step up one frame)</comment></li>
171 <text>stepup <NUMBER_OF_FRAMES> </text>
172 <comment>(step up specified number of frames)</comment>
177 <cmd name="stepdown" title="Stepdown">
178 <summary>Step down to a newer "call frame". </summary>
180 <para>Shortcut name: down</para>
184 <text>stepdown </text>
185 <comment>(step down one frame)</comment>
188 <text>stepdown <NUMBER_OF_FRAMES></text>
189 <comment>(step down specified number of frames)</comment>
194 <cmd name="continue" title="Continue">
195 <summary>Continue running stylesheet, stopping at any break points found.</summary>
196 <para>Shortcut name: c</para>
199 <text>continue</text>
204 <cmd name="run" title="Run">
205 <summary>Restart the stylesheet.</summary>
206 <para>Shortcut name: r</para>
214 <cmd name="trace" title="Trace">
215 <summary>Trace one execution of the stylesheet</summary>
223 <cmd name="walk" title="Walk">
224 <summary>Walk through code using a range of speeds</summary>
227 <text>walk <SPEED></text>
228 <comment>(Use Ctrl-c to stop execution, <SPEED> is a value between 0 and 9. Where 0 means stop, 1 is very fast, 9 is very slow)</comment>
233 <!-- - - - - - - - libxslt Parameter related - - - - -->
234 <cmd name="addparam" title="Addparam">
235 <summary>Add a libxslt parameter</summary>
238 <text>addparam <QNAME> <XPATH></text>
239 <comment>(No error checking done on the validity of <QNAME> nor <XPATH>. This is equivalent to providing --param <QNAME> <XPATH> via command line)</comment>
244 <cmd name="delparam" title="Delparam">
245 <summary>Delete a libxslt parameter</summary>
248 <text>delparam</text>
249 <comment>(Delete all parameters present)</comment>
252 <text>delparam <PARAM_ID></text>
257 <cmd name="showparam" title="Showparam">
258 <summary>Print the libxslt parameters present</summary>
261 <text>showparam</text>
266 <!-- - - - - - - Template related commands - - - - - - - -->
267 <cmd name="templates" title="Templates">
268 <summary>Print a list of available templates. Search for a template</summary>
269 <para>Shortcut name: t</para>
272 <text>templates</text>
275 <text>templates <TEMPLATE></text>
276 <comment>(Print details of template named <TEMPLATE> if it can be found)</comment>
281 <cmd name="where" title="Where">
282 <summary>Print a trace of templates calls (frame stack) and print the working directory.</summary>
283 <para>Shortcut name: w</para>
291 <cmd name="frame" title="Frame">
292 <summary>Print the stack frame at a given depth</summary>
293 <para>Shortcut name: f</para>
296 <text>frame <FRAME_DEPTH></text>
297 <comment>(Depth is a number from 0 to the current depth of call stack)</comment>
303 <cmd name="stylesheets" title="Stylesheets">
304 <summary>Print out a list of stylesheets loaded</summary>
306 <para>Shortcut name: style</para>
310 <text>stylesheets</text>
315 <!-- - - - - Break point related commands - - - - - - - -->
316 <cmd name="break" title="Break">
317 <summary>Break at a template, at a location in any file loaded, or at the current node. </summary>
319 <para>Shortcut name: b</para>
320 <para>xsldbg will try to guess the complete URL given a
322 <li>file name without a path specified.</li>
323 <li>a file name in the same directory as the "top" stylesheet loaded</li>
324 <li>a file name relative to the current working directory of xsldbg</li>
326 Ie if you have loaded a stylsheet file of ../en/xsldoc.xsl you can do this
328 <para> break -l xsldoc.xsl 26
333 <text>break -l <FILENAME> <LINENO></text>
336 <text>break <TEMPLATENAME></text>
337 <comment>(To break at named template.)</comment>
341 <comment>(To break at any template found.)</comment>
345 <comment>(To break point at current node. Yes that includes xml data nodes!)</comment>
350 <cmd name="showbreak" title="Showbreak">
351 <summary>To display list of template break points.</summary>
352 <para>Shortcut name: show</para>
355 <text>showbreak</text>
361 <cmd name="delete" title="Delete">
362 <summary>Delete a template breakpoint</summary>
364 <para>Shortcut name: d</para>
369 <comment>(To delete breakpoint at current node)</comment>
372 <text>delete <BREAKPOINT_ID></text>
373 <comment>(To delete breakpoint at specified break point number)</comment>
376 <text>delete -l <FILENAME> <LINENO></text>
377 <comment>(Delete at specifed file, line number)</comment>
380 <text>delete <TEMMPLATENAME></text>
381 <comment>(To delete break point at named template.)</comment>
384 <text>delete *</text>
385 <comment>(To delete all break points.)</comment>
390 <cmd name="enable" title="Enable">
391 <summary>Enable or disable a breakpoint (Toggle enable/disable/)</summary>
393 <para>Shortcut name: e</para>
398 <comment>(To enable/disable breakpoint at current node)</comment>
401 <text>enable <BREAKPOINT_ID></text>
402 <comment>(To enable/disable breakpoint at specified break point number</comment>
405 <text>enable -l <FILENAME> <LINENO></text>
406 <comment>(Enable/disable breakpoint at specifed file, line number)</comment>
411 <cmd name="disable" title="Disable">
412 <summary>Disable a breakpoint</summary>
416 <comment>(To disable breakpoint at current node)</comment>
419 <text>disable <BREAKPOINT_ID></text>
420 <comment>(To disable breakpoint at specified break point number</comment>
423 <text>disable -l <FILENAME> <LINENO></text>
424 <comment>(Disable breakpoint at specifed file, line number)</comment>
430 <!-- - - - - - - Node view related commands - - - - - - - - -->
431 <cmd name="ls" title="Ls">
432 <summary>List nodes in a brief format</summary>
440 <cmd name="dir" title="Dir">
441 <summary>Print list of nodes in a similary way to the dir shell command.</summary>
452 <cmd name="du" title="Du">
453 <summary>Print a summary of child nodes in a tree format.</summary>
461 <cmd name="cat" title="Cat">
462 <summary>Print the result of a xpath expression on relative current node.</summary>
464 <para>Usage : cat <XPATH></para>
465 <para>Usage : cat $<QNAME> (To view a varaible or parameter)</para>
469 <cmd name="pwd" title="Pwd">
470 <summary>Print the current working directory.</summary>
478 <cmd name="base" title="Base">
479 <summary>Print the base for this node</summary>
487 <cmd name="dump" title="Dump">
488 <summary>Dump the gory details of this node</summary>
496 <!-- - - - - - - Variable related commands - - - - - - - - - -->
497 <cmd name="globals" title="Globals">
498 <summary>Print a list of global stylesheet variables or parameters. Print the value of a global variable</summary>
502 <comment>(Print list of all globaly available variables)</comment>
505 <text>globals <QNAME></text>
506 <comment>(Print the value of variable specified)</comment>
511 <cmd name="locals" title="Locals">
512 <summary>Print a list of local stylesheet variables or parameters. Print the value of a local variable</summary>
516 <comment>(Print list of all locally available variables)</comment>
519 <text>locals <QNAME></text>
520 <comment>(Print the value of variable specified)</comment>
525 <!-- - - - - - - Node selection related commands - - - - - - - -->
526 <cmd name="source" title="Source">
527 <summary>Switch to displaying the current node in stylesheet. Or change stylesheet used</summary>
531 <comment>(Switch to the current node in stylesheet.)</comment>
534 <text>source <SOURCE></text>
535 <comment>(To change to a new source file. A leading '~' is replaced by the $HOME environment variable value. May need to use run command to execute it)</comment>
540 <cmd name="data" title="Data">
541 <summary>Switch to displaying the current node in xml data. Or change xml data used</summary>
545 <comment>(Switch to the current document node.)</comment>
548 <text>data <DATA></text>
549 <comment>(To change to a new xml data file. A leading '~' is replaced by the $HOME environment variable value. May need to use run command to process it)</comment>
554 <cmd name="cd" title="Cd">
555 <summary>Change to the path specified by a xpath.</summary>
558 <text>cd <XPATH></text>
561 <text>cd -t<TEMPLATENAME></text>
562 <comment>(To changes current SOURCE node to a be xsl template with name <NAME>, but does execute source command)</comment>
565 <text>cd -s<XPATH></text>
566 <comment>(An absolute xPath to node within stylesheet)</comment>
569 <text>cd <SHORTCUT> <XPATH></text>
572 <text> Where SHORTCUT can be either</text>
576 <li><text><< = preceding-sibling::node()</text>
578 <li><text>>> = following-sibling::node()</text>
580 <li><text><- = ancestor::node()</text>
582 <li><text>-> = decendant::node()</text>
590 <!-- - - - - - File related commands - - - - - - -->
591 <cmd name="validate" title="Validate">
592 <summary>Validate the output file generated by stylesheet (Disabled)</summary>
595 <cmd name="load" title="Load">
596 <summary>Reload stylesheet and data file(s) (Disabled see run)</summary>
599 <cmd name="save" title="Save">
600 <summary>Save the generated data file (Disabled)</summary>
603 <cmd name="write" title="Write">
604 <summary>To be completed</summary>
607 <cmd name="free" title="Free">
608 <summary>Free stylesheet and data (Disabled see run)</summary>
611 <!-- - - - - - - Searching related - - - - - -->
612 <cmd name="search" title="Search">
613 <summary>Search a database of all information gathered from styleets loaded</summary>
615 <para>When the search command is issued a file (search.data) will be created in the current directory. You can then process this file with your own stylessheet to present data in a other ways than displayed by default.
617 <para>Depending on the amount of data collected it might take a while to compled this command.
619 <para>At the moment breakpoints are not being sorted properly. Which is being looked at.
624 <text>search <XPATH></text><comment>(See what xpath can be used see search.dtd)</comment>
627 <text>search -sort <XPATH></text><comment>(Enable tell search.xsl to sort the result before outputing it)</comment>
632 <!-- - - - - Operating system related - - - - -->
633 <cmd name="chdir" title="Chdir">
634 <summary>Change the working directory</summary>
637 <text>chdir <PATH></text>
638 <comment>(A relative or absolute path for operating system)</comment>
643 <cmd name="shell" title="Shell">
644 <summary>Execute shell command</summary>
647 <text>shell <TEXT></text>
648 <comment>(<TEXT> is the text to be passed to operating system for execution)</comment>
656 <!-- initialization code for xemacs -->
660 sgml-minimize-attributes:nil
661 sgml-general-insert-case:lower