intro.ms

intro.ms

[Mikael Magnusson]

Hi,

Etc/FAQ.yo says

  For more information, the files Doc/intro.txt or Doc/intro.troff
  included with the source distribution are highly recommended.  A list
  of features is given in FEATURES, also with the source.

But these files don't exist at least since we started using cvs, and I
can't get any man/troff/nroff/*roff variant to produce readable output
from intro.ms. /README notes that it is based on zsh 2.5 but still a
good introduction. Does anyone know how to build it, or should we
remove it and/or the recommendation to read it?

-- 
Mikael Magnusson

Re: intro.ms

[Peter Stephenson]

On Fri, 13 Apr 2012 14:21:27 +0200
Mikael Magnusson <mikachu@gmail.com> wrote:
>   For more information, the files Doc/intro.txt or Doc/intro.troff
>   included with the source distribution are highly recommended.  A list
>   of features is given in FEATURES, also with the source.
> 
> But these files don't exist at least since we started using cvs, and I
> can't get any man/troff/nroff/*roff variant to produce readable output
> from intro.ms. /README notes that it is based on zsh 2.5 but still a
> good introduction. Does anyone know how to build it, or should we
> remove it and/or the recommendation to read it?

"nroff -ms" is still producing quite readable about for me, and "pdfroff
-ms" produced a usable document which we could distribute in the doc
bundle, but it's not a very sensible source format.  I suppose it would
need to be translated by hand.

-- 
Peter Stephenson <pws@csr.com>            Software Engineer
Tel: +44 (0)1223 692070                   Cambridge Silicon Radio Limited
Churchill House, Cambridge Business Park, Cowley Road, Cambridge, CB4 0WZ, UK


Member of the CSR plc group of companies. CSR plc registered in England and Wales, registered number 4187346, registered office Churchill House, Cambridge Business Park, Cowley Road, Cambridge, CB4 0WZ, United Kingdom
More information can be found at www.csr.com. Follow CSR on Twitter at http://twitter.com/CSR_PLC and read our blog at www.csr.com/blog

Re: intro.ms

[Mikael Magnusson]

On 13 April 2012 14:35, Peter Stephenson <Peter.Stephenson@csr.com> wrote:
> On Fri, 13 Apr 2012 14:21:27 +0200
> Mikael Magnusson <mikachu@gmail.com> wrote:
>>   For more information, the files Doc/intro.txt or Doc/intro.troff
>>   included with the source distribution are highly recommended.  A list
>>   of features is given in FEATURES, also with the source.
>>
>> But these files don't exist at least since we started using cvs, and I
>> can't get any man/troff/nroff/*roff variant to produce readable output
>> from intro.ms. /README notes that it is based on zsh 2.5 but still a
>> good introduction. Does anyone know how to build it, or should we
>> remove it and/or the recommendation to read it?
>
> "nroff -ms" is still producing quite readable about for me, and "pdfroff
> -ms" produced a usable document which we could distribute in the doc
> bundle, but it's not a very sensible source format.  I suppose it would
> need to be translated by hand.

Ah, I didn't know you had to pass any switches to it, all I know about
roff is it's something to do with man pages usually :). I read about a
third of it so far, and most of it is still applicable. We might want
to remove the bits about compctl if we keep the recommendation in the
FAQ to read it.

-- 
Mikael Magnusson

Re: intro.ms

[Peter Stephenson]

This is only done with the "everything" and "pdf" targets, so it doesn't
matter if it's not available on all systems.

Index: Doc/.distfiles
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/.distfiles,v
retrieving revision 1.10
diff -p -u -r1.10 .distfiles
--- Doc/.distfiles	16 Apr 2009 10:17:23 -0000	1.10
+++ Doc/.distfiles	13 Apr 2012 22:40:49 -0000
@@ -18,4 +18,5 @@ DISTFILES_DOC='
     *.html
     zsh.dvi
     zsh.pdf
+    intro.pdf
 '
Index: Doc/Makefile.in
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Makefile.in,v
retrieving revision 1.49
diff -p -u -r1.49 Makefile.in
--- Doc/Makefile.in	12 Oct 2011 13:03:55 -0000	1.49
+++ Doc/Makefile.in	13 Apr 2012 22:40:49 -0000
@@ -94,7 +94,7 @@ dvi: zsh.dvi
 zsh.dvi: $(sdir)/zsh.texi
 	$(TEXI2DVI) $(sdir)/zsh.texi
 
-pdf: zsh.pdf
+pdf: zsh.pdf intro.pdf
 .PHONY: pdf
 
 zsh.pdf: $(sdir)/zsh.texi
@@ -104,6 +104,9 @@ zsh.pdf: $(sdir)/zsh.texi
 	  PDFTEX=$(PDFETEX) $(TEXI2DVI) --pdf $(sdir)/zsh.texi; \
 	fi
 
+intro.pdf: $(sdir)/intro.ms
+	pdfroff -ms $(sdir)/intro.ms >intro.pdf
+
 texi: $(sdir)/zsh.texi
 .PHONY: texi
 
-- 
Peter Stephenson <p.w.stephenson@ntlworld.com>
Web page now at http://homepage.ntlworld.com/p.w.stephenson/

Re: intro.ms

[Mikael Magnusson]

On 13 April 2012 16:10, Mikael Magnusson <mikachu@gmail.com> wrote:
> On 13 April 2012 14:35, Peter Stephenson <Peter.Stephenson@csr.com> wrote:
>> On Fri, 13 Apr 2012 14:21:27 +0200
>> Mikael Magnusson <mikachu@gmail.com> wrote:
>>>   For more information, the files Doc/intro.txt or Doc/intro.troff
>>>   included with the source distribution are highly recommended.  A list
>>>   of features is given in FEATURES, also with the source.
>>>
>>> But these files don't exist at least since we started using cvs, and I
>>> can't get any man/troff/nroff/*roff variant to produce readable output
>>> from intro.ms. /README notes that it is based on zsh 2.5 but still a
>>> good introduction. Does anyone know how to build it, or should we
>>> remove it and/or the recommendation to read it?
>>
>> "nroff -ms" is still producing quite readable about for me, and "pdfroff
>> -ms" produced a usable document which we could distribute in the doc
>> bundle, but it's not a very sensible source format.  I suppose it would
>> need to be translated by hand.
>
> Ah, I didn't know you had to pass any switches to it, all I know about
> roff is it's something to do with man pages usually :). I read about a
> third of it so far, and most of it is still applicable. We might want
> to remove the bits about compctl if we keep the recommendation in the
> FAQ to read it.

I just made it to the end, and noticed that, at least for me, the
pdfroff -ms command produces a pdf that has the whole content twice,
ie it is 84 pages. nroff -ms doesn't seem to do this.

-- 
Mikael Magnusson