home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / tsw / TSW_3.4.0.exe / Apache2 / perl / Pod_usage.pod < prev    next >
Encoding:
Text File  |  2003-02-11  |  3.3 KB  |  132 lines
  1.  
  2. =head1 NAME
  3.  
  4. Tk::Pod_usage - How to use the perl/Tk Pod browser widget
  5.  
  6. =head1 DESCRIPTION
  7.  
  8. To navigate through the documentation one could use
  9.  
  10. =head2 Hyperlinks
  11.  
  12. A B<click> on a hyperlink display the corresponding documentation
  13. (if there is any) in the same window. An URL will be displayed in a
  14. web browser using the (non-CPAN) L<WWWBrowser> module (this will
  15. hopefully change).
  16.  
  17. With <Button-2> the documentation is loaded into a new window
  18. (<Shift-Button-1> works also for those with only a 2 button mouse).
  19.  
  20. =head2 Selection
  21.  
  22. A B<double click> tries to load the documentation for the selected
  23. word in the same window.
  24.  
  25. If the C<Shift> key is simultaneously pressed a new browser window
  26. is opened.
  27.  
  28. =head2 Key bindings
  29.  
  30. The L<Tk::Pod::Text> widget is based on the L<Tk::More> widget
  31. inheriting its key bindings.
  32.  
  33. =head2 Search
  34.  
  35. Pressing <Key-/> lets you search in the displayed documentation.
  36.  
  37. =head2 Section Menu
  38.  
  39. The Section Menu
  40.  
  41. The 'Section' menu allows to directly jump to the start of a
  42. section in the documentation.
  43.  
  44. =head2 Action Menu
  45.  
  46. If you press the right mouse button you get a popup menu
  47. that allows:
  48.  
  49. =over 4
  50.  
  51. =item o Back
  52.  
  53. in history of displayed documentation
  54.  
  55. =item o Forward
  56.  
  57. in history of displayed documentation
  58.  
  59. =item o Reload
  60.  
  61. the documentation
  62.  
  63. =item o Edit Pod
  64.  
  65. Start editor with source of the displayed document.
  66.  
  67. The used editor is selected by the first definition of the environment
  68. variables C<TKPODEDITOR>, C<XEDITOR>, C<VISUAL>, C<EDITOR> or as default
  69. F</usr/bin/vi>. If no terminal is available (or on Windows platforms),
  70. the L<ptked|ptked> editor (bundled with Perl/Tk) will be used instead.
  71.  
  72. See also the menu entries 'File' -E<gt> 'Edit' and 'File' -E<gt> 'Edit
  73. with ptked'.
  74.  
  75. =item o Search fulltext
  76.  
  77. Full text search of the Pod in the perl library directories. (Note: to
  78. use it one has to install the perlindex distribution and build an
  79. index for the perl documentation, see L<Text::English|Text::English>)
  80.  
  81. =back
  82.  
  83. The remaining menu entries are the same as in normal C<Text> widgets.
  84.  
  85. =head2 Tree view
  86.  
  87. You can toggle the tree view of all installed modules on or off with
  88. the 'View' -E<gt> 'Pod Tree' menu entry. The tree view is organized in
  89. three sections: Perl language (general documentation about Perl),
  90. Pragmata, and Modules. The labels in the tree are colored, where green
  91. means E<quot>standard module which comes with the Perl core
  92. distributionE<quot>, red means E<quot>locally installed module,
  93. probably from CPANE<quot>, and grey means E<quot>no module available,
  94. look at the subtreeE<quot>.
  95.  
  96. The tree data is cached in a temporary directory on a per-perl-version
  97. and per-user basis. A reload can be forced with the B<Reload> entry in
  98. the action menu of the tree view. With the B<Search> entry a search in
  99. the tree can be performed. The B<Show modules at CPAN> entry is highly
  100. experimental - you can download, extract and look at the
  101. documentation of all CPAN modules.
  102.  
  103. =head1 SEE ALSO
  104.  
  105. L<tkpod>,
  106. L<perlpod>,
  107. L<pod2man>,
  108. L<pod2text>,
  109. L<pod2html>,
  110. L<Tk::Pod>,
  111. L<Tk::Pod::Text>,
  112. L<Tk::Pod::Tree>,
  113. L<Tk::More>,
  114. L<Tk::Pod::English>,
  115.  
  116. =head1 KEYWORDS
  117.  
  118. pod, browser, tk, hypertext
  119.  
  120. =head1 AUTHOR
  121.  
  122. Achim Bohnet <F<ach@mpe.mpg.de>>
  123.  
  124. Current maintainer is Slaven Rezic <F<slaven@rezic.de>>
  125.  
  126. Copyright (c) 1997-1998 Achim Bohnet. All rights reserved.  This
  127. documentation is free software; you can redistribute it and/or modify
  128. it under the same terms as Perl itself.
  129.  
  130. =cut
  131.  
  132.