Opensource.Platon.SK CVS: doc/soft-doc-sys/sgml/en/other-doc-systems.sgml - diff

   Up to  [Platon] / doc / soft-doc-sys / sgml / en
Diff for doc/soft-doc-sys/sgml/en/other-doc-systems.sgml between version 1.2 and 1.3


version 1.2, 2002/12/11 18:16:12
version 1.3, 2002/12/16 18:02:22



Line 1 




Line 1 




 <!-- $Platon: phpWebFileManager/doc/sgml/changelog.sgml,v 1.3 2002/12/03 20:47:37 nepto Exp $ -->
 <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/en/other-doc-systems.sgml,v 1.2 2002/12/11 18:16:12 nepto Exp $ -->


 
 


 <chapter id="others-doc-sys"><title>Other software documentation systems</title>
 <chapter id="others-doc-sys">


 
 <title>Other software documentation systems</title>


 
 <para>


 
 


 <para>bar foo</para>
 There are other systems for software documentation.  We cannot say whether it


 
 belongs to the user-oriented or developer-oriented group about neither one of


 
 them.  Every one of them was created with a certain particular aim, which it has


 
 followed.  These contain:


 
 


 </chapter>
 <itemizedlist spacing="normal">


 
 <listitem><simpara><application>PerlDoc</></simpara></listitem>


 
 <listitem><simpara><application>man</></simpara></listitem>


 
 <listitem><simpara><application>info</></simpara></listitem>


 
 </itemizedlist>


 
 


 
 </para>


 
 <para>


 
 


 
 


 
 <ulink url="http://www.perldoc.org/"><application>PerlDoc</></> is a


 
 documentation system used by the community around a script language <ulink


 
 url="http://www.perl.org/"><acronym>Perl</></>.  The thing that helped its


 
 growth is the existence of <ulink url="http://www.cpan.org/"><acronym>CPAN</></>


 
 - archive of reusable code for <acronym>Perl</>.  The documentation is written


 
   straight into the source code using special <acronym>POD</> marks. Users then


 
   access it using <acronym>Perl</> system script <command>perldoc</>. There are


 
   many converters of <application>PerlDoc</> documentation into different output


 
   formats, including <acronym>HTML</>.


 
 


 
 </para>


 
 <para>


 
 


 
 The documentation system of system manual pages (<application>man</> pages) has


 
 been created in the times of creation of the operating system


 
 <productname>UNIX</> and is actively developed to these days.  To format the


 
 output, we use the <application>nroff</> program and pages are displayed with


 
 the man command.  They come along on almost every <productname>UNIX</> or


 
 <productname><acronym>GNU</>/Linux</> system.  Every <application>man</> page is


 
 compressed and saved on the disk separately.  There are tools for its conversion


 
 to other formats.


 
 


 
 </para>


 
 <para>


 
 


 
 <application>info</> documentation is the result of the <acronym>GNU</> movement


 
 (<acronym>GNU</> is Not <productname>UNIX</>) and is trying to substitute the


 
 man pages.  This documentation system is not being used as much as its creators


 
 would expect due to its complicated control and user-unfriendly look.  However,


 
 most of the <acronym>GNU</> tools still includes more detailed documentation in


 
 its <application>info</> pages than in corresponding <application>man</> pages.


 
 The pages can be displayed with the <command>info</> command.


 
 


 
 </para>


 
 </chapter>


 
 









Legend:


Removed from v.1.2
 


changed lines


 
Added in v.1.3


















Platon Group <platon@platon.org> http://platon.org/
  Up to  [Platon] / doc / soft-doc-sys / sgml / en
-version 1.2, 2002/12/11 18:16:12
+version 1.3, 2002/12/16 18:02:22
 Line 1
 Line 1
 Line 1
- <!-- $Platon: phpWebFileManager/doc/sgml/changelog.sgml,v 1.3 2002/12/03 20:47:37 nepto Exp $ -->
+ <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/en/other-doc-systems.sgml,v 1.2 2002/12/11 18:16:12 nepto Exp $ -->
- <chapter id="others-doc-sys"><title>Other software documentation systems</title>
+ <chapter id="others-doc-sys">
+ <title>Other software documentation systems</title>
+ <para>
- <para>bar foo</para>
+ There are other systems for software documentation.  We cannot say whether it
+ belongs to the user-oriented or developer-oriented group about neither one of
+ them.  Every one of them was created with a certain particular aim, which it has
+ followed.  These contain:
- </chapter>
+ <itemizedlist spacing="normal">
+ <listitem><simpara><application>PerlDoc</></simpara></listitem>
+ <listitem><simpara><application>man</></simpara></listitem>
+ <listitem><simpara><application>info</></simpara></listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ <ulink url="http://www.perldoc.org/"><application>PerlDoc</></> is a
+ documentation system used by the community around a script language <ulink
+ url="http://www.perl.org/"><acronym>Perl</></>.  The thing that helped its
+ growth is the existence of <ulink url="http://www.cpan.org/"><acronym>CPAN</></>
+ - archive of reusable code for <acronym>Perl</>.  The documentation is written
+   straight into the source code using special <acronym>POD</> marks. Users then
+   access it using <acronym>Perl</> system script <command>perldoc</>. There are
+   many converters of <application>PerlDoc</> documentation into different output
+   formats, including <acronym>HTML</>.
+ </para>
+ <para>
+ The documentation system of system manual pages (<application>man</> pages) has
+ been created in the times of creation of the operating system
+ <productname>UNIX</> and is actively developed to these days.  To format the
+ output, we use the <application>nroff</> program and pages are displayed with
+ the man command.  They come along on almost every <productname>UNIX</> or
+ <productname><acronym>GNU</>/Linux</> system.  Every <application>man</> page is
+ compressed and saved on the disk separately.  There are tools for its conversion
+ to other formats.
+ </para>
+ <para>
+ <application>info</> documentation is the result of the <acronym>GNU</> movement
+ (<acronym>GNU</> is Not <productname>UNIX</>) and is trying to substitute the
+ man pages.  This documentation system is not being used as much as its creators
+ would expect due to its complicated control and user-unfriendly look.  However,
+ most of the <acronym>GNU</> tools still includes more detailed documentation in
+ its <application>info</> pages than in corresponding <application>man</> pages.
+ The pages can be displayed with the <command>info</> command.
+ </para>
+ </chapter>
 Legend:


Removed from v.1.2
 


changed lines


 
Added in v.1.3
 Legend:


Removed from v.1.2
 


changed lines


 
Added in v.1.3
-Removed from v.1.2
+Added in v.1.3


Copyright © 2002-2006 Platon Group Site powered by Metafox CMS	Go to Top