Sort options in SYNOPSIS and text.

XXX: please check if SYNOPSIS are correct, I think they missing some .Op.
This commit is contained in:
wiz 2013-01-19 01:22:12 +00:00
parent ba9f75da1e
commit 519dc5efd2
3 changed files with 134 additions and 133 deletions

View File

@ -1,31 +1,31 @@
.\" $NetBSD: ctfconvert.1,v 1.1 2013/01/18 19:58:43 christos Exp $
.\" $NetBSD: ctfconvert.1,v 1.2 2013/01/19 01:22:12 wiz Exp $
.\"
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" All rights reserved.
.\"
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" All rights reserved.
.\"
.\" This software was developed by Rui Paulo under sponsorship from the
.\" FreeBSD Foundation.
.\"
.\" 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 Foundation.
.\"
.\" 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: src/cddl/usr.bin/ctfconvert/ctfconvert.1,v 1.1 2010/08/11 18:00:45 rpaulo Exp $
.\"
@ -38,45 +38,47 @@
.Sh SYNOPSIS
.Nm
.Op Fl gis
.Fl l Ar label
.Fl L Ar labelenv
.Fl l Ar label
.Op Fl o Ar outfile
object_file
.Ar object_file
.Sh DESCRIPTION
The
.Nm
utility converts debug information from a binary file to CTF data and replaces
the debug section of that file with a CTF section called SUNW_ctf.
This new section is added to the input file, unless the -o
This new section is added to the input file, unless the
.Fl o
option is present.
You can also opt to keep the original debugging section with the
-g option.
.Fl g
option.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl l Ar label
Sets the label as
.Ar label .
.It Fl g
Don't delete the original debugging section.
.It Fl i
Ignore object files built from other languages than C.
.It Fl L Ar labelenv
Instructs
.Nm
to read the label from the environment variable
.Ar labelenv .
.It Fl g
Don't delete the original debugging section.
.It Fl i
Ignore object files built from other languages than C.
.It Fl s
Use the .dynsym ELF section instead of the .symtab ELF section.
.It Fl l Ar label
Sets the label as
.Ar label .
.It Fl o Ar outfile
Write the output to file in
.Ar outfile .
.It Fl s
Use the .dynsym ELF section instead of the .symtab ELF section.
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr ctfmerge 1 ,
.Xr ctfdump 1
.Xr ctfdump 1 ,
.Xr ctfmerge 1
.Sh HISTORY
The
.Nm

View File

@ -1,31 +1,31 @@
.\" $NetBSD: ctfdump.1,v 1.1 2013/01/18 19:58:44 christos Exp $
.\" $NetBSD: ctfdump.1,v 1.2 2013/01/19 01:22:13 wiz Exp $
.\"
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" All rights reserved.
.\"
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" All rights reserved.
.\"
.\" This software was developed by Rui Paulo under sponsorship from the
.\" FreeBSD Foundation.
.\"
.\" 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 Foundation.
.\"
.\" 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: src/cddl/usr.bin/ctfdump/ctfdump.1,v 1.1 2010/08/11 18:00:45 rpaulo Exp $
.\"
@ -37,9 +37,9 @@
.Nd dump the SUNW_ctf section of an ELF file
.Sh SYNOPSIS
.Nm
.Op Fl dfhlsSt
.Fl u Ar file
file
.Op Fl dfhlSst
.Fl u Ar ufile
.Ar file
.Sh DESCRIPTION
The
.Nm
@ -60,10 +60,10 @@ Show the function section.
Show the header.
.It Fl l
Show the label section.
.It Fl s
Show the string table.
.It Fl S
Show statistics.
.It Fl s
Show the string table.
.It Fl t
Show the type section.
.It Fl u Ar ufile

View File

@ -1,31 +1,31 @@
.\" $NetBSD: ctfmerge.1,v 1.1 2013/01/18 19:58:44 christos Exp $
.\" $NetBSD: ctfmerge.1,v 1.2 2013/01/19 01:22:13 wiz Exp $
.\"
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" All rights reserved.
.\"
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" All rights reserved.
.\"
.\" This software was developed by Rui Paulo under sponsorship from the
.\" FreeBSD Foundation.
.\"
.\" 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 Foundation.
.\"
.\" 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: src/cddl/usr.bin/ctfmerge/ctfmerge.1,v 1.1 2010/08/11 18:00:45 rpaulo Exp $
.\"
@ -33,31 +33,30 @@
.Dt CTFMERGE 1
.Os
.Sh NAME
.Nm ctfmerge
.Nm ctfmerge
.Nd merge several CTF data sections into one
.Sh SYNOPSIS
.Nm
.Op Fl fgstv
.Fl l Ar label
.Fl L Ar labelenv
.Fl l Ar label
.Fl o Ar outfile
file ...
.Ar file ...
.Nm
.Op Fl fgstv
.Fl l Ar label
.Fl L Ar labelenv
.Fl o Ar outfile
.Fl d Ar uniqfile
.Op Fl g
.Op Fl D Ar uniqlabel
file ...
.Fl d Ar uniqfile
.Fl L Ar labelenv
.Fl l Ar label
.Fl o Ar outfile
.Ar file ...
.Nm
.Op Fl fgstv
.Fl l Ar label
.Fl L Ar labelenv
.Fl l Ar label
.Fl o Ar outfile
.Fl w Ar withfile
file ...
.Ar file ...
.Nm
.Op Fl g
.Fl c Ar srcfile
@ -70,47 +69,47 @@ output file, unifying common data.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl c Ar srcfile Ar destfile
Copy CTF data from
.Ar srcfile
into
.Ar destfile .
.It Fl D Ar uniqlabel
Uniquify against label
.Ar uniqlabel .
.It Fl d Ar uniqfile
Uniquify against
.Ar uniqfile .
.It Fl f
Match global symbols to global CTF data.
.It Fl g
Don't delete the original debugging sections.
.It Fl L Ar labelenv
Instructs
.Nm
to read the label from the environment variable
.Ar labelenv .
.It Fl l Ar label
Sets the label as
.Ar label .
.It Fl o Ar outfile
Use
.Ar outfile
to store the merged CTF data.
.It Fl s
Use the .dynsym ELF section instead of the .symtab ELF section.
.It Fl t
Make sure that all object files have a CTF section.
.It Fl v
Enable verbose mode.
.It Fl l Ar label
Sets the label as
.Ar label .
.It Fl L Ar labelenv
Instructs
.Nm
to read the label from the environment variable
.Ar labelenv .
.It Fl o Ar outfile
Use
.Ar outfile
to store the merged CTF data.
.It Fl d Ar uniqfile
Uniquify against
.Ar uniqfile .
.It Fl d Ar uniqlabel
Uniquify against label
.Ar uniqlabel
.It Fl w Ar withfile
Additive merge with
.Ar withfile .
.It Fl c Ar srcfile Ar destfile
Copy CTF data from
.Ar srcfile
into
.Ar destfile .
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr ctfconvert 1 ,
.Xr ctfconvert 1 ,
.Xr ctfdump 1
.Sh HISTORY
The