Add support files for using text from the POSIX specification in
FreeBSD manual pages: - POSIX-copyright contains copyright text to be used in manual pages which has POSIX text inserted. - deshallify.sh is a shell script which removes many of the ``shall'' statements from the POSIX text and therefore making the text more readable. Real work to make this happen by: nectar, ru
This commit is contained in:
parent
abf3e95c19
commit
f1192bffc1
@ -133,6 +133,8 @@ XFILES= BSD_daemon/FreeBSD.pfa \
|
||||
kld/syscall/test/call.c \
|
||||
libvgl/Makefile \
|
||||
libvgl/demo.c \
|
||||
mdoc/POSIX-copyright \
|
||||
mdoc/deshallify.sh \
|
||||
mdoc/example.1 \
|
||||
mdoc/example.3 \
|
||||
mdoc/example.4 \
|
||||
|
36
share/examples/mdoc/POSIX-copyright
Normal file
36
share/examples/mdoc/POSIX-copyright
Normal file
@ -0,0 +1,36 @@
|
||||
.\" Copyright (c) [year] [your name]
|
||||
.\" 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.
|
||||
.\"
|
||||
.\" Portions of this text are reprinted and reproduced in electronic form
|
||||
.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
|
||||
.\" Portable Operating System Interface (POSIX), The Open Group Base
|
||||
.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
|
||||
.\" Electrical and Electronics Engineers, Inc and The Open Group. In the
|
||||
.\" event of any discrepancy between this version and the original IEEE and
|
||||
.\" The Open Group Standard, the original IEEE and The Open Group Standard is
|
||||
.\" the referee document. The original Standard can be obtained online at
|
||||
.\" http://www.opengroup.org/unix/online.html.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
9
share/examples/mdoc/deshallify.sh
Normal file
9
share/examples/mdoc/deshallify.sh
Normal file
@ -0,0 +1,9 @@
|
||||
#!/bin/sh
|
||||
# Script to remove shall clauses.
|
||||
#
|
||||
# $FreeBSD$
|
||||
#
|
||||
sed -e 's/s shall define/s define/g' -e 's/shall define/defines/g' -e's/shall attempt/attempts/g' -e 's/shall include/includes/g' -e's/shall return zero and have/returns zero and has/g' -e 's/shall return/returns/g' -e 's/shall also include/also includes/g' -e's/pipe or FIFO shall be /pipe of FIFO are /g' -e 's/s shall be /s are /g' -e's/shall be /is /g' -e's/s shall create/s create/g' -e 's/shall create /creates /g' -e 's/shall perform/performs/g' -e's/shall affect the/affect the/g' -e's/s shall have/s have/g' -e's/shall have/has/g' -e 's/shall transfer/transfers/g' -e's/shall block/blocks/g' -e's/shall not block/does not block/g' -e's/shall occur/occurs/g' -e's/shall complete/complete/g' -e's/shall mark for update/marks for update/g' -e's/s shall fail/s fail/g' -e's/shall fail/fails/g' -e's/s shall generate/s generate/g' -e's/shall generate/generates/g' -e's/shall place/places/g' -e's/s shall default/s default/g' -e's/shall default/defaults/g' -e's/pplications shall ensure!
|
||||
/pplications must ensure/g' -e's/pplication shall ensure/pplication must ensure/g' -e's/shall always begin/always begins/g' -e's/s shall begin /s begin /g' -e's/shall begin /begins /g' -e's/shall always contain /always contains /g' -e's/shall produce/produces/g' -e's/shall appear/appears/g' -e's/s shall be$/s are/g' -e's/shall be$/is/g' -e's/which shall result /which results /g' -e's/s shall not/s are not/g' -e's/shall not be/is not/g' -e's/shall not/is not/g' -e's/s shall behave/s behave/g' -e's/shall behave/behaves/g' -e's/shall specify/specifies/g' -e's/s shall override/s override/g' -e's/shall override/overrides/g' -e's/shall apply /applies /g' -e's/s shall start/s start/g' -e's/shall start /starts /g' -e's/s shall affect/s affect/g' -e's/shall affect/affects/g' -e's/s shall indicate/s indicate/g' -e's/shall indicate/indicates/g' -e's/shall set /set /g' -e's/s shall recognize/s recognize/g' -e's/shall recognize /recognizes /g' -e's/shall also be /is also /g' -e's/s shal!
|
||||
l enter/s enter/g' -e's/shall enter /enters /g' -e's/shall ta!
|
||||
ke /take /g' -e's/they shall only take /they only take /g' -e's/shall consist /consist /g' -e 's/s shall cause/s cause/g' -e's/shall cause/causes/g' -e's/s shall replace/s replace/g' -e's/shall replace/replaces/g' -e's/shall become/becomes/g' -e's/shall each consist/each consist/g' $1 > $1.x
|
Loading…
Reference in New Issue
Block a user