Re: man page for curl-loader

[BuraphaLinux S. <bur...@gm...>]

Hello,

Updating the version and date is easy.  Try this solution.

In the top-level Makefile, near the top add these two lines:

VERZUN=0.32
DEIGHT=`date +"%B %d, %Y"`

Each release, change the VERZUN line to have the correct version number,
or have a more elaborate rule that can generate it somehow.

Then near the end before the generic rules add this (gmail may wrap and
will probably ruin the real tabs you need; sorry; assuming GNU make):

.PHONY: curl-loader.1
curl-loader.1:  curl-loader.man
        sed -e"s/DUHVERZUN/$(VERZUN)/g" -e "s/DEIGHT/$(DEIGHT)/g" <
curl-loader.man > curl-loader.1

Rename the curl-loader.1 I sent you to curl-loader.man

Update curl-loader.man so the .TH line looks like this:

.TH curl\-loader 8 "DEIGHT" "Version DUHVERZUN"

Now you can do:

make curl-loader.1

and you will get a curl-loader.1 with the .TH line with something
like this:

.TH curl\-loader 8 "June 26, 2007" "Version 0.32"

I spell things incorrectly to prevent collisions with real variables; if you
were paranoid you could use longer names or something.  The 8 is
the section number; since you have to be root to run this tool, I put
it in section 8.

To create the original page and to update content on man pages I
maintain, I just use vi and type the groff/man commands I need.
You can change words and add more content easily, remembering
some simple rules:

1.  Never begin a line with a period
2.  Every hyphen must be escaped like \-
3.  Create a line with nothing but .P on it to start a new paragraph.

The groff.info file describes the groff commands and man macro
set you would need to use, and for normal man pages it is easy.
Most people learn to do this by copying existing man pages, and
that is how I learned initially.  So to add a new command-line
switch just copy everything from a different one (I did many
on the page) and then change the words and letters.  To add
normal paragraphs, just type them following the 3 rules above.
To add sample files or sample commands, use the .nf/.fi to
start no-fill and fill modes (fill is justify in groff).

You can test your page any time with a line like this:

make curl-loader.1
groff -man -Tascii curl-loader.1 | less -ic

The most critical part of the man page is that content; the
formatting doesn't matter if the content is wrong, and if the
content is right people can use the program and they will
(normally) forgive any ugly formatting.

Is that what you were asking me, or did I just answer the
wrong  question?


On 6/25/07, Robert Iakobashvili <cor...@gm...> wrote:
> On 6/25/07, BuraphaLinux Server <bur...@gm...> wrote:
> > Attached is a man page for curl-loader, since it appears there is not
> > one that comes in the curl-loader-0.32 package.
> >
> > Would you like a man page for the configure file too?
> Yes.
>
> Great! Thank you very much indeed.
>
> Actually, we need also a way to update, edit and correct as our procedure.
> Can you propose something? Thanks.
>
> Michael,
> we should arrange a Makefile target install, which will install
> our binary (no libs till now, all linked static), docs like config
> files examples,
> README and, finally, man-pages.
>
> May be it is worth to have a single man-page for all curl-loader issues?
> Your opinions would be very much appreciated.
>
> --
> Sincerely,
> Robert Iakobashvili,
> coroberti %x40 gmail %x2e com
> ...........................................................
> http://curl-loader.sourceforge.net
> A web testing and traffic generation tool.
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by DB2 Express
> Download DB2 Express C - the FREE version of DB2 express and take
> control of your XML. No limits. Just data. Click to get it now.
> http://sourceforge.net/powerbar/db2/
> _______________________________________________
> curl-loader-devel mailing list
> cur...@li...
> https://lists.sourceforge.net/lists/listinfo/curl-loader-devel
>