RE: Procedure Management Procedures

["Smith, Nelson" <NSmith@xxxxxxxxxxx>]

So, you're saying you just follow the same format as unix uses to document
it's commands, but for your homegrown procedures, you create them manually?
If that's the case, can you then use a unix utility to display them?

I've long looked for some way to easily display info about our procedures to
the other inhouse programmers, but haven't found any good way. I create
(manually) a format similiar to what you are showing, but I have no where to
put it except in the copy member I use for the prototypes.  I would love to
see some sort of utility that would display them graphically in a tree
structure based on category or useage or something of that sort.  Anyone
know of any thing like that?

> -----Original Message-----
> From: alan shore [SMTP:SHOREA@dime.com]
> Sent: Wednesday, August 29, 2001 9:14 AM
> To:   rpg400-l@midrange.com
> Subject:      RE: Procedure Management Procedures
>
> This is part of the UNIX operating system. you type
> man getenv
> press Enter, and a display of the command in question (in this case -
> getenv) is shown to the requestor.
>
> >>> "Smith, Nelson" <NSmith@lincare.com> 08/29/01 08:59AM >>>
> Cool.  How is this generated, stored, accessed, etc?   Is there a utility
> that manages it all?
>
> > -----Original Message-----
> > From:       James Rich [SMTP:james@eaerich.com]
> > Sent:       Tuesday, August 28, 2001 6:40 PM
> > To: rpg400-l@midrange.com
> > Subject:    Re: Procedure Management Procedures
> >
> > On Tue, 28 Aug 2001 Seth.D.Shields@blum.com wrote:
> >
> > > > One of the most useful things we have done is to create on
> > > line documentation similar to UNIX man pages.
> > >
> > > For those of us who are UNIX illiterate, what is a UNIX man page?
> >
> > man pages are a collection of documentation in a standard format sorted
> by
> > topic.  The man page for getenv() (chosen because of the recent
> discussion
> > here) looks like this:
> >
> >
> > GETENV(3)           Linux Programmer's Manual           GETENV(3)
> >
> > NAME
> >        getenv - get an environment variable
> >
> > SYNOPSIS
> >        #include <stdlib.h>
> >
> >        char *getenv(const char *name);
> >
> > DESCRIPTION
> >        The  getenv() function searches the environment list for a
> >        string that matches the string pointed to  by  name.   The
> >        strings are of the form name ==== value.
> >
> > RETURN VALUE
> >        The  getenv()  function  returns a pointer to the value in
> >        the environment, or NULL if there is no match.
> >
> > CONFORMING TO
> >        SVID 3, POSIX, BSD 4.3, ISO 9899
> >
> > SEE ALSO
> >        putenv(3), setenv(3), unsetenv(3), environ(5)
> >
> > GNU                         1993-04-03                  GETENV(3)
> >
> >
> > This is the format we use to document our procedures.
> >
> > James Rich
> > james@eaerich.com
> >
> > _______________________________________________
> > This is the RPG programming on the AS400 / iSeries (RPG400-L) mailing
> list
> > To post a message email: RPG400-L@midrange.com
> > To subscribe, unsubscribe, or change list options,
> > visit: http://lists.midrange.com/cgi-bin/listinfo/rpg400-l
> > or email: RPG400-L-request@midrange.com
>
>
> **************************************************************************
> **************************************************************************
> ********************************************************
> This message originates from Lincare Holdings Inc. It contains information
> which maybe confidential or privileged and is intended only for the
> individual or entity named above.
> It is prohibited for anyone else to disclose, copy, distribute or use the
> contents of this message.
> All personal messages express views solely of the sender, which are not to
> be attributed to Lincare Holdings Inc., and may not be copied or
> distributed without this disclaimer.
> If you received this message in error, please notify us immediately at
> MailAdmin@lincare.com or (800) 284-2006.
> **************************************************************************
> **************************************************************************
> ********************************************************
> _______________________________________________
> This is the RPG programming on the AS400 / iSeries (RPG400-L) mailing list
> To post a message email: RPG400-L@midrange.com
> To subscribe, unsubscribe, or change list options,
> visit: http://lists.midrange.com/cgi-bin/listinfo/rpg400-l
> or email: RPG400-L-request@midrange.com
>
>
> _______________________________________________
> This is the RPG programming on the AS400 / iSeries (RPG400-L) mailing list
> To post a message email: RPG400-L@midrange.com
> To subscribe, unsubscribe, or change list options,
> visit: http://lists.midrange.com/cgi-bin/listinfo/rpg400-l
> or email: RPG400-L-request@midrange.com