man.break.after.slash.xml 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. <refentry xmlns="http://docbook.org/ns/docbook"
  2. xmlns:xlink="http://www.w3.org/1999/xlink"
  3. xmlns:xi="http://www.w3.org/2001/XInclude"
  4. xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
  5. xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  6. version="5.0" xml:id="man.break.after.slash">
  7. <refmeta>
  8. <refentrytitle>man.break.after.slash</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>man.break.after.slash</refname>
  13. <refpurpose>Enable line-breaking after slashes?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="man.break.after.slash.frag">
  17. <xsl:param name="man.break.after.slash">0</xsl:param></src:fragment>
  18. </refsynopsisdiv>
  19. <refsection><info><title>Description</title></info>
  20. <para>If non-zero, line-breaking after slashes is enabled. This is
  21. mainly useful for causing long URLs or pathnames/filenames to be
  22. broken up or "wrapped" across lines (though it also has the side
  23. effect of sometimes causing relatively short URLs and pathnames to be
  24. broken up across lines too).</para>
  25. <para>If zero (the default), line-breaking after slashes is
  26. disabled. In that case, strings containing slashes (for example, URLs
  27. or filenames) are not broken across lines, even if they exceed the
  28. maximum column widith.</para>
  29. <warning>
  30. <para>If you set a non-zero value for this parameter, check your
  31. man-page output carefuly afterwards, in order to make sure that the
  32. setting has not introduced an excessive amount of breaking-up of URLs
  33. or pathnames. If your content contains mostly short URLs or
  34. pathnames, setting a non-zero value for
  35. <parameter>man.break.after.slash</parameter> will probably result in
  36. in a significant number of relatively short URLs and pathnames being
  37. broken across lines, which is probably not what you want.</para>
  38. </warning>
  39. </refsection>
  40. </refentry>