Re: man pages

[Jose Abilio Oliveira Matos]

On Friday 11 January 2002 18:02, Paul A. Franz, P.E. wrote:
 At 04:22 AM 1/9/2002Jose Abilio Oliveira Matos sez:
 On Wednesday 09 January 2002 04:22, Paul A. Franz, P.E. wrote:
   3) I understand that if the Linuxdoc template would work, (I believe it
   did yesterday) then I could create a man page, export it as a .DVI then
   use some program in SGML-tools to convert this to the man page format
   which is groff or nroff or troff that is gzipped. Anyway, that part is
   pretty unclear to me so far.
 
I append an example of it.

 I assume you mean the attached file manpage.man. You also appended
 manpage.sgml and manpage.lyx. Would you care to elaborate on their use?
 What directories should they be placed in and how do I use them?

  The manpage.lyx is the original lyx file. I exported it to linuxdoc, that 
gave as result manpage.sgml. From this file I have used sgml2txt that comes 
with sgmltools 1 to convert it to manpage.man

   Questions.
  
   2) What template should I be using. I believe this is called a text
   class. Correct?
 
I don't need to use any template. The easier thing to do is start from
  a blank document and change it to manpage, in Layout-Document-Class.

 manpage is not one of the class options. What do I do? I see
 manpage.layout in /usr/share/lyx/layouts. It doesn't show up in the
 options. See attached screen shot.

  You should see it as: SGML (Linuxdoc manpage) that should show up earlier 
into the class options (the part that we don't see in the image yout sent). 
If you don't see it that means that you don't have sgmltools v1 installed. 

 How do I get it to show up in the choices for Class?

   5) How does one generate a template file?
 
That is a lyx file with some things from the preamble cutted.

 Where does one put the templates? I have a .lyx directory in my home
 directory  and each of the subdirectories is empty. I tried copying all the
 files in /usr/share/lyx/layouts to ~.lyx/layouts and restarted lyx. Still
 the manpage layout doesn't appear.

  This should be an hint that you don't have sgmltools 1 installed.
  What do you see in the command line when you call lyx and then do 
Edit-Reconfigure?

  I have one line that says:
+checking for linuxdoc class linuxdoc...  yes
...
+checking for linuxdoc class manpage...  yes

   Thanks
 
Tell me if this helps,

 Making some progress and your help certainly is appreciated.

  I saw your earlier message but it was impossible for me to reply before.

 --
 José Abílio

   * L I N U X * .~.  Paul A. Franz, P.E.  Engineering Software
The Choice   /V\  Blackdog SoftwareNetwork Consulting and Sales
of the GNU  /( )\ http://blackdog.bellevue.wa.us/ Custom Web Services
Generation  ^^-^^ (425) 641-8202, (425) 641-1773 FAXInternet FAX

-- 
José Abílio

Re: man pages

[Jose Abilio Oliveira Matos]

On Friday 11 January 2002 18:02, Paul A. Franz, P.E. wrote:
 At 04:22 AM 1/9/2002Jose Abilio Oliveira Matos sez:
 On Wednesday 09 January 2002 04:22, Paul A. Franz, P.E. wrote:
   3) I understand that if the Linuxdoc template would work, (I believe it
   did yesterday) then I could create a man page, export it as a .DVI then
   use some program in SGML-tools to convert this to the man page format
   which is groff or nroff or troff that is gzipped. Anyway, that part is
   pretty unclear to me so far.
 
I append an example of it.

 I assume you mean the attached file manpage.man. You also appended
 manpage.sgml and manpage.lyx. Would you care to elaborate on their use?
 What directories should they be placed in and how do I use them?

  The manpage.lyx is the original lyx file. I exported it to linuxdoc, that 
gave as result manpage.sgml. From this file I have used sgml2txt that comes 
with sgmltools 1 to convert it to manpage.man

   Questions.
  
   2) What template should I be using. I believe this is called a text
   class. Correct?
 
I don't need to use any template. The easier thing to do is start from
  a blank document and change it to manpage, in Layout-Document-Class.

 manpage is not one of the class options. What do I do? I see
 manpage.layout in /usr/share/lyx/layouts. It doesn't show up in the
 options. See attached screen shot.

  You should see it as: SGML (Linuxdoc manpage) that should show up earlier 
into the class options (the part that we don't see in the image yout sent). 
If you don't see it that means that you don't have sgmltools v1 installed. 

 How do I get it to show up in the choices for Class?

   5) How does one generate a template file?
 
That is a lyx file with some things from the preamble cutted.

 Where does one put the templates? I have a .lyx directory in my home
 directory  and each of the subdirectories is empty. I tried copying all the
 files in /usr/share/lyx/layouts to ~.lyx/layouts and restarted lyx. Still
 the manpage layout doesn't appear.

  This should be an hint that you don't have sgmltools 1 installed.
  What do you see in the command line when you call lyx and then do 
Edit-Reconfigure?

  I have one line that says:
+checking for linuxdoc class linuxdoc...  yes
...
+checking for linuxdoc class manpage...  yes

   Thanks
 
Tell me if this helps,

 Making some progress and your help certainly is appreciated.

  I saw your earlier message but it was impossible for me to reply before.

 --
 José Abílio

   * L I N U X * .~.  Paul A. Franz, P.E.  Engineering Software
The Choice   /V\  Blackdog SoftwareNetwork Consulting and Sales
of the GNU  /( )\ http://blackdog.bellevue.wa.us/ Custom Web Services
Generation  ^^-^^ (425) 641-8202, (425) 641-1773 FAXInternet FAX

-- 
José Abílio

Re: man pages

[Jose Abilio Oliveira Matos]

On Friday 11 January 2002 18:02, Paul A. Franz, P.E. wrote:
> At 04:22 AM 1/9/2002Jose Abilio Oliveira Matos sez:
> >On Wednesday 09 January 2002 04:22, Paul A. Franz, P.E. wrote:
> > > 3) I understand that if the Linuxdoc template would work, (I believe it
> > > did yesterday) then I could create a man page, export it as a .DVI then
> > > use some program in SGML-tools to convert this to the man page format
> > > which is groff or nroff or troff that is gzipped. Anyway, that part is
> > > pretty unclear to me so far.
> >
> >   I append an example of it.
>
> I assume you mean the attached file "manpage.man". You also appended
> "manpage.sgml" and "manpage.lyx". Would you care to elaborate on their use?
> What directories should they be placed in and how do I use them?

  The manpage.lyx is the original lyx file. I exported it to linuxdoc, that 
gave as result manpage.sgml. From this file I have used sgml2txt that comes 
with sgmltools 1 to convert it to manpage.man

> > > Questions.
> > >
> > > 2) What template should I be using. I believe this is called a text
> > > class. Correct?
> >
> >   I don't need to use any template. The easier thing to do is start from
> > a blank document and change it to manpage, in Layout->Document->Class.
>
> manpage is not one of the class options. What do I do? I see
> "manpage.layout" in /usr/share/lyx/layouts. It doesn't show up in the
> options. See attached screen shot.

  You should see it as: SGML (Linuxdoc manpage) that should show up earlier 
into the class options (the part that we don't see in the image yout sent). 
If you don't see it that means that you don't have sgmltools v1 installed. 

> How do I get it to show up in the choices for Class?
>
> > > 5) How does one generate a template file?
> >
> >   That is a lyx file with some things from the preamble cutted.
>
> Where does one put the templates? I have a .lyx directory in my home
> directory  and each of the subdirectories is empty. I tried copying all the
> files in /usr/share/lyx/layouts to ~.lyx/layouts and restarted lyx. Still
> the manpage layout doesn't appear.

  This should be an hint that you don't have sgmltools 1 installed.
  What do you see in the command line when you call lyx and then do 
Edit->Reconfigure?

  I have one line that says:
+checking for linuxdoc class linuxdoc...  yes
...
+checking for linuxdoc class manpage...  yes

> > > Thanks
> >
> >   Tell me if this helps,
>
> Making some progress and your help certainly is appreciated.

  I saw your earlier message but it was impossible for me to reply before.

> >--
> >José Abílio
>
>   * L I N U X * .~.  Paul A. Franz, P.E.  Engineering Software
>The Choice   /V\  Blackdog SoftwareNetwork Consulting and Sales
>of the GNU  /( )\  Custom Web Services
>Generation  ^^-^^ (425) 641-8202, (425) 641-1773 FAXInternet FAX

-- 
José Abílio

Re: man pages

[Jose Abilio Oliveira Matos]

On Wednesday 09 January 2002 04:22, Paul A. Franz, P.E. wrote:
 I am real new to Lyx. My interest is in its potential for writing Linux
 documentation. specifically Howto's and man pages.

 I've gotten it installed. Read through the tutorial and spent a bunch of
 time using google trying to figure some things out.

 Here is what I think you need to do to use it to write a man page.

 1) Start Lyx. Open using a template, I select Linuxdoc.

 I get a warning message:

 LyX: Unknown token `\cursor'. Inserting as text. [around line 45 of file
 /usr/share/lyx/templates/linuxdoctemplate.lyx]

  Oops, I did forget to update that file. That is done in the new version. 
Ignore this warning.

 2) I try a few different templates. Some do the above error, some don't.

  That is fixed in cvs.

 3) I understand that if the Linuxdoc template would work, (I believe it did
 yesterday) then I could create a man page, export it as a .DVI then use
 some program in SGML-tools to convert this to the man page format which is
 groff or nroff or troff that is gzipped. Anyway, that part is pretty
 unclear to me so far.

  I append an example of it.

 Questions.

 1) How do I fix that startup problem?

 2) What template should I be using. I believe this is called a text class.
 Correct?

  I don't need to use any template. The easier thing to do is start from a 
blank document and change it to manpage, in Layout-Document-Class.

  Since you are there change the Extra Options: to 
title=mytitle sectnum=mysectnum

where mytitle is the title of the man page and sectnum is the section number 
of the manpage.

 3) what successive steps to I do to create the actual man page?

  I'm sure it can be done from inside LyX but for now export the document as 
linuxdoc and from the command line do:

sgml2txt -m myfile.sgml

 4) Apparently, man pages must be rendered (formatted) for display. What is
 actually happening. I always just do this to print one man -t manpage |
 lpr which apparently sends the manpage through the troff filter to
 generate postscript for the printer.

  I don't get you here.

 5) How does one generate a template file?

  That is a lyx file with some things from the preamble cutted.

 Thanks

  Tell me if this helps,

   * L I N U X * .~.  Paul A. Franz, P.E.  Engineering Software
The Choice   /V\  Blackdog SoftwareNetwork Consulting and Sales
of the GNU  /( )\ http://blackdog.bellevue.wa.us/ Custom Web Services
Generation  ^^-^^ (425) 641-8202, (425) 641-1773 FAXInternet FAX

-- 
José Abílio


#LyX 1.1 created this file. For more info see http://www.lyx.org/
\lyxformat 218
\textclass manpage
\options title=linuxdoc sectnum=5
\language english
\inputencoding default
\fontscheme default
\graphics default
\paperfontsize 10
\spacing single 
\papersize Default
\paperpackage a4
\use_geometry 0
\use_amsmath 0
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle default

\layout Section

Secret
\layout Standard

The last super hyper program.
 With lots of cool options that are senseless.
 Try it today, you will not regret the choice.
\layout Section

Public
\layout Standard

Blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah.
\layout Section

Author
\layout Standard

Me.
 All rights reserved.
\the_end


!doctype linuxdoc system

manpage title=linuxdoc sectnum=5
!-- LyX 1.1 created this file. For more info see http://www.lyx.org/ --
sect1
Secret
p
The last super hyper program. With lots of cool options that
 are senseless. Try it today, you will not regret the choice.
/p
sect1
Public
p
Blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah blah blah blah blah.
/p
sect1
Author
p
Me. All rights reserved.
/p


/manpage



manpage.man
Description: Troff document

Re: man pages

[Jose Abilio Oliveira Matos]

On Wednesday 09 January 2002 04:22, Paul A. Franz, P.E. wrote:
 I am real new to Lyx. My interest is in its potential for writing Linux
 documentation. specifically Howto's and man pages.

 I've gotten it installed. Read through the tutorial and spent a bunch of
 time using google trying to figure some things out.

 Here is what I think you need to do to use it to write a man page.

 1) Start Lyx. Open using a template, I select Linuxdoc.

 I get a warning message:

 LyX: Unknown token `\cursor'. Inserting as text. [around line 45 of file
 /usr/share/lyx/templates/linuxdoctemplate.lyx]

  Oops, I did forget to update that file. That is done in the new version. 
Ignore this warning.

 2) I try a few different templates. Some do the above error, some don't.

  That is fixed in cvs.

 3) I understand that if the Linuxdoc template would work, (I believe it did
 yesterday) then I could create a man page, export it as a .DVI then use
 some program in SGML-tools to convert this to the man page format which is
 groff or nroff or troff that is gzipped. Anyway, that part is pretty
 unclear to me so far.

  I append an example of it.

 Questions.

 1) How do I fix that startup problem?

 2) What template should I be using. I believe this is called a text class.
 Correct?

  I don't need to use any template. The easier thing to do is start from a 
blank document and change it to manpage, in Layout-Document-Class.

  Since you are there change the Extra Options: to 
title=mytitle sectnum=mysectnum

where mytitle is the title of the man page and sectnum is the section number 
of the manpage.

 3) what successive steps to I do to create the actual man page?

  I'm sure it can be done from inside LyX but for now export the document as 
linuxdoc and from the command line do:

sgml2txt -m myfile.sgml

 4) Apparently, man pages must be rendered (formatted) for display. What is
 actually happening. I always just do this to print one man -t manpage |
 lpr which apparently sends the manpage through the troff filter to
 generate postscript for the printer.

  I don't get you here.

 5) How does one generate a template file?

  That is a lyx file with some things from the preamble cutted.

 Thanks

  Tell me if this helps,

   * L I N U X * .~.  Paul A. Franz, P.E.  Engineering Software
The Choice   /V\  Blackdog SoftwareNetwork Consulting and Sales
of the GNU  /( )\ http://blackdog.bellevue.wa.us/ Custom Web Services
Generation  ^^-^^ (425) 641-8202, (425) 641-1773 FAXInternet FAX

-- 
José Abílio


#LyX 1.1 created this file. For more info see http://www.lyx.org/
\lyxformat 218
\textclass manpage
\options title=linuxdoc sectnum=5
\language english
\inputencoding default
\fontscheme default
\graphics default
\paperfontsize 10
\spacing single 
\papersize Default
\paperpackage a4
\use_geometry 0
\use_amsmath 0
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle default

\layout Section

Secret
\layout Standard

The last super hyper program.
 With lots of cool options that are senseless.
 Try it today, you will not regret the choice.
\layout Section

Public
\layout Standard

Blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah.
\layout Section

Author
\layout Standard

Me.
 All rights reserved.
\the_end


!doctype linuxdoc system

manpage title=linuxdoc sectnum=5
!-- LyX 1.1 created this file. For more info see http://www.lyx.org/ --
sect1
Secret
p
The last super hyper program. With lots of cool options that
 are senseless. Try it today, you will not regret the choice.
/p
sect1
Public
p
Blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah blah blah blah blah.
/p
sect1
Author
p
Me. All rights reserved.
/p


/manpage



manpage.man
Description: Troff document

Re: man pages

[Jose Abilio Oliveira Matos]

On Wednesday 09 January 2002 04:22, Paul A. Franz, P.E. wrote:
> I am real new to Lyx. My interest is in its potential for writing Linux
> documentation. specifically Howto's and man pages.
>
> I've gotten it installed. Read through the tutorial and spent a bunch of
> time using google trying to figure some things out.
>
> Here is what I think you need to do to use it to write a man page.
>
> 1) Start Lyx. Open using a template, I select Linuxdoc.
>
> I get a warning message:
>
> LyX: Unknown token `\cursor'. Inserting as text. [around line 45 of file
> /usr/share/lyx/templates/linuxdoctemplate.lyx]

  Oops, I did forget to update that file. That is done in the new version. 
Ignore this warning.

> 2) I try a few different templates. Some do the above error, some don't.

  That is fixed in cvs.

> 3) I understand that if the Linuxdoc template would work, (I believe it did
> yesterday) then I could create a man page, export it as a .DVI then use
> some program in SGML-tools to convert this to the man page format which is
> groff or nroff or troff that is gzipped. Anyway, that part is pretty
> unclear to me so far.

  I append an example of it.

> Questions.
>
> 1) How do I fix that startup problem?
>
> 2) What template should I be using. I believe this is called a text class.
> Correct?

  I don't need to use any template. The easier thing to do is start from a 
blank document and change it to manpage, in Layout->Document->Class.

  Since you are there change the Extra Options: to 
title="mytitle" sectnum="mysectnum"

where mytitle is the title of the man page and sectnum is the section number 
of the manpage.

> 3) what successive steps to I do to create the actual man page?

  I'm sure it can be done from inside LyX but for now export the document as 
linuxdoc and from the command line do:

sgml2txt -m myfile.sgml

> 4) Apparently, man pages must be rendered (formatted) for display. What is
> actually happening. I always just do this to print one "man -t manpage |
> lpr" which apparently sends the manpage through the troff filter to
> generate postscript for the printer.

  I don't get you here.

> 5) How does one generate a template file?

  That is a lyx file with some things from the preamble cutted.

> Thanks

  Tell me if this helps,

>   * L I N U X * .~.  Paul A. Franz, P.E.  Engineering Software
>The Choice   /V\  Blackdog SoftwareNetwork Consulting and Sales
>of the GNU  /( )\  Custom Web Services
>Generation  ^^-^^ (425) 641-8202, (425) 641-1773 FAXInternet FAX

-- 
José Abílio


#LyX 1.1 created this file. For more info see http://www.lyx.org/
\lyxformat 218
\textclass manpage
\options title="linuxdoc" sectnum="5"
\language english
\inputencoding default
\fontscheme default
\graphics default
\paperfontsize 10
\spacing single 
\papersize Default
\paperpackage a4
\use_geometry 0
\use_amsmath 0
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle default

\layout Section

Secret
\layout Standard

The last super hyper program.
 With lots of cool options that are senseless.
 Try it today, you will not regret the choice.
\layout Section

Public
\layout Standard

Blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah.
\layout Section

Author
\layout Standard

Me.
 All rights reserved.
\the_end







Secret

The last super hyper program. With lots of cool options that
 are senseless. Try it today, you will not regret the choice.


Public

Blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah blah blah blah blah blah blah
 blah blah blah blah blah blah blah blah blah blah blah.


Author

Me. All rights reserved.







manpage.man
Description: Troff document