d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b704d1f289
freebsd-nq/usr.bin/soelim/soelim.1

83 lines
2.5 KiB
Groff
Raw Normal View History

Add a new soeliminate(1) command mandoc(1) does not provide an equivalent of the GNU groff's soelim(1) as an external binary. It does provide the funcitonnality but internally. Lots if manpages in ports uses ".so" directives to include the content of another manpage, which works properly if the manpages are not compressed. With compressed manpages it will fail. So we need to preprocess those manpages with soelim(1) before compressing them. soeliminate(1) add the minimum functionnality from soelim(1) required for that task, in order to still be able to prepare properly those manpages in case we ship the base system only with mandoc as a manpage renderer. soeliminate(1) accept all the arguments from soelim(1) for compatibility but only '-I dir' is really functionnal. Name it soeliminate and not soelim, so groff from base or ports can still call soelim(1) for its internal use and avoid potential incompatibilities MFC after: 1 month
2014-11-22 01:22:03 +00:00
.\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
.\" 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.
.\"
.\" $FreeBSD$
.\"
Replace groff's soelim by soeliminate(1) renamed soelim(1)
2015-05-01 20:08:25 +00:00
.Dd May 1, 2015
.Dt SOELIM 1
Add a new soeliminate(1) command mandoc(1) does not provide an equivalent of the GNU groff's soelim(1) as an external binary. It does provide the funcitonnality but internally. Lots if manpages in ports uses ".so" directives to include the content of another manpage, which works properly if the manpages are not compressed. With compressed manpages it will fail. So we need to preprocess those manpages with soelim(1) before compressing them. soeliminate(1) add the minimum functionnality from soelim(1) required for that task, in order to still be able to prepare properly those manpages in case we ship the base system only with mandoc as a manpage renderer. soeliminate(1) accept all the arguments from soelim(1) for compatibility but only '-I dir' is really functionnal. Name it soeliminate and not soelim, so groff from base or ports can still call soelim(1) for its internal use and avoid potential incompatibilities MFC after: 1 month
2014-11-22 01:22:03 +00:00
.Os
.Sh NAME
Replace groff's soelim by soeliminate(1) renamed soelim(1)
2015-05-01 20:08:25 +00:00
.Nm soelim
Add a new soeliminate(1) command mandoc(1) does not provide an equivalent of the GNU groff's soelim(1) as an external binary. It does provide the funcitonnality but internally. Lots if manpages in ports uses ".so" directives to include the content of another manpage, which works properly if the manpages are not compressed. With compressed manpages it will fail. So we need to preprocess those manpages with soelim(1) before compressing them. soeliminate(1) add the minimum functionnality from soelim(1) required for that task, in order to still be able to prepare properly those manpages in case we ship the base system only with mandoc as a manpage renderer. soeliminate(1) accept all the arguments from soelim(1) for compatibility but only '-I dir' is really functionnal. Name it soeliminate and not soelim, so groff from base or ports can still call soelim(1) for its internal use and avoid potential incompatibilities MFC after: 1 month
2014-11-22 01:22:03 +00:00
.Nd interpret .so directive in manpages
.Sh SYNOPSIS
.Nm
.Op Fl Crtv
.Op Fl I Ar dir
.Op Ar files ...
.Sh DESCRIPTION
.Nm
reads
.Ar files
lines by lines.
.Pp
If a line starts by:
.Dq .so anotherfile
it replace the line by processing
.Dq anotherfile .
Otherwise the line is printed to stdout.
.Bl -tag -width "-I dir"
.It Fl C
Improve compatibility groff's soelim While here implement -C from GNU groff Reported by: delphij
2015-05-01 23:54:09 +00:00
Recognise
.Em .so
when not followed by a space character.
Add a new soeliminate(1) command mandoc(1) does not provide an equivalent of the GNU groff's soelim(1) as an external binary. It does provide the funcitonnality but internally. Lots if manpages in ports uses ".so" directives to include the content of another manpage, which works properly if the manpages are not compressed. With compressed manpages it will fail. So we need to preprocess those manpages with soelim(1) before compressing them. soeliminate(1) add the minimum functionnality from soelim(1) required for that task, in order to still be able to prepare properly those manpages in case we ship the base system only with mandoc as a manpage renderer. soeliminate(1) accept all the arguments from soelim(1) for compatibility but only '-I dir' is really functionnal. Name it soeliminate and not soelim, so groff from base or ports can still call soelim(1) for its internal use and avoid potential incompatibilities MFC after: 1 month
2014-11-22 01:22:03 +00:00
.It Fl r
Compatibility with GNU groff's
.Xr soelim 1
(does nothing).
.It Fl t
Compatibility with GNU groff's
.Xr soelim 1
(does nothing).
.It Fl v
Compatibility with GNU groff's
.Xr soelim 1
(does nothing).
.It Fl I Ar dir
This option specify directories where
.Nm
mdoc: remove EOL whitespace.
2014-12-29 13:50:59 +00:00
searches for files (both those on the command line and those named in
Add a new soeliminate(1) command mandoc(1) does not provide an equivalent of the GNU groff's soelim(1) as an external binary. It does provide the funcitonnality but internally. Lots if manpages in ports uses ".so" directives to include the content of another manpage, which works properly if the manpages are not compressed. With compressed manpages it will fail. So we need to preprocess those manpages with soelim(1) before compressing them. soeliminate(1) add the minimum functionnality from soelim(1) required for that task, in order to still be able to prepare properly those manpages in case we ship the base system only with mandoc as a manpage renderer. soeliminate(1) accept all the arguments from soelim(1) for compatibility but only '-I dir' is really functionnal. Name it soeliminate and not soelim, so groff from base or ports can still call soelim(1) for its internal use and avoid potential incompatibilities MFC after: 1 month
2014-11-22 01:22:03 +00:00
.Dq .so
directive.)
This options may be specified multiple times. The directories will be searched
in the order specified.
.El
.Pp
The files are always searched first in the current directory.
.Pp
A file specified with an absolute path will be opened directly without
performing a search.
.Sh SEE ALSO
.Xr mandoc 1 ,
.Xr soelim 1
Reference in New Issue Copy Permalink