Date: Tue, 16 May 2000 13:10:02 -0700 (PDT) From: "Thomas D. Dean" <tomdean@ix.netcom.com> To: freebsd-doc@freebsd.org Subject: Re: docs/18233 Message-ID: <200005162010.NAA45162@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/18233; it has been noted by GNATS.
From: "Thomas D. Dean" <tomdean@ix.netcom.com>
To: vanderh@ecf.utoronto.ca
Cc: freebsd-doc@FreeBSD.org
Subject: Re: docs/18233
Date: Mon, 15 May 2000 19:58:37 -0700 (PDT)
I have included two examples.
The first has EXTRA blank lines at page boundaries.
The second has three blank lines after after the line 'bin directory':
FILES
src/Makefile A make file that will build a project in the
bin directory.
src/project_name.c The main() function.
tomdean
===== example 1 ==========
#! /bin/sh
# generate a man page which will have extra blank lines
cat <<EOF
.Dd DATE
.Os
.Dt XX_TEST 1
.Sh NAME
.Nm xx_test
.Nd This will produce blank line errors.
EOF
section=0
paragraph=0
while [ $section -lt 30 ]; do
echo ".Sh Section Number ${section}"
section=`expr ${section} + 1`
n=0
while [ $n -lt 3 ]; do
echo "This is paragraph ${paragraph}."
echo ".Pp"
paragraph=`expr ${paragraph} + 1`
n=`expr $n + 1`
done
done
==== example 2 ============
.\" Copyright (c)
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id$
.Dd April 23, 2000
.Dt APPL_SETUP 1
.Os FreeBSD 3.4
.Sh NAME
.Nm appl_setup
.Nd An application development tree maintenance tool.
.Sh SYNOPSIS
.Nm
.Op Fl a Ar component
.Op Fl Cc
.Op Fl f Ar file_name Ar include_file
.Op Fl h
.Op Fl i Ar file_name
.Op Fl l
.Op Fl m Ar man_section
.Op Fl p Ar project_name
.Sh DESCRIPTION
.Nm
is a perl script that aids in creating and managing application development
trees.
.Sh OPTIONS
The options are as follows:
.Bl -tag -width "-f file name include file"
.It Fl a Ar component
Add a component to the directory tree.
.Bl -tag -width "library" -compact
.It Library
Add a library sub-directory to the project tree.
.It Include
Add a include sub-directory to the project tree.
.El
.It Fl C
Create a
.Sy C++
project. Not implemented.
.It Fl c
Import the project into
.Sy CVS
as version 0.9.0.
.It Fl f Ar file_name Ar include_file
.Pp
create a new source file named
.Pa file_name.c
including
.Pa include_file.h.
The source file will have a integer function named
.Fn file_name
The author is the output of
.Sy whoami.
If specified,
.Fl p
will create a source file with a
.Fn main
function.
.It Fl h
Help.
.It Fl i Ar file_name
create a new c type include file named
.Pa file_name.h.
The include file will have a standard comment header and
and the #ifdef ... #endif brackets to prevent multiple inclusion
.It Fl l
create a library sub-directory
The default is to not create the library sub-directory
.It Fl m Ar man_section_number
create a man page for man.number. The default is to not create the
man page.
.It Fl p Ar project_name
Create a new project named project_name.
The project will be created at the current directory level and have a tree
consisting of the bin, include, obj, and, src directories.
A file containing a main function will be created, named project_name.c
.El
.Sh ENVIRONMENT
The
.Nm
command ignores the
.Ev APPL_SETUP
environment variable.
.Sh FILES
.Bl -tag -width "include/project_name.def"
.It Pa src/Makefile
A make file that will build a project in the bin directory.
.It Pa src/project_name.c
The
.Fn main
function.
.It Pa include/project_name.h
The primary local include file.
.It Pa include/project_name.def
A message and return code definitio file. See
.Pa bin/mkError.awk
and
.Pa bin/mkErrorStr.awk.
.It Pa obj/Makefile
A link to
.Pa src/Makefile.
.It Pa bin/mkError.awk
The awk script to build definitions from a definition file.
.It Pa bin/mkErrorStr.awk
The awk script to build error message definitions from a definition
file.
.El
.Sh EXAMPLES
.Nm
.Fl p Ar myProject
.Pp
This command will create a project tree in the current directory. The
project tree will consist of bin, include, obj, and, src directories.
The src directory will contain a Makefile and myProject.c main
application. The include directory will contain a myProject.h The
Makefile will not allow making in the src directory. The obj
directory contains a Makefile, linked to
.Pa ../src/Makefile.
The result
of make will produce an executable named myProject in the bin
directory.
.Sh DIAGNOSTICS
Exit status is 0 on success, and negative if the command
fails for one of the following reasons
.Sh COMPATIBILITY
The
.Nm
command has no known compatibility issues.
.Sh SEE ALSO
.Sh STANDARDS
.Sh HISTORY
.Sh AUTHORS
This
manual page was written by
.An Thomas D. Dean
.Sh BUGS
.Nm
is in its infancy.
.Nm
will create a workable application development tree.
Maintenance functions are missing.
.Sh TODO
I need help in designing
.Nm
What functionality is needed? Desireable?
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200005162010.NAA45162>