Index: head/cddl/contrib/opensolaris/cmd/zstreamdump/zstreamdump.1 =================================================================== --- head/cddl/contrib/opensolaris/cmd/zstreamdump/zstreamdump.1 (revision 235210) +++ head/cddl/contrib/opensolaris/cmd/zstreamdump/zstreamdump.1 (revision 235211) @@ -1,67 +1,67 @@ '\" te .\" Copyright (c) 2011, Martin Matuska . .\" All Rights Reserved. .\" .\" The contents of this file are subject to the terms of the .\" Common Development and Distribution License (the "License"). .\" You may not use this file except in compliance with the License. .\" .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE .\" or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions .\" and limitations under the License. .\" .\" When distributing Covered Code, include this CDDL HEADER in each .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. .\" If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying .\" information: Portions Copyright [yyyy] [name of copyright owner] .\" .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. .\" .\" $FreeBSD$ .\" .Dd November 26, 2011 .Dt ZSTREAMDUMP 8 .Os .Sh NAME -.Nm zdb +.Nm zstreamdump .Nd filter data in zfs send stream .Sh SYNOPSIS .Nm .Op Fl C .Op Fl v .Sh DESCRIPTION The .Nm utility reads from the output of the .Qq Nm zfs Cm send command, then displays headers and some statistics from that output. See .Xr zfs 8 . .Pp The following options are supported: .Bl -tag -width indent .It Fl C Suppress the validation of checksums. .It Fl v Verbose. Dump all headers, not only begin and end headers. .El .Sh SEE ALSO .Xr zfs 8 .Sh AUTHORS This manual page is a .Xr mdoc 7 reimplementation of the .Tn OpenSolaris manual page .Em zstreamdump(1M) , modified and customized for .Fx and licensed under the .Tn Common Development and Distribution License .Pq Tn CDDL . .Pp The .Xr mdoc 7 implementation of this manual page was initially written by .An Martin Matuska Aq mm@FreeBSD.org . Index: head/gnu/usr.bin/binutils/addr2line/addr2line.1 =================================================================== --- head/gnu/usr.bin/binutils/addr2line/addr2line.1 (revision 235210) +++ head/gnu/usr.bin/binutils/addr2line/addr2line.1 (revision 235211) @@ -1,266 +1,266 @@ .\" $FreeBSD$ .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ADDR2LINE 1" .TH ADDR2LINE 1 "2010-10-30" "binutils-2.17.50" "GNU Development Tools" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -addr2line \- convert addresses into file names and line numbers. +addr2line \- convert addresses into file names and line numbers .SH "SYNOPSIS" .IX Header "SYNOPSIS" addr2line [\fB\-b\fR \fIbfdname\fR|\fB\-\-target=\fR\fIbfdname\fR] [\fB\-C\fR|\fB\-\-demangle\fR[=\fIstyle\fR]] [\fB\-e\fR \fIfilename\fR|\fB\-\-exe=\fR\fIfilename\fR] [\fB\-f\fR|\fB\-\-functions\fR] [\fB\-s\fR|\fB\-\-basename\fR] [\fB\-i\fR|\fB\-\-inlines\fR] [\fB\-j\fR|\fB\-\-section=\fR\fIname\fR] [\fB\-H\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [addr addr ...] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBaddr2line\fR translates addresses into file names and line numbers. Given an address in an executable or an offset in a section of a relocatable object, it uses the debugging information to figure out which file name and line number are associated with it. .PP The executable or relocatable object to use is specified with the \fB\-e\fR option. The default is the file \fIa.out\fR. The section in the relocatable object to use is specified with the \fB\-j\fR option. .PP \&\fBaddr2line\fR has two modes of operation. .PP In the first, hexadecimal addresses are specified on the command line, and \fBaddr2line\fR displays the file name and line number for each address. .PP In the second, \fBaddr2line\fR reads hexadecimal addresses from standard input, and prints the file name and line number for each address on standard output. In this mode, \fBaddr2line\fR may be used in a pipe to convert dynamically chosen addresses. .PP The format of the output is \fB\s-1FILENAME:LINENO\s0\fR. The file name and line number for each address is printed on a separate line. If the \&\fB\-f\fR option is used, then each \fB\s-1FILENAME:LINENO\s0\fR line is preceded by a \fB\s-1FUNCTIONNAME\s0\fR line which is the name of the function containing the address. .PP If the file name or function name can not be determined, \&\fBaddr2line\fR will print two question marks in their place. If the line number can not be determined, \fBaddr2line\fR will print 0. .SH "OPTIONS" .IX Header "OPTIONS" The long and short forms of options, shown here as alternatives, are equivalent. .IP "\fB\-b\fR \fIbfdname\fR" 4 .IX Item "-b bfdname" .PD 0 .IP "\fB\-\-target=\fR\fIbfdname\fR" 4 .IX Item "--target=bfdname" .PD Specify that the object-code format for the object files is \&\fIbfdname\fR. .IP "\fB\-C\fR" 4 .IX Item "-C" .PD 0 .IP "\fB\-\-demangle[=\fR\fIstyle\fR\fB]\fR" 4 .IX Item "--demangle[=style]" .PD Decode (\fIdemangle\fR) low-level symbol names into user-level names. Besides removing any initial underscore prepended by the system, this makes \*(C+ function names readable. Different compilers have different mangling styles. The optional demangling style argument can be used to choose an appropriate demangling style for your compiler. .IP "\fB\-e\fR \fIfilename\fR" 4 .IX Item "-e filename" .PD 0 .IP "\fB\-\-exe=\fR\fIfilename\fR" 4 .IX Item "--exe=filename" .PD Specify the name of the executable for which addresses should be translated. The default file is \fIa.out\fR. .IP "\fB\-f\fR" 4 .IX Item "-f" .PD 0 .IP "\fB\-\-functions\fR" 4 .IX Item "--functions" .PD Display function names as well as file and line number information. .IP "\fB\-s\fR" 4 .IX Item "-s" .PD 0 .IP "\fB\-\-basenames\fR" 4 .IX Item "--basenames" .PD Display only the base of each file name. .IP "\fB\-i\fR" 4 .IX Item "-i" .PD 0 .IP "\fB\-\-inlines\fR" 4 .IX Item "--inlines" .PD If the address belongs to a function that was inlined, the source information for all enclosing scopes back to the first non-inlined function will also be printed. For example, if \f(CW\*(C`main\*(C'\fR inlines \&\f(CW\*(C`callee1\*(C'\fR which inlines \f(CW\*(C`callee2\*(C'\fR, and address is from \&\f(CW\*(C`callee2\*(C'\fR, the source information for \f(CW\*(C`callee1\*(C'\fR and \f(CW\*(C`main\*(C'\fR will also be printed. .IP "\fB\-j\fR" 4 .IX Item "-j" .PD 0 .IP "\fB\-\-section\fR" 4 .IX Item "--section" .PD Read offsets relative to the specified section instead of absolute addresses. .IP "\fB@\fR\fIfile\fR" 4 .IX Item "@file" Read command-line options from \fIfile\fR. The options read are inserted in place of the original @\fIfile\fR option. If \fIfile\fR does not exist, or cannot be read, then the option will be treated literally, and not removed. .Sp Options in \fIfile\fR are separated by whitespace. A whitespace character may be included in an option by surrounding the entire option in either single or double quotes. Any character (including a backslash) may be included by prefixing the character to be included with a backslash. The \fIfile\fR may itself contain additional @\fIfile\fR options; any such options will be processed recursively. .SH "SEE ALSO" .IX Header "SEE ALSO" Info entries for \fIbinutils\fR. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. .PP Permission is granted to copy, distribute and/or modify this document under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R". Index: head/gnu/usr.bin/binutils/ranlib/ranlib.1 =================================================================== --- head/gnu/usr.bin/binutils/ranlib/ranlib.1 (revision 235210) +++ head/gnu/usr.bin/binutils/ranlib/ranlib.1 (revision 235211) @@ -1,189 +1,189 @@ .\" $FreeBSD$ .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "RANLIB 1" .TH RANLIB 1 "2010-10-30" "binutils-2.17.50" "GNU Development Tools" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -ranlib \- generate index to archive. +ranlib \- generate index to archive .SH "SYNOPSIS" .IX Header "SYNOPSIS" ranlib [\fB\-vV\fR] \fIarchive\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBranlib\fR generates an index to the contents of an archive and stores it in the archive. The index lists each symbol defined by a member of an archive that is a relocatable object file. .PP You may use \fBnm \-s\fR or \fBnm \-\-print\-armap\fR to list this index. .PP An archive with such an index speeds up linking to the library and allows routines in the library to call each other without regard to their placement in the archive. .PP The \s-1GNU\s0 \fBranlib\fR program is another form of \s-1GNU\s0 \fBar\fR; running \&\fBranlib\fR is completely equivalent to executing \fBar \-s\fR. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-v\fR" 4 .IX Item "-v" .PD 0 .IP "\fB\-V\fR" 4 .IX Item "-V" .IP "\fB\-\-version\fR" 4 .IX Item "--version" .PD Show the version number of \fBranlib\fR. .IP "\fB@\fR\fIfile\fR" 4 .IX Item "@file" Read command-line options from \fIfile\fR. The options read are inserted in place of the original @\fIfile\fR option. If \fIfile\fR does not exist, or cannot be read, then the option will be treated literally, and not removed. .Sp Options in \fIfile\fR are separated by whitespace. A whitespace character may be included in an option by surrounding the entire option in either single or double quotes. Any character (including a backslash) may be included by prefixing the character to be included with a backslash. The \fIfile\fR may itself contain additional @\fIfile\fR options; any such options will be processed recursively. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIar\fR\|(1), \fInm\fR\|(1), and the Info entries for \fIbinutils\fR. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. .PP Permission is granted to copy, distribute and/or modify this document under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R". Index: head/gnu/usr.bin/binutils/size/size.1 =================================================================== --- head/gnu/usr.bin/binutils/size/size.1 (revision 235210) +++ head/gnu/usr.bin/binutils/size/size.1 (revision 235211) @@ -1,263 +1,263 @@ .\" $FreeBSD$ .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "SIZE 1" .TH SIZE 1 "2010-10-30" "binutils-2.17.50" "GNU Development Tools" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -size \- list section sizes and total size. +size \- list section sizes and total size .SH "SYNOPSIS" .IX Header "SYNOPSIS" size [\fB\-A\fR|\fB\-B\fR|\fB\-\-format=\fR\fIcompatibility\fR] [\fB\-\-help\fR] [\fB\-d\fR|\fB\-o\fR|\fB\-x\fR|\fB\-\-radix=\fR\fInumber\fR] [\fB\-t\fR|\fB\-\-totals\fR] [\fB\-\-target=\fR\fIbfdname\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fIobjfile\fR...] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \s-1GNU\s0 \fBsize\fR utility lists the section sizes\-\-\-and the total size\-\-\-for each of the object or archive files \fIobjfile\fR in its argument list. By default, one line of output is generated for each object file or each module in an archive. .PP \&\fIobjfile\fR... are the object files to be examined. If none are specified, the file \f(CW\*(C`a.out\*(C'\fR will be used. .SH "OPTIONS" .IX Header "OPTIONS" The command line options have the following meanings: .IP "\fB\-A\fR" 4 .IX Item "-A" .PD 0 .IP "\fB\-B\fR" 4 .IX Item "-B" .IP "\fB\-\-format=\fR\fIcompatibility\fR" 4 .IX Item "--format=compatibility" .PD Using one of these options, you can choose whether the output from \s-1GNU\s0 \&\fBsize\fR resembles output from System V \fBsize\fR (using \fB\-A\fR, or \fB\-\-format=sysv\fR), or Berkeley \fBsize\fR (using \fB\-B\fR, or \&\fB\-\-format=berkeley\fR). The default is the one-line format similar to Berkeley's. .Sp Here is an example of the Berkeley (default) format of output from \&\fBsize\fR: .Sp .Vb 4 \& $ size \-\-format=Berkeley ranlib size \& text data bss dec hex filename \& 294880 81920 11592 388392 5ed28 ranlib \& 294880 81920 11888 388688 5ee50 size .Ve .Sp This is the same data, but displayed closer to System V conventions: .Sp .Vb 7 \& $ size \-\-format=SysV ranlib size \& ranlib : \& section size addr \& .text 294880 8192 \& .data 81920 303104 \& .bss 11592 385024 \& Total 388392 \& \& \& size : \& section size addr \& .text 294880 8192 \& .data 81920 303104 \& .bss 11888 385024 \& Total 388688 .Ve .IP "\fB\-\-help\fR" 4 .IX Item "--help" Show a summary of acceptable arguments and options. .IP "\fB\-d\fR" 4 .IX Item "-d" .PD 0 .IP "\fB\-o\fR" 4 .IX Item "-o" .IP "\fB\-x\fR" 4 .IX Item "-x" .IP "\fB\-\-radix=\fR\fInumber\fR" 4 .IX Item "--radix=number" .PD Using one of these options, you can control whether the size of each section is given in decimal (\fB\-d\fR, or \fB\-\-radix=10\fR); octal (\fB\-o\fR, or \fB\-\-radix=8\fR); or hexadecimal (\fB\-x\fR, or \&\fB\-\-radix=16\fR). In \fB\-\-radix=\fR\fInumber\fR, only the three values (8, 10, 16) are supported. The total size is always given in two radices; decimal and hexadecimal for \fB\-d\fR or \fB\-x\fR output, or octal and hexadecimal if you're using \fB\-o\fR. .IP "\fB\-t\fR" 4 .IX Item "-t" .PD 0 .IP "\fB\-\-totals\fR" 4 .IX Item "--totals" .PD Show totals of all objects listed (Berkeley format listing mode only). .IP "\fB\-\-target=\fR\fIbfdname\fR" 4 .IX Item "--target=bfdname" Specify that the object-code format for \fIobjfile\fR is \&\fIbfdname\fR. This option may not be necessary; \fBsize\fR can automatically recognize many formats. .IP "\fB\-V\fR" 4 .IX Item "-V" .PD 0 .IP "\fB\-\-version\fR" 4 .IX Item "--version" .PD Display the version number of \fBsize\fR. .IP "\fB@\fR\fIfile\fR" 4 .IX Item "@file" Read command-line options from \fIfile\fR. The options read are inserted in place of the original @\fIfile\fR option. If \fIfile\fR does not exist, or cannot be read, then the option will be treated literally, and not removed. .Sp Options in \fIfile\fR are separated by whitespace. A whitespace character may be included in an option by surrounding the entire option in either single or double quotes. Any character (including a backslash) may be included by prefixing the character to be included with a backslash. The \fIfile\fR may itself contain additional @\fIfile\fR options; any such options will be processed recursively. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIar\fR\|(1), \fIobjdump\fR\|(1), \fIreadelf\fR\|(1), and the Info entries for \fIbinutils\fR. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. .PP Permission is granted to copy, distribute and/or modify this document under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R". Index: head/gnu/usr.bin/binutils/strip/strip.1 =================================================================== --- head/gnu/usr.bin/binutils/strip/strip.1 (revision 235210) +++ head/gnu/usr.bin/binutils/strip/strip.1 (revision 235211) @@ -1,392 +1,392 @@ .\" $FreeBSD$ .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "STRIP 1" .TH STRIP 1 "2010-10-30" "binutils-2.17.50" "GNU Development Tools" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -strip \- Discard symbols from object files. +strip \- Discard symbols from object files .SH "SYNOPSIS" .IX Header "SYNOPSIS" strip [\fB\-F\fR \fIbfdname\fR |\fB\-\-target=\fR\fIbfdname\fR] [\fB\-I\fR \fIbfdname\fR |\fB\-\-input\-target=\fR\fIbfdname\fR] [\fB\-O\fR \fIbfdname\fR |\fB\-\-output\-target=\fR\fIbfdname\fR] [\fB\-s\fR|\fB\-\-strip\-all\fR] [\fB\-S\fR|\fB\-g\fR|\fB\-d\fR|\fB\-\-strip\-debug\fR] [\fB\-K\fR \fIsymbolname\fR |\fB\-\-keep\-symbol=\fR\fIsymbolname\fR] [\fB\-N\fR \fIsymbolname\fR |\fB\-\-strip\-symbol=\fR\fIsymbolname\fR] [\fB\-w\fR|\fB\-\-wildcard\fR] [\fB\-x\fR|\fB\-\-discard\-all\fR] [\fB\-X\fR |\fB\-\-discard\-locals\fR] [\fB\-R\fR \fIsectionname\fR |\fB\-\-remove\-section=\fR\fIsectionname\fR] [\fB\-o\fR \fIfile\fR] [\fB\-p\fR|\fB\-\-preserve\-dates\fR] [\fB\-\-keep\-file\-symbols\fR] [\fB\-\-only\-keep\-debug\fR] [\fB\-v\fR |\fB\-\-verbose\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-\-help\fR] [\fB\-\-info\fR] \fIobjfile\fR... .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\s-1GNU\s0 \fBstrip\fR discards all symbols from object files \&\fIobjfile\fR. The list of object files may include archives. At least one object file must be given. .PP \&\fBstrip\fR modifies the files named in its argument, rather than writing modified copies under different names. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-F\fR \fIbfdname\fR" 4 .IX Item "-F bfdname" .PD 0 .IP "\fB\-\-target=\fR\fIbfdname\fR" 4 .IX Item "--target=bfdname" .PD Treat the original \fIobjfile\fR as a file with the object code format \fIbfdname\fR, and rewrite it in the same format. .IP "\fB\-\-help\fR" 4 .IX Item "--help" Show a summary of the options to \fBstrip\fR and exit. .IP "\fB\-\-info\fR" 4 .IX Item "--info" Display a list showing all architectures and object formats available. .IP "\fB\-I\fR \fIbfdname\fR" 4 .IX Item "-I bfdname" .PD 0 .IP "\fB\-\-input\-target=\fR\fIbfdname\fR" 4 .IX Item "--input-target=bfdname" .PD Treat the original \fIobjfile\fR as a file with the object code format \fIbfdname\fR. .IP "\fB\-O\fR \fIbfdname\fR" 4 .IX Item "-O bfdname" .PD 0 .IP "\fB\-\-output\-target=\fR\fIbfdname\fR" 4 .IX Item "--output-target=bfdname" .PD Replace \fIobjfile\fR with a file in the output format \fIbfdname\fR. .IP "\fB\-R\fR \fIsectionname\fR" 4 .IX Item "-R sectionname" .PD 0 .IP "\fB\-\-remove\-section=\fR\fIsectionname\fR" 4 .IX Item "--remove-section=sectionname" .PD Remove any section named \fIsectionname\fR from the output file. This option may be given more than once. Note that using this option inappropriately may make the output file unusable. .IP "\fB\-s\fR" 4 .IX Item "-s" .PD 0 .IP "\fB\-\-strip\-all\fR" 4 .IX Item "--strip-all" .PD Remove all symbols. .IP "\fB\-g\fR" 4 .IX Item "-g" .PD 0 .IP "\fB\-S\fR" 4 .IX Item "-S" .IP "\fB\-d\fR" 4 .IX Item "-d" .IP "\fB\-\-strip\-debug\fR" 4 .IX Item "--strip-debug" .PD Remove debugging symbols only. .IP "\fB\-\-strip\-unneeded\fR" 4 .IX Item "--strip-unneeded" Remove all symbols that are not needed for relocation processing. .IP "\fB\-K\fR \fIsymbolname\fR" 4 .IX Item "-K symbolname" .PD 0 .IP "\fB\-\-keep\-symbol=\fR\fIsymbolname\fR" 4 .IX Item "--keep-symbol=symbolname" .PD When stripping symbols, keep symbol \fIsymbolname\fR even if it would normally be stripped. This option may be given more than once. .IP "\fB\-N\fR \fIsymbolname\fR" 4 .IX Item "-N symbolname" .PD 0 .IP "\fB\-\-strip\-symbol=\fR\fIsymbolname\fR" 4 .IX Item "--strip-symbol=symbolname" .PD Remove symbol \fIsymbolname\fR from the source file. This option may be given more than once, and may be combined with strip options other than \&\fB\-K\fR. .IP "\fB\-o\fR \fIfile\fR" 4 .IX Item "-o file" Put the stripped output in \fIfile\fR, rather than replacing the existing file. When this argument is used, only one \fIobjfile\fR argument may be specified. .IP "\fB\-p\fR" 4 .IX Item "-p" .PD 0 .IP "\fB\-\-preserve\-dates\fR" 4 .IX Item "--preserve-dates" .PD Preserve the access and modification dates of the file. .IP "\fB\-w\fR" 4 .IX Item "-w" .PD 0 .IP "\fB\-\-wildcard\fR" 4 .IX Item "--wildcard" .PD Permit regular expressions in \fIsymbolname\fRs used in other command line options. The question mark (?), asterisk (*), backslash (\e) and square brackets ([]) operators can be used anywhere in the symbol name. If the first character of the symbol name is the exclamation point (!) then the sense of the switch is reversed for that symbol. For example: .Sp .Vb 1 \& \-w \-K !foo \-K fo* .Ve .Sp would cause strip to only keep symbols that start with the letters \&\*(L"fo\*(R", but to discard the symbol \*(L"foo\*(R". .IP "\fB\-x\fR" 4 .IX Item "-x" .PD 0 .IP "\fB\-\-discard\-all\fR" 4 .IX Item "--discard-all" .PD Remove non-global symbols. .IP "\fB\-X\fR" 4 .IX Item "-X" .PD 0 .IP "\fB\-\-discard\-locals\fR" 4 .IX Item "--discard-locals" .PD Remove compiler-generated local symbols. (These usually start with \fBL\fR or \fB.\fR.) .IP "\fB\-\-keep\-file\-symbols\fR" 4 .IX Item "--keep-file-symbols" When stripping a file, perhaps with \fB\-\-strip\-debug\fR or \&\fB\-\-strip\-unneeded\fR, retain any symbols specifying source file names, which would otherwise get stripped. .IP "\fB\-\-only\-keep\-debug\fR" 4 .IX Item "--only-keep-debug" Strip a file, removing contents of any sections that would not be stripped by \fB\-\-strip\-debug\fR and leaving the debugging sections intact. In \s-1ELF\s0 files, this preserves all note sections in the output. .Sp The intention is that this option will be used in conjunction with \&\fB\-\-add\-gnu\-debuglink\fR to create a two part executable. One a stripped binary which will occupy less space in \s-1RAM\s0 and in a distribution and the second a debugging information file which is only needed if debugging abilities are required. The suggested procedure to create these files is as follows: .RS 4 .IP "1." 4 .IX Item "1." \&\f(CW\*(C`foo\*(C'\fR then... .ie n .IP "1." 4 .el .IP "1." 4 .IX Item "1." create a file containing the debugging info. .ie n .IP "1." 4 .el .IP "1." 4 .IX Item "1." stripped executable. .ie n .IP "1." 4 .el .IP "1." 4 .IX Item "1." to add a link to the debugging info into the stripped executable. .RE .RS 4 .Sp Note \- the choice of \f(CW\*(C`.dbg\*(C'\fR as an extension for the debug info file is arbitrary. Also the \f(CW\*(C`\-\-only\-keep\-debug\*(C'\fR step is optional. You could instead do this: .IP "1." 4 .IX Item "1." .PD 0 .ie n .IP "1." 4 .el .IP "1." 4 .IX Item "1." .ie n .IP "1." 4 .el .IP "1." 4 .IX Item "1." .ie n .IP "1." 4 .el .IP "1." 4 .IX Item "1." .RE .RS 4 .PD .Sp ie the file pointed to by the \fB\-\-add\-gnu\-debuglink\fR can be the full executable. It does not have to be a file created by the \&\fB\-\-only\-keep\-debug\fR switch. .Sp Note \- this switch is only intended for use on fully linked files. It does not make sense to use it on object files where the debugging information may be incomplete. Besides the gnu_debuglink feature currently only supports the presence of one filename containing debugging information, not multiple filenames on a one-per-object-file basis. .RE .IP "\fB\-V\fR" 4 .IX Item "-V" .PD 0 .IP "\fB\-\-version\fR" 4 .IX Item "--version" .PD Show the version number for \fBstrip\fR. .IP "\fB\-v\fR" 4 .IX Item "-v" .PD 0 .IP "\fB\-\-verbose\fR" 4 .IX Item "--verbose" .PD Verbose output: list all object files modified. In the case of archives, \fBstrip \-v\fR lists all members of the archive. .IP "\fB@\fR\fIfile\fR" 4 .IX Item "@file" Read command-line options from \fIfile\fR. The options read are inserted in place of the original @\fIfile\fR option. If \fIfile\fR does not exist, or cannot be read, then the option will be treated literally, and not removed. .Sp Options in \fIfile\fR are separated by whitespace. A whitespace character may be included in an option by surrounding the entire option in either single or double quotes. Any character (including a backslash) may be included by prefixing the character to be included with a backslash. The \fIfile\fR may itself contain additional @\fIfile\fR options; any such options will be processed recursively. .SH "SEE ALSO" .IX Header "SEE ALSO" the Info entries for \fIbinutils\fR. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. .PP Permission is granted to copy, distribute and/or modify this document under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R". Index: head/gnu/usr.bin/gdb/gdb/gdb.1 =================================================================== --- head/gnu/usr.bin/gdb/gdb/gdb.1 (revision 235210) +++ head/gnu/usr.bin/gdb/gdb/gdb.1 (revision 235211) @@ -1,371 +1,371 @@ .\" Copyright (c) 1991 Free Software Foundation .\" See section COPYING for conditions for redistribution .\" $FreeBSD$ .TH gdb 1 "4nov1991" "GNU Tools" "GNU Tools" .SH NAME gdb \- The GNU Debugger .SH SYNOPSIS .na .TP .B gdb .RB "[\|" \-help "\|]" .RB "[\|" \-nx "\|]" .RB "[\|" \-q "\|]" .RB "[\|" \-batch "\|]" .RB "[\|" \-cd=\c .I dir\c \|] .RB "[\|" \-f "\|]" .RB "[\|" "\-b\ "\c .IR bps "\|]" .RB "[\|" "\-tty="\c .IR dev "\|]" .RB "[\|" "\-s "\c .I symfile\c \&\|] .RB "[\|" "\-e "\c .I prog\c \&\|] .RB "[\|" "\-se "\c .I prog\c \&\|] .RB "[\|" "\-c "\c .I core\c \&\|] .RB "[\|" "\-x "\c .I cmds\c \&\|] .RB "[\|" "\-d "\c .I dir\c \&\|] .RB "[\|" \c .I prog\c .RB "[\|" \c .IR core \||\| procID\c \&\|]\&\|] .ad b .SH DESCRIPTION The purpose of a debugger such as GDB is to allow you to see what is going on ``inside'' another program while it executes\(em\&or what another program was doing at the moment it crashed. GDB can do four main kinds of things (plus other things in support of these) to help you catch bugs in the act: .TP \ \ \ \(bu Start your program, specifying anything that might affect its behavior. .TP \ \ \ \(bu Make your program stop on specified conditions. .TP \ \ \ \(bu Examine what has happened, when your program has stopped. .TP \ \ \ \(bu Change things in your program, so you can experiment with correcting the effects of one bug and go on to learn about another. .PP You can use GDB to debug programs written in C, C++, and Modula-2. Fortran support will be added when a GNU Fortran compiler is ready. GDB is invoked with the shell command \c .B gdb\c \&. Once started, it reads commands from the terminal until you tell it to exit with the GDB command \c .B quit\c \&. You can get online help from \c .B gdb\c \& itself by using the command \c .B help\c \&. You can run \c .B gdb\c \& with no arguments or options; but the most usual way to start GDB is with one argument or two, specifying an executable program as the argument: .sp .br gdb\ program .br .sp You can also start with both an executable program and a core file specified: .sp .br gdb\ program\ core .br .sp You can, instead, specify a process ID as a second argument, if you want to debug a running process: .sp .br gdb\ program\ 1234 .br .sp would attach GDB to process \c .B 1234\c \& (unless you also have a file named `\|\c .B 1234\c \&\|'; GDB does check for a core file first). Here are some of the most frequently needed GDB commands: .TP .B break \fR[\|\fIfile\fB:\fR\|]\fIfunction \& Set a breakpoint at \c .I function\c \& (in \c .I file\c \&). .TP .B run \fR[\|\fIarglist\fR\|] Start your program (with \c .I arglist\c \&, if specified). .TP .B bt Backtrace: display the program stack. .TP .BI print " expr"\c \& Display the value of an expression. .TP .B c Continue running your program (after stopping, e.g. at a breakpoint). .TP .B next Execute next program line (after stopping); step \c .I over\c \& any function calls in the line. .TP .B step Execute next program line (after stopping); step \c .I into\c \& any function calls in the line. .TP .B help \fR[\|\fIname\fR\|] Show information about GDB command \c .I name\c \&, or general information about using GDB. .TP .B quit Exit from GDB. .PP For full details on GDB, see \c .I Using GDB: A Guide to the GNU Source-Level Debugger\c \&, by Richard M. Stallman and Roland H. Pesch. The same text is available online as the \c .B gdb\c \& entry in the \c .B info\c \& program. .SH OPTIONS Any arguments other than options specify an executable file and core file (or process ID); that is, the first argument encountered with no associated option flag is equivalent to a `\|\c .B \-se\c \&\|' option, and the second, if any, is equivalent to a `\|\c .B \-c\c \&\|' option if it's the name of a file. Many options have both long and short forms; both are shown here. The long forms are also recognized if you truncate them, so long as enough of the option is present to be unambiguous. (If you prefer, you can flag option arguments with `\|\c .B +\c \&\|' rather than `\|\c .B \-\c \&\|', though we illustrate the more usual convention.) All the options and command line arguments you give are processed in sequential order. The order makes a difference when the `\|\c .B \-x\c \&\|' option is used. .TP .B \-help .TP .B \-h List all options, with brief explanations. .TP .BI "\-symbols=" "file"\c .TP .BI "\-s " "file"\c \& Read symbol table from file \c .I file\c \&. .TP .BI "\-exec=" "file"\c .TP .BI "\-e " "file"\c \& Use file \c .I file\c \& as the executable file to execute when appropriate, and for examining pure data in conjunction with a core dump. .TP .BI "\-se=" "file"\c \& Read symbol table from file \c .I file\c \& and use it as the executable file. .TP .BI "\-core=" "file"\c .TP .BI "\-c " "file"\c \& Use file \c .I file\c \& as a core dump to examine. .TP .BI "\-command=" "file"\c .TP .BI "\-x " "file"\c \& Execute GDB commands from file \c .I file\c \&. .TP .BI "\-directory=" "directory"\c .TP .BI "\-d " "directory"\c \& Add \c .I directory\c \& to the path to search for source files. .PP .TP .B \-nx .TP .B \-n Do not execute commands from any `\|\c .B .gdbinit\c \&\|' initialization files. Normally, the commands in these files are executed after all the command options and arguments have been processed. .TP .B \-quiet .TP .B \-q ``Quiet''. Do not print the introductory and copyright messages. These messages are also suppressed in batch mode. .TP .B \-batch Run in batch mode. Exit with status \c .B 0\c \& after processing all the command files specified with `\|\c .B \-x\c \&\|' (and `\|\c .B .gdbinit\c \&\|', if not inhibited). Exit with nonzero status if an error occurs in executing the GDB commands in the command files. Batch mode may be useful for running GDB as a filter, for example to download and run a program on another computer; in order to make this more useful, the message .sp .br Program\ exited\ normally. .br .sp (which is ordinarily issued whenever a program running under GDB control terminates) is not issued when running in batch mode. .TP .BI "\-cd=" "directory"\c \& Run GDB using \c .I directory\c \& as its working directory, instead of the current directory. .TP .B \-fullname .TP .B \-f Emacs sets this option when it runs GDB as a subprocess. It tells GDB to output the full file name and line number in a standard, recognizable fashion each time a stack frame is displayed (which includes each time the program stops). This recognizable format looks like two `\|\c -.B \032\c +.B \e032\c \&\|' characters, followed by the file name, line number and character position separated by colons, and a newline. The Emacs-to-GDB interface program uses the two `\|\c -.B \032\c +.B \e032\c \&\|' characters as a signal to display the source code for the frame. .TP .BI "\-b " "bps"\c \& Set the line speed (baud rate or bits per second) of any serial interface used by GDB for remote debugging. .TP .BI "\-tty=" "device"\c \& Run using \c .I device\c \& for your program's standard input and output. .PP .SH "SEE ALSO" .RB "`\|" gdb "\|'" entry in .B info\c \&; .I Using GDB: A Guide to the GNU Source-Level Debugger\c , Richard M. Stallman and Roland H. Pesch, July 1991. .SH COPYING Copyright (c) 1991 Free Software Foundation, Inc. .PP Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. .PP Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. .PP Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be included in translations approved by the Free Software Foundation instead of in the original English. Index: head/sbin/md5/md5.1 =================================================================== --- head/sbin/md5/md5.1 (revision 235210) +++ head/sbin/md5/md5.1 (revision 235211) @@ -1,149 +1,149 @@ .\" $FreeBSD$ .Dd September 7, 2008 .Dt MD5 1 .Os .Sh NAME -.Nm md5 , sha1 , sha256, rmd160 +.Nm md5 , sha1 , sha256 , rmd160 .Nd calculate a message-digest fingerprint (checksum) for a file .Sh SYNOPSIS .Nm md5 .Op Fl pqrtx .Op Fl c Ar string .Op Fl s Ar string .Op Ar .Nm sha1 .Op Fl pqrtx .Op Fl c Ar string .Op Fl s Ar string .Op Ar .Nm sha256 .Op Fl pqrtx .Op Fl c Ar string .Op Fl s Ar string .Op Ar .Nm rmd160 .Op Fl pqrtx .Op Fl c Ar string .Op Fl s Ar string .Op Ar .Sh DESCRIPTION The .Nm md5 , sha1 , sha256 and .Nm rmd160 utilities take as input a message of arbitrary length and produce as output a .Dq fingerprint or .Dq message digest of the input. It is conjectured that it is computationally infeasible to produce two messages having the same message digest, or to produce any message having a given prespecified target message digest. The .Tn MD5 , SHA-1 , SHA-256 and .Tn RIPEMD-160 algorithms are intended for digital signature applications, where a large file must be .Dq compressed in a secure manner before being encrypted with a private (secret) key under a public-key cryptosystem such as .Tn RSA . .Pp .Tn MD5 has been completely broken as far as finding collisions is concerned, and should not be relied upon to produce unique outputs. This also means that .Tn MD5 should not be used as part of a cryptographic signature scheme. At the current time (2009-01-06) there is no publicly known method to .Dq reverse MD5, i.e., to find an input given a hash value. .Pp .Tn SHA-1 currently (2009-01-06) has no known collisions, but an attack has been found which is faster than a brute-force search, placing the security of .Tn SHA-1 in doubt. .Pp It is recommended that all new applications use .Tn SHA-256 instead of one of the other hash functions. .Pp The following options may be used in any combination and must precede any files named on the command line. The hexadecimal checksum of each file listed on the command line is printed after the options are processed. .Bl -tag -width indent .It Fl c Ar string Compare files to this md5 string. (Note that this option is not yet useful if multiple files are specified.) .It Fl s Ar string Print a checksum of the given .Ar string . .It Fl p Echo stdin to stdout and append the checksum to stdout. .It Fl q Quiet mode - only the checksum is printed out. Overrides the .Fl r option. .It Fl r Reverses the format of the output. This helps with visual diffs. Does nothing when combined with the .Fl ptx options. .It Fl t Run a built-in time trial. .It Fl x Run a built-in test script. .El .Sh EXIT STATUS The .Nm md5 , sha1 , sha256 and .Nm rmd160 utilities exit 0 on success, 1 if at least one of the input files could not be read, and 2 if at least one file does not have the same hash as the -c option. .Sh SEE ALSO .Xr cksum 1 , .Xr md5 3 , .Xr ripemd 3 , .Xr sha 3 , .Xr sha256 3 .Rs .%A R. Rivest .%T The MD5 Message-Digest Algorithm .%O RFC1321 .Re .Rs .%A J. Burrows .%T The Secure Hash Standard .%O FIPS PUB 180-2 .Re .Rs .%A D. Eastlake and P. Jones .%T US Secure Hash Algorithm 1 .%O RFC 3174 .Re .Pp RIPEMD-160 is part of the ISO draft standard .Qq ISO/IEC DIS 10118-3 on dedicated hash functions. .Pp Secure Hash Standard (SHS): .Pa http://csrc.nist.gov/cryptval/shs.html . .Pp The RIPEMD-160 page: .Pa http://www.esat.kuleuven.ac.be/~bosselae/ripemd160.html . .Sh ACKNOWLEDGMENTS This program is placed in the public domain for free general use by RSA Data Security. .Pp Support for SHA-1 and RIPEMD-160 has been added by .An Oliver Eikemeier Aq eik@FreeBSD.org . Index: head/usr.bin/calendar/calendar.1 =================================================================== --- head/usr.bin/calendar/calendar.1 (revision 235210) +++ head/usr.bin/calendar/calendar.1 (revision 235211) @@ -1,327 +1,327 @@ .\" Copyright (c) 1989, 1990, 1993 .\" The Regents of the University of California. 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. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. .\" .\" @(#)calendar.1 8.1 (Berkeley) 6/29/93 .\" $FreeBSD$ .\" .Dd June 13, 2002 .Dt CALENDAR 1 .Os .Sh NAME .Nm calendar .Nd reminder service .Sh SYNOPSIS .Nm .Op Fl A Ar num .Op Fl a .Op Fl B Ar num .Op Fl D Ar moon|sun .Op Fl d .Op Fl F Ar friday .Op Fl f Ar calendarfile .Op Fl l Ar longitude .Oo .Bk -words .Fl t Ar dd Ns .Sm off .Op . Ar mm Op . Ar year .Sm on .Ek .Oc .Op Fl U Ar UTC-offset .Op Fl W Ar num .Sh DESCRIPTION The .Nm utility checks the current directory for a file named .Pa calendar and displays lines that fall into the specified date range. On the day before a weekend (normally Friday), events for the next three days are displayed. .Pp The following options are available: .Bl -tag -width Ds .It Fl A Ar num Print lines from today and the next .Ar num days (forward, future). .It Fl a Process the ``calendar'' files of all users and mail the results to them. This requires super-user privileges. .It Fl B Ar num Print lines from today and the previous .Ar num days (backward, past). .It Fl D Ar moon|sun Print UTC offset, longitude and moon or sun information. .It Fl d Debug option: print current date information. .It Fl F Ar friday Specify which day of the week is ``Friday'' (the day before the weekend begins). Default is 5. .It Fl f Pa calendarfile Use .Pa calendarfile as the default calendar file. .It Fl l Ar longitude Perform lunar and solar calculations from this longitude. If neither longitude nor UTC offset is specified, the calculations will be based on the difference between UTC time and localtime. If both are specified, UTC offset overrides longitude. .It Xo Fl t .Sm off .Ar dd .Op . Ar mm Op . Ar year .Sm on .Xc For test purposes only: set date directly to argument values. .It Fl U Ar UTC-offset Perform lunar and solar calculations from this UTC offset. If neither UTC offset nor longitude is specified, the calculations will be based on the difference between UTC time and localtime. If both are specified, UTC offset overrides longitude. .It Fl W Ar num Print lines from today and the next .Ar num days (forward, future). Ignore weekends when calculating the number of days. .El .Sh FILE FORMAT To handle calendars in your national code table you can specify .Dq LANG= in the calendar file as early as possible. .Pp To handle the local name of sequences, you can specify them as: .Dq SEQUENCE= in the calendar file as early as possible. .Pp The names of the following special days are recognized: .Bl -tag -width 123456789012345 -compact .It Easter Catholic Easter. .It Paskha Orthodox Easter. .It NewMoon The lunar New Moon. .It FullMoon The lunar Full Moon. .It MarEquinox The solar equinox in March. .It JunSolstice The solar solstice in June. .It SepEquinox The solar equinox in September. .It DecSolstice The solar solstice in December. .It ChineseNewYear The first day of the Chinese year. .El These names may be reassigned to their local names via an assignment like .Dq Easter=Pasen in the calendar file. .Pp Other lines should begin with a month and day. They may be entered in almost any format, either numeric or as character strings. If the proper locale is set, national month and weekday names can be used. A single asterisk (``*'') matches every month. A day without a month matches that day of every week. A month without a day matches the first of that month. Two numbers default to the month followed by the day. Lines with leading tabs default to the last entered date, allowing multiple line specifications for a single date. .Pp The names of the recognized special days may be followed by a positive or negative integer, like: .Dq Easter+3 or .Dq Paskha-4 . .Pp Weekdays may be followed by ``-4'' ...\& ``+5'' (aliases for last, first, second, third, fourth) for moving events like ``the last Monday in April''. .Pp By convention, dates followed by an asterisk are not fixed, i.e., change from year to year. .Pp Day descriptions start after the first character in the line; if the line does not contain a character, it is not displayed. If the first character in the line is a character, it is treated as a continuation of the previous line. .Pp The ``calendar'' file is preprocessed by .Xr cpp 1 , allowing the inclusion of shared files such as lists of company holidays or meetings. If the shared file is not referenced by a full pathname, .Xr cpp 1 searches in the current (or home) directory first, and then in the directory .Pa /usr/share/calendar . Empty lines and lines protected by the C commenting syntax .Pq Li /* ... */ are ignored. .Pp Some possible calendar entries ( characters highlighted by \fB\et\fR sequence) .Bd -unfilled -offset indent LANG=C Easter=Ostern #include #include 6/15\fB\et\fRJune 15 (if ambiguous, will default to month/day). Jun. 15\fB\et\fRJune 15. 15 June\fB\et\fRJune 15. Thursday\fB\et\fREvery Thursday. June\fB\et\fREvery June 1st. 15 *\fB\et\fR15th of every month. 2010/4/15\fB\et\fR15 April 2010 May Sun+2\fB\et\fRsecond Sunday in May (Muttertag) 04/SunLast\fB\et\fRlast Sunday in April, \fB\et\fRsummer time in Europe Easter\fB\et\fREaster Ostern-2\fB\et\fRGood Friday (2 days before Easter) Paskha\fB\et\fROrthodox Easter .Ed .Sh FILES .Bl -tag -width calendar.christian -compact .It Pa calendar -file in current directory +file in current directory. .It Pa ~/.calendar .Pa calendar HOME directory. A chdir is done into this directory if it exists. .It Pa ~/.calendar/calendar calendar file to use if no calendar file exists in the current directory. .It Pa ~/.calendar/nomail do not send mail if this file exists. .El .Pp The following default calendar files are provided in .Pa /usr/share/calendars: .Pp .Bl -tag -width calendar.southafrica -compact .It Pa calendar.all File which includes all the default files. .It Pa calendar.australia Calendar of events in Australia. .It Pa calendar.birthday Births and deaths of famous (and not-so-famous) people. .It Pa calendar.christian Christian holidays. This calendar should be updated yearly by the local system administrator so that roving holidays are set correctly for the current year. .It Pa calendar.computer Days of special significance to computer people. .It Pa calendar.croatian Calendar of events in Croatia. .It Pa calendar.dutch Calendar of events in the Netherlands. .It Pa calendar.freebsd Birthdays of .Fx committers. .It Pa calendar.french Calendar of events in France. .It Pa calendar.german Calendar of events in Germany. .It Pa calendar.history Everything else, mostly U.S.\& historical events. .It Pa calendar.holiday Other holidays, including the not-well-known, obscure, and .Em really obscure. .It Pa calendar.judaic Jewish holidays. The entries for this calendar have been obtained from the port deskutils/hebcal. .It Pa calendar.music Musical events, births, and deaths. Strongly oriented toward rock 'n' roll. .It Pa calendar.newzealand Calendar of events in New Zealand. .It Pa calendar.russian Russian calendar. .It Pa calendar.southafrica Calendar of events in South Africa. .It Pa calendar.usholiday U.S.\& holidays. This calendar should be updated yearly by the local system administrator so that roving holidays are set correctly for the current year. .It Pa calendar.world Includes all calendar files except for national files. .El .Sh COMPATIBILITY The .Nm program previously selected lines which had the correct date anywhere in the line. This is no longer true, the date is only recognized when it occurs at the beginning of a line. .Sh SEE ALSO .Xr at 1 , .Xr cpp 1 , .Xr mail 1 , .Xr cron 8 .Sh HISTORY A .Nm command appeared in .At v7 . .Sh NOTES Chinese New Year is calculated at 120 degrees east of Greenwich, which roughly corresponds with the east coast of China. For people west of China, this might result that the start of Chinese New Year and the day of the related new moon might differ. .Pp The phases of the moon and the longitude of the sun are calculated against the local position which corresponds with 30 degrees times the time-difference towards Greenwich. .Pp The new and full moons are happening on the day indicated: They might happen in the time period in the early night or in the late evening. It doesn't indicate that they are starting in the night on that date. .Pp Because of minor differences between the output of the formulas used and other sources on the Internet, Druids and Werewolves should double-check the start and end time of solar and lunar events. .Sh BUGS The .Nm utility does not handle Jewish holidays. .Pp There is no possibility to properly specify the local position needed for solar and lunar calculations. Index: head/usr.bin/clang/clang/clang.1 =================================================================== --- head/usr.bin/clang/clang/clang.1 (revision 235210) +++ head/usr.bin/clang/clang/clang.1 (revision 235211) @@ -1,503 +1,503 @@ .\" $FreeBSD$ .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "CLANG 1" .TH CLANG 1 "2012-04-05" "clang 3.1" "Clang Tools Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" clang \- the Clang C, C++, and Objective\-C compiler .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBclang\fR [\fB\-c\fR|\fB\-S\fR|\fB\-E\fR] \fB\-std=\fR\fIstandard\fR \fB\-g\fR [\fB\-O0\fR|\fB\-O1\fR|\fB\-O2\fR|\fB\-Os\fR|\fB\-Oz\fR|\fB\-O3\fR|\fB\-O4\fR] \fB\-W\fR\fIwarnings...\fR \fB\-pedantic\fR \fB\-I\fR\fIdir...\fR \fB\-L\fR\fIdir...\fR \fB\-D\fR\fImacro[=defn]\fR \fB\-f\fR\fIfeature-option...\fR \fB\-m\fR\fImachine-option...\fR \fB\-o\fR \fIoutput-file\fR \fB\-stdlib=\fR\fIlibrary\fR \fIinput-filenames\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBclang\fR is a C, \*(C+, and Objective-C compiler which encompasses preprocessing, parsing, optimization, code generation, assembly, and linking. Depending on which high-level mode setting is passed, Clang will stop before doing a full link. While Clang is highly integrated, it is important to understand the stages of compilation, to understand how to invoke it. These stages are: .IP "\fBDriver\fR" 4 .IX Item "Driver" The \fBclang\fR executable is actually a small driver which controls the overall execution of other tools such as the compiler, assembler and linker. Typically you do not need to interact with the driver, but you transparently use it to run the other tools. .IP "\fBPreprocessing\fR" 4 .IX Item "Preprocessing" This stage handles tokenization of the input source file, macro expansion, #include expansion and handling of other preprocessor directives. The output of this stage is typically called a \*(L".i\*(R" (for C), \*(L".ii\*(R" (for \*(C+), \*(L".mi\*(R" (for Objective-C) , or \*(L".mii\*(R" (for Objective\-\*(C+) file. .IP "\fBParsing and Semantic Analysis\fR" 4 .IX Item "Parsing and Semantic Analysis" This stage parses the input file, translating preprocessor tokens into a parse tree. Once in the form of a parser tree, it applies semantic analysis to compute types for expressions as well and determine whether the code is well formed. This stage is responsible for generating most of the compiler warnings as well as parse errors. The output of this stage is an \*(L"Abstract Syntax Tree\*(R" (\s-1AST\s0). .IP "\fBCode Generation and Optimization\fR" 4 .IX Item "Code Generation and Optimization" This stage translates an \s-1AST\s0 into low-level intermediate code (known as \*(L"\s-1LLVM\s0 \&\s-1IR\s0\*(R") and ultimately to machine code. This phase is responsible for optimizing the generated code and handling target-specific code generation. The output of this stage is typically called a \*(L".s\*(R" file or \*(L"assembly\*(R" file. .Sp Clang also supports the use of an integrated assembler, in which the code generator produces object files directly. This avoids the overhead of generating the \*(L".s\*(R" file and of calling the target assembler. .IP "\fBAssembler\fR" 4 .IX Item "Assembler" This stage runs the target assembler to translate the output of the compiler into a target object file. The output of this stage is typically called a \*(L".o\*(R" file or \*(L"object\*(R" file. .IP "\fBLinker\fR" 4 .IX Item "Linker" This stage runs the target linker to merge multiple object files into an executable or dynamic library. The output of this stage is typically called an \&\*(L"a.out\*(R", \*(L".dylib\*(R" or \*(L".so\*(R" file. .PP The Clang compiler supports a large number of options to control each of these stages. In addition to compilation of code, Clang also supports other tools: .PP \&\fBClang Static Analyzer\fR .PP The Clang Static Analyzer is a tool that scans source code to try to find bugs through code analysis. This tool uses many parts of Clang and is built into the same driver. .SH "OPTIONS" .IX Header "OPTIONS" .SS "Stage Selection Options" .IX Subsection "Stage Selection Options" .IP "\fB\-E\fR" 4 .IX Item "-E" Run the preprocessor stage. .IP "\fB\-fsyntax\-only\fR" 4 .IX Item "-fsyntax-only" Run the preprocessor, parser and type checking stages. .IP "\fB\-S\fR" 4 .IX Item "-S" Run the previous stages as well as \s-1LLVM\s0 generation and optimization stages and target-specific code generation, producing an assembly file. .IP "\fB\-c\fR" 4 .IX Item "-c" Run all of the above, plus the assembler, generating a target \*(L".o\*(R" object file. .IP "\fBno stage selection option\fR" 4 .IX Item "no stage selection option" If no stage selection option is specified, all stages above are run, and the linker is run to combine the results into an executable or shared library. .IP "\fB\-\-analyze\fR" 4 .IX Item "--analyze" Run the Clang Static Analyzer. .SS "Language Selection and Mode Options" .IX Subsection "Language Selection and Mode Options" .IP "\fB\-x\fR \fIlanguage\fR" 4 .IX Item "-x language" Treat subsequent input files as having type \fIlanguage\fR. .IP "\fB\-std\fR=\fIlanguage\fR" 4 .IX Item "-std=language" Specify the language standard to compile for. .IP "\fB\-stdlib\fR=\fIlanguage\fR" 4 .IX Item "-stdlib=language" Specify the \*(C+ standard library to use; supported options are libstdc++ and libc++. .IP "\fB\-ansi\fR" 4 .IX Item "-ansi" Same as \fB\-std=c89\fR. .IP "\fB\-ObjC++\fR" 4 .IX Item "-ObjC++" Treat source input files as Objective\-\*(C+ inputs. .IP "\fB\-ObjC\fR" 4 .IX Item "-ObjC" Treat source input files as Objective-C inputs. .IP "\fB\-trigraphs\fR" 4 .IX Item "-trigraphs" Enable trigraphs. .IP "\fB\-ffreestanding\fR" 4 .IX Item "-ffreestanding" Indicate that the file should be compiled for a freestanding, not a hosted, environment. .IP "\fB\-fno\-builtin\fR" 4 .IX Item "-fno-builtin" Disable special handling and optimizations of builtin functions like strlen and malloc. .IP "\fB\-fmath\-errno\fR" 4 .IX Item "-fmath-errno" Indicate that math functions should be treated as updating errno. .IP "\fB\-fpascal\-strings\fR" 4 .IX Item "-fpascal-strings" Enable support for Pascal-style strings with \*(L"\epfoo\*(R". .IP "\fB\-fms\-extensions\fR" 4 .IX Item "-fms-extensions" Enable support for Microsoft extensions. .IP "\fB\-fmsc\-version=\fR" 4 .IX Item "-fmsc-version=" Set _MSC_VER. Defaults to 1300 on Windows. Not set otherwise. .IP "\fB\-fborland\-extensions\fR" 4 .IX Item "-fborland-extensions" Enable support for Borland extensions. .IP "\fB\-fwritable\-strings\fR" 4 .IX Item "-fwritable-strings" Make all string literals default to writable. This disables uniquing of strings and other optimizations. .IP "\fB\-flax\-vector\-conversions\fR" 4 .IX Item "-flax-vector-conversions" Allow loose type checking rules for implicit vector conversions. .IP "\fB\-fblocks\fR" 4 .IX Item "-fblocks" Enable the \*(L"Blocks\*(R" language feature. .IP "\fB\-fobjc\-gc\-only\fR" 4 .IX Item "-fobjc-gc-only" Indicate that Objective-C code should be compiled in GC-only mode, which only works when Objective-C Garbage Collection is enabled. .IP "\fB\-fobjc\-gc\fR" 4 .IX Item "-fobjc-gc" Indicate that Objective-C code should be compiled in hybrid-GC mode, which works with both \s-1GC\s0 and non-GC mode. .IP "\fB\-fobjc\-abi\-version\fR=\fIversion\fR" 4 .IX Item "-fobjc-abi-version=version" Select the Objective-C \s-1ABI\s0 version to use. Available versions are 1 (legacy \&\*(L"fragile\*(R" \s-1ABI\s0), 2 (non-fragile \s-1ABI\s0 1), and 3 (non-fragile \s-1ABI\s0 2). .IP "\fB\-fobjc\-nonfragile\-abi\-version\fR=\fIversion\fR" 4 .IX Item "-fobjc-nonfragile-abi-version=version" Select the Objective-C non-fragile \s-1ABI\s0 version to use by default. This will only be used as the Objective-C \s-1ABI\s0 when the non-fragile \s-1ABI\s0 is enabled (either via \&\-fobjc\-nonfragile\-abi, or because it is the platform default). .IP "\fB\-fobjc\-nonfragile\-abi\fR" 4 .IX Item "-fobjc-nonfragile-abi" Enable use of the Objective-C non-fragile \s-1ABI\s0. On platforms for which this is the default \s-1ABI\s0, it can be disabled with \fB\-fno\-objc\-nonfragile\-abi\fR. .SS "Target Selection Options" .IX Subsection "Target Selection Options" Clang fully supports cross compilation as an inherent part of its design. Depending on how your version of Clang is configured, it may have support for a number of cross compilers, or may only support a native target. .IP "\fB\-arch\fR \fIarchitecture\fR" 4 .IX Item "-arch architecture" Specify the architecture to build for. .IP "\fB\-mmacosx\-version\-min\fR=\fIversion\fR" 4 .IX Item "-mmacosx-version-min=version" When building for Mac \s-1OS/X\s0, specify the minimum version supported by your application. .IP "\fB\-miphoneos\-version\-min\fR" 4 .IX Item "-miphoneos-version-min" When building for iPhone \s-1OS\s0, specify the minimum version supported by your application. .IP "\fB\-march\fR=\fIcpu\fR" 4 .IX Item "-march=cpu" Specify that Clang should generate code for a specific processor family member and later. For example, if you specify \-march=i486, the compiler is allowed to generate instructions that are valid on i486 and later processors, but which may not exist on earlier ones. .SS "Code Generation Options" .IX Subsection "Code Generation Options" .IP "\fB\-O0\fR \fB\-O1\fR \fB\-O2\fR \fB\-Os\fR \fB\-Oz\fR \fB\-O3\fR \fB\-O4\fR" 4 .IX Item "-O0 -O1 -O2 -Os -Oz -O3 -O4" Specify which optimization level to use. \fB\-O0\fR means \*(L"no optimization\*(R": this level compiles the fastest and generates the most debuggable code. \fB\-O2\fR is a moderate level of optimization which enables most optimizations. \fB\-Os\fR is like \&\fB\-O2\fR with extra optimizations to reduce code size. \fB\-Oz\fR is like \fB\-Os\fR (and thus \fB\-O2\fR), but reduces code size further. \fB\-O3\fR is like \fB\-O2\fR, except that it enables optimizations that take longer to perform or that may generate larger code (in an attempt to make the program run faster). On supported platforms, \fB\-O4\fR enables link-time optimization; object files are stored in the \s-1LLVM\s0 bitcode file format and whole program optimization is done at link time. \fB\-O1\fR is somewhere between \fB\-O0\fR and \fB\-O2\fR. .IP "\fB\-g\fR" 4 .IX Item "-g" Generate debug information. Note that Clang debug information works best at \&\fB\-O0\fR. At higher optimization levels, only line number information is currently available. .IP "\fB\-fexceptions\fR" 4 .IX Item "-fexceptions" Enable generation of unwind information, this allows exceptions to be thrown through Clang compiled stack frames. This is on by default in x86\-64. .IP "\fB\-ftrapv\fR" 4 .IX Item "-ftrapv" Generate code to catch integer overflow errors. Signed integer overflow is undefined in C, with this flag, extra code is generated to detect this and abort when it happens. .IP "\fB\-fvisibility\fR" 4 .IX Item "-fvisibility" This flag sets the default visibility level. .IP "\fB\-fcommon\fR" 4 .IX Item "-fcommon" This flag specifies that variables without initializers get common linkage. It can be disabled with \fB\-fno\-common\fR. .IP "\fB\-flto\fR \fB\-emit\-llvm\fR" 4 .IX Item "-flto -emit-llvm" Generate output files in \s-1LLVM\s0 formats, suitable for link time optimization. When used with \fB\-S\fR this generates \s-1LLVM\s0 intermediate language assembly files, otherwise this generates \s-1LLVM\s0 bitcode format object files (which may be passed to the linker depending on the stage selection options). .SS "Driver Options" .IX Subsection "Driver Options" .IP "\fB\-###\fR" 4 .IX Item "-###" Print the commands to run for this compilation. .IP "\fB\-\-help\fR" 4 .IX Item "--help" Display available options. .IP "\fB\-Qunused\-arguments\fR" 4 .IX Item "-Qunused-arguments" Don't emit warning for unused driver arguments. .IP "\fB\-Wa,\fR\fIargs\fR" 4 .IX Item "-Wa,args" Pass the comma separated arguments in \fIargs\fR to the assembler. .IP "\fB\-Wl,\fR\fIargs\fR" 4 .IX Item "-Wl,args" Pass the comma separated arguments in \fIargs\fR to the linker. .IP "\fB\-Wp,\fR\fIargs\fR" 4 .IX Item "-Wp,args" Pass the comma separated arguments in \fIargs\fR to the preprocessor. .IP "\fB\-Xanalyzer\fR \fIarg\fR" 4 .IX Item "-Xanalyzer arg" Pass \fIarg\fR to the static analyzer. .IP "\fB\-Xassembler\fR \fIarg\fR" 4 .IX Item "-Xassembler arg" Pass \fIarg\fR to the assembler. .IP "\fB\-Xlinker\fR \fIarg\fR" 4 .IX Item "-Xlinker arg" Pass \fIarg\fR to the linker. .IP "\fB\-Xpreprocessor\fR \fIarg\fR" 4 .IX Item "-Xpreprocessor arg" Pass \fIarg\fR to the preprocessor. .IP "\fB\-o\fR \fIfile\fR" 4 .IX Item "-o file" Write output to \fIfile\fR. .IP "\fB\-print\-file\-name\fR=\fIfile\fR" 4 .IX Item "-print-file-name=file" Print the full library path of \fIfile\fR. .IP "\fB\-print\-libgcc\-file\-name\fR" 4 .IX Item "-print-libgcc-file-name" Print the library path for \*(L"libgcc.a\*(R". .IP "\fB\-print\-prog\-name\fR=\fIname\fR" 4 .IX Item "-print-prog-name=name" Print the full program path of \fIname\fR. .IP "\fB\-print\-search\-dirs\fR" 4 .IX Item "-print-search-dirs" Print the paths used for finding libraries and programs. .IP "\fB\-save\-temps\fR" 4 .IX Item "-save-temps" Save intermediate compilation results. .IP "\fB\-integrated\-as\fR \fB\-no\-integrated\-as\fR" 4 .IX Item "-integrated-as -no-integrated-as" Used to enable and disable, respectively, the use of the integrated assembler. Whether the integrated assembler is on by default is target dependent. .IP "\fB\-time\fR" 4 .IX Item "-time" Time individual commands. .IP "\fB\-ftime\-report\fR" 4 .IX Item "-ftime-report" Print timing summary of each stage of compilation. .IP "\fB\-v\fR" 4 .IX Item "-v" Show commands to run and use verbose output. .SS "Diagnostics Options" .IX Subsection "Diagnostics Options" .IP "\fB\-fshow\-column\fR \fB\-fshow\-source\-location\fR \fB\-fcaret\-diagnostics\fR \fB\-fdiagnostics\-fixit\-info\fR \fB\-fdiagnostics\-parseable\-fixits\fR \fB\-fdiagnostics\-print\-source\-range\-info\fR \fB\-fprint\-source\-range\-info\fR \fB\-fdiagnostics\-show\-option\fR \fB\-fmessage\-length\fR" 4 .IX Item "-fshow-column -fshow-source-location -fcaret-diagnostics -fdiagnostics-fixit-info -fdiagnostics-parseable-fixits -fdiagnostics-print-source-range-info -fprint-source-range-info -fdiagnostics-show-option -fmessage-length" These options control how Clang prints out information about diagnostics (errors and warnings). Please see the Clang User's Manual for more information. .SS "Preprocessor Options" .IX Subsection "Preprocessor Options" .IP "\fB\-D\fR\fImacroname=value\fR" 4 .IX Item "-Dmacroname=value" Adds an implicit #define into the predefines buffer which is read before the source file is preprocessed. .IP "\fB\-U\fR\fImacroname\fR" 4 .IX Item "-Umacroname" Adds an implicit #undef into the predefines buffer which is read before the source file is preprocessed. .IP "\fB\-include\fR \fIfilename\fR" 4 .IX Item "-include filename" Adds an implicit #include into the predefines buffer which is read before the source file is preprocessed. .IP "\fB\-I\fR\fIdirectory\fR" 4 .IX Item "-Idirectory" Add the specified directory to the search path for include files. .IP "\fB\-F\fR\fIdirectory\fR" 4 .IX Item "-Fdirectory" Add the specified directory to the search path for framework include files. .IP "\fB\-nostdinc\fR" 4 .IX Item "-nostdinc" Do not search the standard system directories or compiler builtin directories for include files. .IP "\fB\-nostdlibinc\fR" 4 .IX Item "-nostdlibinc" Do not search the standard system directories for include files, but do search compiler builtin include directories. .IP "\fB\-nobuiltininc\fR" 4 .IX Item "-nobuiltininc" Do not search clang's builtin directory for include files. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\fB\s-1TMPDIR\s0\fR, \fB\s-1TEMP\s0\fR, \fB\s-1TMP\s0\fR" 4 .IX Item "TMPDIR, TEMP, TMP" These environment variables are checked, in order, for the location to write temporary files used during the compilation process. .IP "\fB\s-1CPATH\s0\fR" 4 .IX Item "CPATH" If this environment variable is present, it is treated as a delimited list of paths to be added to the default system include path list. The -delimiter is the platform dependent delimitor, as used in the \fI\s-1PATH\s0\fR +delimiter is the platform dependent delimiter, as used in the \fI\s-1PATH\s0\fR environment variable. .Sp Empty components in the environment variable are ignored. .IP "\fBC_INCLUDE_PATH\fR, \fB\s-1OBJC_INCLUDE_PATH\s0\fR, \fB\s-1CPLUS_INCLUDE_PATH\s0\fR, \fB\s-1OBJCPLUS_INCLUDE_PATH\s0\fR" 4 .IX Item "C_INCLUDE_PATH, OBJC_INCLUDE_PATH, CPLUS_INCLUDE_PATH, OBJCPLUS_INCLUDE_PATH" These environment variables specify additional paths, as for \s-1CPATH\s0, which are only used when processing the appropriate language. .IP "\fB\s-1MACOSX_DEPLOYMENT_TARGET\s0\fR" 4 .IX Item "MACOSX_DEPLOYMENT_TARGET" If \-mmacosx\-version\-min is unspecified, the default deployment target is read from this environment variable. This option only affects darwin targets. .SH "BUGS" .IX Header "BUGS" To report bugs, please visit . Most bug reports should include preprocessed source files (use the \fB\-E\fR option) and the full output of the compiler, along with information to reproduce. .SH "SEE ALSO" .IX Header "SEE ALSO" .Vb 1 \& as(1), ld(1) .Ve .SH "AUTHOR" .IX Header "AUTHOR" Maintained by the Clang / \s-1LLVM\s0 Team (). Index: head/usr.bin/clang/tblgen/tblgen.1 =================================================================== --- head/usr.bin/clang/tblgen/tblgen.1 (revision 235210) +++ head/usr.bin/clang/tblgen/tblgen.1 (revision 235211) @@ -1,233 +1,233 @@ .\" $FreeBSD$ .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "TBLGEN 1" .TH TBLGEN 1 "2012-04-05" "LLVM 3.1" "LLVM Command Guide" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" tblgen \- Target Description To C++ Code Generator .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBtblgen\fR [\fIoptions\fR] [\fIfilename\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBtblgen\fR translates from target description (.td) files into \*(C+ code that can be included in the definition of an \s-1LLVM\s0 target library. Most users of \s-1LLVM\s0 will not need to use this program. It is only for assisting with writing an \s-1LLVM\s0 target backend. .PP The input and output of \fBtblgen\fR is beyond the scope of this short introduction. Please see the \fICodeGeneration\fR page in the \s-1LLVM\s0 documentation. .PP The \fIfilename\fR argument specifies the name of a Target Description (.td) file to read as input. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-help\fR" 4 .IX Item "-help" Print a summary of command line options. .IP "\fB\-o\fR \fIfilename\fR" 4 .IX Item "-o filename" Specify the output file name. If \fIfilename\fR is \f(CW\*(C`\-\*(C'\fR, then \fBtblgen\fR sends its output to standard output. .IP "\fB\-I\fR \fIdirectory\fR" 4 .IX Item "-I directory" Specify where to find other target description files for inclusion. The \&\fIdirectory\fR value should be a full or partial path to a directory that contains target description files. .IP "\fB\-asmparsernum\fR \fIN\fR" 4 .IX Item "-asmparsernum N" Make \-gen\-asm\-parser emit assembly writer number \fIN\fR. .IP "\fB\-asmwriternum\fR \fIN\fR" 4 .IX Item "-asmwriternum N" Make \-gen\-asm\-writer emit assembly writer number \fIN\fR. .IP "\fB\-class\fR \fIclass Name\fR" 4 .IX Item "-class class Name" Print the enumeration list for this class. .IP "\fB\-print\-records\fR" 4 .IX Item "-print-records" Print all records to standard output (default). .IP "\fB\-print\-enums\fR" 4 .IX Item "-print-enums" -Print enumeration values for a class +Print enumeration values for a class. .IP "\fB\-print\-sets\fR" 4 .IX Item "-print-sets" Print expanded sets for testing \s-1DAG\s0 exprs. .IP "\fB\-gen\-emitter\fR" 4 .IX Item "-gen-emitter" Generate machine code emitter. .IP "\fB\-gen\-register\-info\fR" 4 .IX Item "-gen-register-info" Generate registers and register classes info. .IP "\fB\-gen\-instr\-info\fR" 4 .IX Item "-gen-instr-info" Generate instruction descriptions. .IP "\fB\-gen\-asm\-writer\fR" 4 .IX Item "-gen-asm-writer" Generate the assembly writer. .IP "\fB\-gen\-disassembler\fR" 4 .IX Item "-gen-disassembler" Generate disassembler. .IP "\fB\-gen\-pseudo\-lowering\fR" 4 .IX Item "-gen-pseudo-lowering" Generate pseudo instruction lowering. .IP "\fB\-gen\-dag\-isel\fR" 4 .IX Item "-gen-dag-isel" Generate a \s-1DAG\s0 (Directed Acycle Graph) instruction selector. .IP "\fB\-gen\-asm\-matcher\fR" 4 .IX Item "-gen-asm-matcher" Generate assembly instruction matcher. .IP "\fB\-gen\-dfa\-packetizer\fR" 4 .IX Item "-gen-dfa-packetizer" Generate \s-1DFA\s0 Packetizer for \s-1VLIW\s0 targets. .IP "\fB\-gen\-fast\-isel\fR" 4 .IX Item "-gen-fast-isel" Generate a \*(L"fast\*(R" instruction selector. .IP "\fB\-gen\-subtarget\fR" 4 .IX Item "-gen-subtarget" Generate subtarget enumerations. .IP "\fB\-gen\-intrinsic\fR" 4 .IX Item "-gen-intrinsic" Generate intrinsic information. .IP "\fB\-gen\-tgt\-intrinsic\fR" 4 .IX Item "-gen-tgt-intrinsic" Generate target intrinsic information. .IP "\fB\-gen\-enhanced\-disassembly\-info\fR" 4 .IX Item "-gen-enhanced-disassembly-info" Generate enhanced disassembly info. .IP "\fB\-version\fR" 4 .IX Item "-version" Show the version number of this program. .SH "EXIT STATUS" .IX Header "EXIT STATUS" If \fBtblgen\fR succeeds, it will exit with 0. Otherwise, if an error occurs, it will exit with a non-zero value. .SH "AUTHORS" .IX Header "AUTHORS" Maintained by The \s-1LLVM\s0 Team (). Index: head/usr.bin/csup/csup.1 =================================================================== --- head/usr.bin/csup/csup.1 (revision 235210) +++ head/usr.bin/csup/csup.1 (revision 235211) @@ -1,996 +1,996 @@ .\" Copyright 1996-2003 John D. Polstra. .\" 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 ``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 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: cvsup.1,v 1.70 2003/03/04 18:23:46 jdp Exp $ .\" $FreeBSD$ .\" .Dd February 1, 2006 .Dt CSUP 1 .Os FreeBSD .Sh NAME .Nm csup .Nd network distribution package for CVS repositories .Sh SYNOPSIS .Nm .Op Fl 146aksvzZ .Op Fl A Ar addr .Op Fl b Ar base .Op Fl c Ar collDir .Op Fl d Ar delLimit .Op Fl h Ar host .Op Fl i Ar pattern .Op Fl l Ar lockfile .Op Fl L Ar verbosity .Op Fl p Ar port .Op Fl r Ar maxRetries .Ar supfile .Sh DESCRIPTION .Nm is a software package for updating collections of files across a network. It is a rewrite of the .Nm CVSup software in C. This manual page describes the usage of the .Nm client program. .Pp Unlike more traditional network distribution packages, such as .Nm rdist and .Nm sup , .Nm has specific optimizations for distributing CVS repositories. .Nm takes advantage of the properties of CVS repositories and the files they contain (in particular, RCS files), enabling it to perform updates much faster than traditional systems. .Pp .Nm is a general-purpose network file updating package. It is extremely fast, even for collections of files which have nothing to do with CVS or RCS. .Sh OPTIONS The client program .Nm requires at least a single argument, .Ar supfile . It names a file describing one or more collections of files to be transferred and/or updated from the server. The .Ar supfile has a format similar to the corresponding file used by .Nm sup . In most cases, .Nm can use existing .Nm sup Ar supfiles . .Pp The following options are supported by .Nm : .Bl -tag -width Fl .It Fl 1 Disables automatic retries when transient failures occur. Without this option, a transient failure such as a dropped network connection causes .Nm to retry repeatedly, using randomized exponential backoff to space the retries. This option is equivalent to .Fl r Cm 0 . .It Fl 4 Forces .Nm to use IPv4 addresses only. .It Fl 6 Forces .Nm to use IPv6 addresses only. .It Fl a Requires the server to authenticate itself (prove its identity) to the client. If authentication of the server fails, the update is canceled. See .Sx AUTHENTICATION , below. .It Fl A Ar addr Specifies a local address to bind to when connecting to the server. The local address might be a hostname or a numeric host address string consisting of a dotted decimal IPv4 address or an IPv6 address. This may be useful on hosts which have multiple IP addresses. .It Fl b Ar base Specifies the base directory under which .Nm will maintain its bookkeeping files, overriding any .Cm base specifications in the .Ar supfile . .It Fl c Ar collDir Specifies the subdirectory of .Ar base where the information about the collections is maintained. The default is .Pa sup . .It Fl d Ar delLimit Specifies the maximum number of files that may be deleted in a single update run. Any attempt to exceed the limit results in a fatal error. This can provide some protection against temporary configuration mistakes on the server. The default limit is infinity. .It Fl h Ar host Specifies the server host to contact, overriding any .Cm host specifications in the .Ar supfile . .It Fl i Ar pattern Causes .Nm to include only files and directories matching .Ar pattern in the update. If a directory matches the pattern, then the entire subtree rooted at the directory is included. If this option is specified multiple times, the patterns are combined using the .Ql or operation. If no .Fl i options are given, the default is to update all files in each collection. .Pp The .Ar pattern is a standard file name pattern. It is interpreted relative to the collection's prefix directory. Slash characters are matched only by explicit slashes in the pattern. Leading periods in file name are not treated specially. .It Fl k Causes .Nm to keep the temporary copies of any incorrectly edited files, in the event of checksum mismatches. This option is for debugging, to help determine why the files were edited incorrectly. Regardless of whether this option is specified, the permanent versions of faulty files are replaced with correct versions obtained by transferring the files in their entirety. Such transfers are called fixups. .It Fl l Ar lockfile Creates and locks the .Ar lockfile while the update is in progress. If .Ar lockfile is already locked, .Nm fails without performing automatic retries. This option is useful when .Nm is executed periodically from .Nm cron . It prevents a job from interfering with an earlier job that is perhaps taking extra long because of network problems. .Pp The process-ID is written to the lock file in text form when the lock is successfully acquired. Upon termination of the update, the lock file is removed. .It Fl L Ar verbosity Sets the verbosity level for output. A level of 0 causes .Nm to be completely silent unless errors occur. A level of 1 (the default) causes each updated file to be listed. A level of 2 provides more detailed information about the updates performed on each file. All messages are directed to the standard output. .It Fl p Ar port Sets the TCP port to which .Nm attempts to connect on the server host. The default port is 5999. .It Fl r Ar maxRetries Limits the number of automatic retries that will be attempted when transient errors such as lost network connections are encountered. By default, .Nm will retry indefinitely until an update is successfully completed. The retries are spaced using randomized exponential backoff. Note that .Fl r Cm 0 is equivalent to the .Fl 1 option. .It Fl s Suppresses the check of each client file's status against what is recorded in the list file. Instead, the list file is assumed to be accurate. This option greatly reduces the amount of disk activity and results in faster updates with less load on the client host. However it should only be used if client's files are never modified locally in any way. Mirror sites may find this option beneficial to reduce the disk load on their systems. For safety, even mirror sites should run .Nm occasionally (perhaps once a day) without the .Fl s option. .Pp Without the .Fl s option, .Nm performs a .Xr stat 2 call on each file and verifies that its attributes match those recorded in the list file. This ensures that any file changes made outside of .Nm are detected and corrected. .Pp If the .Fl s option is used when one or more files have been modified locally, the results are undefined. Local file damage may remain uncorrected, updates may be missed, or .Nm may abort prematurely. .It Fl v Prints the version number and exits, without contacting the server. .It Fl z Enables compression for all collections, as if the .Cm compress keyword were added to every collection in the .Ar supfile . .It Fl Z Disables compression for all collections, as if the .Cm compress keyword were removed from every collection in the .Ar supfile . .El .Pp The .Ar supfile is a text file which specifies the file collections to be updated. Comments begin with .Ql # and extend to the end of the line. Lines that are empty except for comments and white space are ignored. Each remaining line begins with the name of a server-defined collection of files. Following the collection name on the line are zero or more keywords or keyword=value pairs. .Pp Default settings may be specified in lines whose collection name is .Cm *default . Such defaults will apply to subsequent lines in the .Ar supfile . Multiple .Cm *default lines may be present. New values augment or override any defaults specified earlier in the .Ar supfile . Values specified explicitly for a collection override any default values. .Pp The most commonly used keywords are: .Bl -tag -width Fl .It Cm release= Ns Ar releaseName This specifies the release of the files within a collection. Like collection names, release names are defined by the server configuration files. Usually there is only one release in each collection, but there may be any number. Collections which come from a CVS repository often use .Cm release=cvs by convention. Non-CVS collections conventionally use .Cm release=current . .It Cm base= Ns Ar base This specifies a directory under which .Nm will maintain its bookkeeping files, describing the state of each collection on the client machine. The .Ar base directory must already exist; .Nm will not create it. The default .Ar base directory is -.Pa /usr/local/etc/csup . +.Pa /usr/local/etc/cvsup . .It Cm prefix= Ns Ar prefix This is the directory under which updated files will be placed. By default, it is the same as .Ar base . If it is not an absolute pathname, it is interpreted relative to .Ar base . The .Ar prefix directory must already exist; .Nm will not create it. .Pp As a special case, if .Ar prefix is a symbolic link pointing to a nonexistent file named .Ql SKIP , then .Nm will skip the collection. The parameters associated with the collection are still checked for validity, but none of its files will be updated. This feature allows a site to use a standard .Ar supfile on several machines, yet control which collections get updated on a per-machine basis. .It Cm host= Ns Ar hostname This specifies the server machine from which all files will be taken. .Nm requires that all collections in a single run come from the same host. If you wish to update collections from several different hosts, you must run .Nm several times. .It Cm delete The presence of this keyword gives .Nm permission to delete files. If it is missing, no files will be deleted. .Pp The presence of the .Cm delete keyword puts .Nm into so-called .Em exact mode. In exact mode, .Nm does its best to make the client's files correspond to those on the server. This includes deleting individual deltas and symbolic tags from RCS files, as well as deleting entire files. In exact mode, .Nm verifies every edited file with a checksum, to ensure that the edits have produced a file identical to the master copy on the server. If the checksum test fails for a file, then .Nm falls back upon transferring the entire file. .Pp In general, .Nm deletes only files which are known to the server. Extra files present in the client's tree are left alone, even in exact mode. More precisely, .Nm is willing to delete two classes of files: .Bl -bullet -compact .It Files that were previously created or updated by .Nm itself. .It Checked-out versions of files which are marked as dead on the server. .El .It Cm use-rel-suffix Causes .Nm to append a suffix constructed from the release and tag to the name of each list file that it maintains. See .Sx THE LIST FILE for details. .It Cm compress This enables compression of all data sent across the network. Compression is quite effective, normally eliminating 65% to 75% of the bytes that would otherwise need to be transferred. However, it is costly in terms of CPU time on both the client and the server. On local area networks, compression is generally counter-productive; it actually slows down file updates. On links with speeds of 56K bits/second or less, compression is almost always beneficial. For network links with speeds between these two extremes, let experimentation be your guide. .Pp The .Fl z command line option enables the .Cm compress keyword for all collections, regardless of what is specified in the supfile. Likewise, the .Fl Z command line option disables the .Cm compress option for all collections. .Nm uses a looser checksum for RCS files, which ignores harmless differences in white space. Different versions of CVS and RCS produce a variety of differences in white space for the same RCS files. Thus the strict checksum can report spurious mismatches for files which are logically identical. This can lead to numerous unneeded .Dq fixups , and thus to slow updates. .It Cm umask= Ns Ar n Causes .Nm to use a umask value of .Ar n (an octal number) when updating the files in the collection. This option is ignored if .Cm preserve is specified. .El .Pp Some additional, more specialized keywords are described below. Unrecognized keywords are silently ignored for backward compatibility with .Nm sup . .Sh CVS MODE .Nm CVSup supports two primary modes of operation. They are called .Em CVS mode and .Em checkout mode. .Pp In CVS mode, the client receives copies of the actual RCS files making up the master CVS repository. CVS mode is the default mode of operation. It is appropriate when the user wishes to maintain a full copy of the CVS repository on the client machine. .Pp CVS mode is also appropriate for file collections which are not based upon a CVS repository. The files are simply transferred verbatim, without interpretation. .Sh CHECKOUT MODE In checkout mode, the client receives specific revisions of files, checked out directly from the server's CVS repository. Checkout mode allows the client to receive any version from the repository, without requiring any extra disk space on the server for storing multiple versions in checked-out form. Checkout mode provides much flexibility beyond that basic functionality, however. The client can specify any CVS symbolic tag, or any date, or both, and .Nm will provide the corresponding checked-out versions of the files in the repository. .Pp Checkout mode is selected on a per-collection basis, by the presence of one or both of the following keywords in the .Ar supfile : .Bl -tag -width Fl .It Cm tag= Ns Ar tagname This specifies a symbolic tag that should be used to select the revisions that are checked out from the CVS repository. The tag may refer to either a branch or a specific revision. It must be symbolic; numeric revision numbers are not supported. .Pp For the FreeBSD source repository, the most commonly used tags will be: .Bl -tag -width RELENG_6 .It Li RELENG_6 The .Ql stable branch. .It Li \&. The main branch (the .Ql current release). This is the default, if only the .Cm date keyword is given. .El .Sm off .It Xo Cm date= .Op Ar cc .Ar yy.mm.dd.hh.mm.ss .Xc .Sm on This specifies a date that should be used to select the revisions that are checked out from the CVS repository. The client will receive the revisions that were in effect at the specified date and time. .Pp At present, the date format is inflexible. All 17 or 19 characters must be specified, exactly as shown. For the years 2000 and beyond, specify the century .Ar cc . For earlier years, specify only the last two digits .Ar yy . Dates and times are considered to be GMT. The default date is .Ql \&. , which means .Dq as late as possible . .El .Pp To enable checkout mode, you must specify at least one of these keywords. If both are missing, .Nm defaults to CVS mode. .Pp If both a branch tag and a date are specified, then the revisions on the given branch, as of the given date, will be checked out. It is permitted, but not particularly useful, to specify a date with a specific release tag. .Pp In checkout mode, the tag and/or date may be changed between updates. For example, suppose that a collection has been transferred using the specification .Ql tag=. . The user could later change the specification to .Ql tag=RELENG_3 . This would cause .Nm to edit the checked-out files in such a way as to transform them from the .Ql current versions to the .Ql stable versions. In general, .Nm is willing to transform any tag/date combination into any other tag/date combination, by applying the intervening RCS deltas to the existing files. .Pp When transforming a collection of checked-out files from one tag to another, it is important to specify the .Cm list keyword in the .Ar supfile , to ensure that the same list file is used both before and after the transformation. The list file is described in .Sx THE LIST FILE , below. .Sh THE LIST FILE For efficiency, .Nm maintains a bookkeeping file for each collection, called the list file. The list file contains information about which files and revisions the client currently possesses. It also contains information used for verifying that the list file is consistent with the actual files in the client's tree. .Pp The list file is not strictly necessary. If it is deleted, or becomes inconsistent with the actual client files, .Nm falls back upon a less efficient method of identifying the client's files and performing its updates. Depending on .Nm csup Ns No 's mode of operation, the fallback method employs time stamps, checksums, or analysis of RCS files. .Pp Because the list file is not essential, .Nm is able to .Dq adopt an existing file tree acquired by FTP or from a CD-ROM. .Nm identifies the client's versions of the files, updates them as necessary, and creates a list file for future use. Adopting a foreign file tree is not as fast as performing a normal update. It also produces a heavier load on the server. .Pp The list file is stored in a collection-specific directory; see .Sx FILES for details. Its name always begins with .Ql checkouts . If the keyword .Cm use-rel-suffix is specified in the .Ar supfile , a suffix, formed from the release and tag, is appended to the name. The default suffix can be overridden by specifying an explicit suffix in the .Ar supfile : .Bl -tag -width Fl .It Cm list= Ns Ar suffix This specifies a suffix for the name of the list file. A leading dot is provided automatically. For example, .Ql list=stable would produce a list file named .Pa checkouts.stable , regardless of the release, tag, or .Cm use-rel-suffix keyword. .El .Sh REFUSE FILES The user can specify sets of files that he does not wish to receive. The files are specified as file name patterns in so-called .Em refuse files. The patterns are separated by whitespace, and multiple patterns are permitted on each line. Files and directories matching the patterns are neither updated nor deleted; they are simply ignored. .Pp There is currently no provision for comments in refuse files. .Pp The patterns are similar to those of .Xr sh 1 , except that there is no special treatment for slashes or for filenames that begin with a period. For example, the pattern .Ql *.c will match any file name ending with .Ql \&.c including those in subdirectories, such as .Ql foo/bar/lam.c . All patterns are interpreted relative to the collection's prefix directory. .Pp If the files are coming from a CVS repository, as is usually the case, then they will be RCS files. These have a .Ql \&,v suffix which must be taken into account in the patterns. For example, the FreeBSD documentation files are in a sub-directory of .Ar base called .Ql doc . If .Ql Makefile from that directory is not required then the line .Pp .Bl -item -compact -offset indent .It .Pa doc/Makefile .El .Pp will not work because the file on the server is called -.Ql Makefile,v. +.Ql Makefile,v . A better solution would be .Pp .Bl -item -compact -offset indent .It .Pa doc/Makefile* .El .Pp which will match whether .Ql Makefile is an RCS file or not. .Pp As another example, to receive the FreeBSD documentation files without the Japanese, Russian, and Chinese translations, create a refuse file containing the following lines: .Pp .Bl -item -compact -offset indent .It .Pa doc/ja* .It .Pa doc/ru* .It .Pa doc/zh* .El .Pp As many as three refuse files are examined for each .Ar supfile line. There can be a global refuse file named .Sm off .Ar base / Ar collDir Pa /refuse .Sm on which applies to all collections and releases. There can be a per-collection refuse file named .Sm off .Xo Ar base / Ar collDir / Ar collection .Pa /refuse .Xc .Sm on which applies to a specific collection. Finally, there can be a per-release and tag refuse file which applies only to a given release/tag combination within a collection. The name of the latter is formed by suffixing the name of the per-collection refuse file in the same manner as described above for the list file. None of the refuse files are required to exist. .Pp .Nm has a built-in default value of .Ar /usr/local/etc/cvsup for .Ar base and .Ar sup for .Ar collDir but it is possible to override both of these. The value of .Ar base can be changed using the .Fl b option or a .Ar base=pathname entry in the .Ar supfile . (If both are used the .Fl b option will override the .Ar supfile entry.) The value of .Ar collDir can only be changed with the .Fl c option; there is no .Ar supfile command to change it. .Pp As an example, suppose that the .Ar base and .Ar collDir both have their default values, and that the collection and release are .Ql src-all and .Ql cvs , respectively. Assume further that checkout mode is being used with .Ql tag=RELENG_3 . The three possible refuse files would then be named: .Pp .Bl -item -compact -offset indent .It .Pa /usr/local/etc/cvsup/sup/refuse .It .Pa /usr/local/etc/cvsup/sup/src-all/refuse .It .Pa /usr/local/etc/cvsup/sup/src-all/refuse.cvs:RELENG_3 .El .Pp If the .Ar supfile includes the command .Ar base=/foo the refuse files would be: .Pp .Bl -item -compact -offset indent .It .Pa /foo/sup/refuse .It .Pa /foo/sup/src-all/refuse .It .Pa /foo/sup/src-all/refuse.cvs:RELENG_3 .El .Pp If .Fl b .Ar /bar is used (even with .Ar base=/foo in the .Ar supfile ) : .Pp .Bl -item -compact -offset indent .It .Pa /bar/sup/refuse .It .Pa /bar/sup/src-all/refuse .It .Pa /bar/sup/src-all/refuse.cvs:RELENG_3 .El .Pp and with .Fl c .Ar stool as well: .Pp .Bl -item -compact -offset indent .It .Pa /bar/stool/refuse .It .Pa /bar/stool/src-all/refuse .It .Pa /bar/stool/src-all/refuse.cvs:RELENG_3 .El .Sh AUTHENTICATION .Nm implements an optional authentication mechanism which can be used by the client and server to verify each other's identities. Public CVSup servers normally do not enable authentication. .Nm users may ignore this section unless they have been informed that authentication is required by the administrator of their server. .Pp The authentication subsystem uses a challenge-response protocol which is immune to packet sniffing and replay attacks. No passwords are sent over the network in either direction. Both the client and the server can independently verify the identities of each other. .Pp The file .Li $ Ns Ev HOME Ns Pa /.csup/auth holds the information used for authentication. This file contains a record for each server that the client is allowed to access. Each record occupies one line in the file. Lines beginning with .Ql # are ignored, as are lines containing only white space. White space is significant everywhere else in the file. Fields are separated by .Ql \&: characters. .Pp Each record of the file has the following form: .Bd -literal -offset indent .Sm off .Xo Ar serverName No : Ar clientName No : .Ar password No : Ar comment .Xc .Sm on .Ed .Pp All fields must be present even if some of them are empty. .Ar ServerName is the name of the server to which the record applies. By convention, it is the canonical fully-qualified domain name of the server, e.g., .Ql CVSup177.FreeBSD.ORG . This must agree with the server's own idea of its name. The name is case-insensitive. .Pp .Ar ClientName is the name the client uses to gain access to the server. By convention, e-mail addresses are used for all client names, e.g., .Ql BillyJoe@FreeBSD.org . Client names are case-insensitive. .Pp .Ar Password is a secret string of characters that the client uses to prove its identity. It may not contain any .Ql \&: or newline characters. .Pp .Ar Comment may contain any additional information to identify the record. It is not interpreted by the program. .Pp To set up authentication for a given server, one must perform the following steps: .Bl -enum .It Obtain the official .Ar serverName from the administrator of the server or from some other source. .It Choose an appropriate .Ar clientName . It should be in the form of a valid e-mail address, to make it easy for the server administrator to contact the user if necessary. .It Choose an arbitrary secret .Ar password . .It Run the .Nm cpasswd utility, and type in the .Ar password when prompted for it. The utility will print out a line to send to the server administrator, and instruct you how to modify your .Li $ Ns Ev HOME Ns Pa /.csup/auth file. You should use a secure channel to send the line to the server administrator. .El .Pp Since .Li $ Ns Ev HOME Ns Pa /.csup/auth contains passwords, you should ensure that it is not readable by anyone except yourself. .Pp Authentication works independently in both directions. The server administrator controls whether you must prove your identity. You control whether to check the server's identity, by means of the .Fl a command line option. .Sh csup AND FIREWALLS In its default mode, .Nm will work through any firewall which permits outbound connections to port 5999 of the server host. .Sh USING csup WITH SOCKS .Nm can be used through a SOCKS proxy server with the standard .Nm runsocks command. Your .Nm executable needs to be dynamically-linked with the system libraries for .Nm runsocks to work properly. .Sh USING ssh PORT FORWARDING As an alternative to SOCKS, a user behind a firewall can penetrate it with the TCP port forwarding provided by the Secure Shell package .Nm ssh . The user must have a login account on the .Nm CVSup server host in order to do this. The procedure is as follows: .Bl -enum .It Establish a connection to the server host with .Nm ssh , like this: .Bd -literal ssh -f -x -L 5999:localhost:5999 serverhost sleep 60 .Ed .Pp Replace .Ar serverhost with the hostname of the CVSup server, but type .Ql localhost literally. This sets up the required port forwarding. You must start .Nm before the 60-second .Nm sleep finishes. Once the update has begun, .Nm ssh will keep the forwarded channels open as long as they are needed. .It Run .Nm on the local host, including the arguments .Ql -h localhost on the command line. .El .Sh FILES .Bl -tag -width base/sup/collection/checkouts*xx -compact .It Pa /usr/local/etc/cvsup Default .Ar base directory. .It Pa sup Default .Ar collDir subdirectory. .Sm off .It Xo Ar base / Ar collDir / Ar collection .Pa /checkouts* .Xc .Sm on List files. .El .Sh SEE ALSO .Xr cpasswd 1 , .Xr cvs 1 , .Xr rcsintro 1 , .Xr ssh 1 . .Sh AUTHORS .An -nosplit .An Maxime Henrion Aq mux@FreeBSD.org is the author of .Nm , the rewrite of .Nm CVSup in C. .An John Polstra Aq jdp@polstra.com is the author of .Nm CVSup . .Sh LEGALITIES CVSup is a registered trademark of John D. Polstra. .Pp .Nm is released under a 2-clauses BSD license. .Sh BUGS An RCS file is not recognized as such unless its name ends with .Ql \&,v . .Pp Any directory named .Ql Attic is assumed to be a CVS Attic, and is treated specially. Index: head/usr.bin/fetch/fetch.1 =================================================================== --- head/usr.bin/fetch/fetch.1 (revision 235210) +++ head/usr.bin/fetch/fetch.1 (revision 235211) @@ -1,310 +1,310 @@ .\"- .\" Copyright (c) 2000-2012 Dag-Erling Smørgrav .\" All rights reserved. .\" Portions Copyright (c) 1999 Massachusetts Institute of Technology; used .\" by permission. .\" .\" 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 .\" in this position and unchanged. .\" 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. .\" 3. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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$ .\" .Dd February 28, 2012 .Dt FETCH 1 .Os .Sh NAME .Nm fetch .Nd retrieve a file by Uniform Resource Locator .Sh SYNOPSIS .Nm .Op Fl 146AadFlMmnPpqRrsUv .Op Fl B Ar bytes .Op Fl i Ar file .Op Fl N Ar file .Op Fl o Ar file .Op Fl S Ar bytes .Op Fl T Ar seconds .Op Fl w Ar seconds .Ar URL ... .Nm .Op Fl 146AadFlMmnPpqRrsUv .Op Fl B Ar bytes .Op Fl i Ar file .Op Fl N Ar file .Op Fl o Ar file .Op Fl S Ar bytes .Op Fl T Ar seconds .Op Fl w Ar seconds .Fl h Ar host Fl f Ar file Oo Fl c Ar dir Oc .Sh DESCRIPTION The .Nm utility provides a command-line interface to the .Xr fetch 3 library. Its purpose is to retrieve the file(s) pointed to by the URL(s) on the command line. .Pp The following options are available: .Bl -tag -width Fl .It Fl 1 Stop and return exit code 0 at the first successfully retrieved file. .It Fl 4 Forces .Nm to use IPv4 addresses only. .It Fl 6 Forces .Nm to use IPv6 addresses only. .It Fl A Do not automatically follow ``temporary'' (302) redirects. Some broken Web sites will return a redirect instead of a not-found error when the requested object does not exist. .It Fl a Automatically retry the transfer upon soft failures. .It Fl B Ar bytes Specify the read buffer size in bytes. The default is 4096 bytes. Attempts to set a buffer size lower than this will be silently ignored. The number of reads actually performed is reported at verbosity level two or higher (see the .Fl v flag). .It Fl c Ar dir The file to retrieve is in directory .Ar dir on the remote host. This option is deprecated and is provided for backward compatibility only. .It Fl d Use a direct connection even if a proxy is configured. .It Fl F In combination with the .Fl r flag, forces a restart even if the local and remote files have different modification times. Implies .Fl R . .It Fl f Ar file The file to retrieve is named .Ar file on the remote host. This option is deprecated and is provided for backward compatibility only. .It Fl h Ar host The file to retrieve is located on the host .Ar host . This option is deprecated and is provided for backward compatibility only. .It Fl i Ar file If-Modified-Since mode: the remote file will only be retrieved if it is newer than .Ar file on the local host. (HTTP only) .It Fl l If the target is a file-scheme URL, make a symbolic link to the target rather than trying to copy it. .It Fl M .It Fl m Mirror mode: if the file already exists locally and has the same size and modification time as the remote file, it will not be fetched. Note that the .Fl m and .Fl r flags are mutually exclusive. .It Fl N Ar file Use .Ar file instead of .Pa ~/.netrc to look up login names and passwords for FTP sites. See .Xr ftp 1 for a description of the file format. This feature is experimental. .It Fl n Do not preserve the modification time of the transferred file. .It Fl o Ar file Set the output file name to .Ar file . By default, a ``pathname'' is extracted from the specified URI, and its basename is used as the name of the output file. A .Ar file argument of .Sq Li \&- indicates that results are to be directed to the standard output. If the .Ar file argument is a directory, fetched file(s) will be placed within the directory, with name(s) selected as in the default behaviour. .It Fl P .It Fl p Use passive FTP. These flags have no effect, since passive FTP is the default, but are provided for compatibility with earlier versions where active FTP was the default. To force active mode, set the .Ev FTP_PASSIVE_MODE environment variable to .Ql NO . .It Fl q Quiet mode. .It Fl R The output files are precious, and should not be deleted under any circumstances, even if the transfer failed or was incomplete. .It Fl r Restart a previously interrupted transfer. Note that the .Fl m and .Fl r flags are mutually exclusive. .It Fl S Ar bytes Require the file size reported by the server to match the specified value. If it does not, a message is printed and the file is not fetched. If the server does not support reporting file sizes, this option is ignored and the file is fetched unconditionally. .It Fl s Print the size in bytes of each requested file, without fetching it. .It Fl T Ar seconds Set timeout value to .Ar seconds . Overrides the environment variables .Ev FTP_TIMEOUT for FTP transfers or .Ev HTTP_TIMEOUT for HTTP transfers if set. .It Fl U When using passive FTP, allocate the port for the data connection from the low (default) port range. See .Xr ip 4 for details on how to specify which port range this corresponds to. .It Fl v Increase verbosity level. .It Fl w Ar seconds When the .Fl a flag is specified, wait this many seconds between successive retries. .El .Pp .Ar URL .Bd -literal :(//((:)?@)?(:)?)?/()? .Ed .Pp If .Nm receives a .Dv SIGINFO signal (see the .Cm status argument for .Xr stty 1 ) , the current transfer rate statistics will be written to the standard error output, in the same format as the standard completion message. .Sh ENVIRONMENT .Bl -tag -width HTTP_TIMEOUT .It Ev FTP_TIMEOUT Maximum time, in seconds, to wait before aborting an FTP connection. .It Ev HTTP_TIMEOUT Maximum time, in seconds, to wait before aborting an HTTP connection. .El .Pp See .Xr fetch 3 for a description of additional environment variables, including .Ev FETCH_BIND_ADDRESS , .Ev FTP_LOGIN , .Ev FTP_PASSIVE_MODE , .Ev FTP_PASSWORD , .Ev FTP_PROXY , .Ev ftp_proxy , .Ev HTTP_AUTH , .Ev HTTP_PROXY , .Ev http_proxy , .Ev HTTP_PROXY_AUTH , .Ev HTTP_REFERER , .Ev HTTP_USER_AGENT , .Ev NETRC , -.Ev NO_PROXY and +.Ev NO_PROXY No and .Ev no_proxy . .Sh EXIT STATUS The .Nm command returns zero on success, or one on failure. If multiple URLs are listed on the command line, .Nm will attempt to retrieve each one of them in turn, and will return zero only if they were all successfully retrieved. .Pp If the .Fl i argument is used and the remote file is not newer than the specified file then the command will still return success, although no file is transferred. .Sh SEE ALSO .Xr fetch 3 .Sh HISTORY The .Nm command appeared in .Fx 2.1.5 . This implementation first appeared in .Fx 4.1 . .Sh AUTHORS .An -nosplit The original implementation of .Nm was done by .An Jean-Marc Zucconi Aq jmz@FreeBSD.org . It was extensively re-worked for .Fx 2.2 by .An Garrett Wollman Aq wollman@FreeBSD.org , and later completely rewritten to use the .Xr fetch 3 library by .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org . .Sh NOTES The .Fl b and .Fl t options are no longer supported and will generate warnings. They were workarounds for bugs in other OSes which this implementation does not trigger. .Pp One cannot both use the .Fl h , .Fl c and .Fl f options and specify URLs on the command line. Index: head/usr.bin/gprof/gprof.1 =================================================================== --- head/usr.bin/gprof/gprof.1 (revision 235210) +++ head/usr.bin/gprof/gprof.1 (revision 235211) @@ -1,328 +1,328 @@ .\" Copyright (c) 1983, 1990, 1993 .\" The Regents of the University of California. 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. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. .\" .\" @(#)gprof.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd December 25, 2008 .Dt GPROF 1 .Os .Sh NAME .Nm gprof .Nd display call graph profile data .Sh SYNOPSIS .Nm .Op Fl abKlLsuz .Op Fl C Ar count .Op Fl e Ar name .Op Fl E Ar name .Op Fl f Ar name .Op Fl F Ar name .Op Fl k Ar fromname toname .Op Ar a.out Op Ar a.out.gmon ... .Sh DESCRIPTION The .Nm utility produces an execution profile of C, Pascal, or Fortran77 programs. The effect of called routines is incorporated in the profile of each caller. The profile data is taken from the call graph profile file which is created by programs that are compiled with the .Fl pg option of .Xr cc 1 , .Xr pc 1 , and .Xr f77 1 . The .Fl pg option also links in versions of the library routines that are compiled for profiling. By convention these libraries have their name suffixed with .Pa _p , i.e., the profiled version of .Pa libc.a is .Pa libc_p.a and if you specify libraries directly to the compiler or linker you can use .Fl l Ns Ar c_p instead of .Fl l Ns Ar c . Read the given object file (the default is -.Pa a.out) +.Pa a.out ) and establishes the relation between its symbol table and the call graph profile. The default graph profile file name is the name of the executable with the suffix .Pa .gmon appended. If more than one profile file is specified, the .Nm output shows the sum of the profile information in the given profile files. .Pp The .Nm utility calculates the amount of time spent in each routine. Next, these times are propagated along the edges of the call graph. Cycles are discovered, and calls into a cycle are made to share the time of the cycle. The first listing shows the functions sorted according to the time they represent including the time of their call graph descendants. Below each function entry is shown its (direct) call graph children, and how their times are propagated to this function. A similar display above the function shows how this function's time and the time of its descendants is propagated to its (direct) call graph parents. .Pp Cycles are also shown, with an entry for the cycle as a whole and a listing of the members of the cycle and their contributions to the time and call counts of the cycle. .Pp Second, a flat profile is given, similar to that provided by .Xr prof 1 . This listing gives the total execution times, the call counts, the time that the call spent in the routine itself, and the time that the call spent in the routine itself including its descendants. The units for the per-call times are normally milliseconds, but they are nanoseconds if the profiling clock frequency is 10 million or larger, and if a function appears to be never called then its total self time is printed as a percentage in the self time per call column. The very high profiling clock frequencies needed to get sufficient accuracy in the per-call times for short-lived programs are only implemented for .Dq high resolution (non-statistical) kernel profiling. .Pp Finally, an index of the function names is provided. .Pp The following options are available: .Bl -tag -width indent .It Fl a Suppress the printing of statically declared functions. If this option is given, all relevant information about the static function (e.g., time samples, calls to other functions, calls from other functions) belongs to the function loaded just before the static function in the .Pa a.out file. .It Fl b Suppress the printing of a description of each field in the profile. .It Fl C Ar count Find a minimal set of arcs that can be broken to eliminate all cycles with .Ar count or more members. Caution: the algorithm used to break cycles is exponential, so using this option may cause .Nm to run for a very long time. .It Fl e Ar name Suppress the printing of the graph profile entry for routine .Ar name and all its descendants (unless they have other ancestors that are not suppressed). More than one .Fl e option may be given. Only one .Ar name may be given with each .Fl e option. .It Fl E Ar name Suppress the printing of the graph profile entry for routine .Ar name (and its descendants) as .Fl e , above, and also excludes the time spent in .Ar name (and its descendants) from the total and percentage time computations. (For example, .Fl E .Ar mcount .Fl E .Ar mcleanup is the default.) .It Fl f Ar name Print the graph profile entry of only the specified routine .Ar name and its descendants. More than one .Fl f option may be given. Only one .Ar name may be given with each .Fl f option. .It Fl F Ar name Print the graph profile entry of only the routine .Ar name and its descendants (as .Fl f , above) and also uses only the times of the printed routines in total time and percentage computations. More than one .Fl F option may be given. Only one .Ar name may be given with each .Fl F option. The .Fl F option overrides the .Fl E option. .It Fl k Ar fromname Ar toname Will delete any arcs from routine .Ar fromname to routine .Ar toname . This can be used to break undesired cycles. More than one .Fl k option may be given. Only one pair of routine names may be given with each .Fl k option. .It Fl K Gather information about symbols from the currently-running kernel using the .Xr sysctl 3 and .Xr kldsym 2 interfaces. This forces the .Pa a.out argument to be ignored, and allows for symbols in .Xr kld 4 modules to be used. .It Fl l Suppress the printing of the call-graph profile. .It Fl L Suppress the printing of the flat profile. .It Fl s A profile file .Pa gmon.sum is produced that represents the sum of the profile information in all the specified profile files. This summary profile file may be given to later executions of gprof (probably also with a .Fl s ) to accumulate profile data across several runs of an .Pa a.out file. .It Fl u Suppress the printing of functions whose names are not visible to C programs. For the ELF object format, this means names that contain the .Ql .\& character. For the a.out object format, it means names that do not begin with a .Ql _ character. All relevant information about such functions belongs to the (non-suppressed) function with the next lowest address. This is useful for eliminating "functions" that are just labels inside other functions. .It Fl z Display routines that have zero usage (as shown by call counts and accumulated time). .El .Sh FILES .Bl -tag -width a.out.gmon -compact .It Pa a.out The namelist and text space. .It Pa a.out.gmon Dynamic call graph and profile. .It Pa gmon.sum Summarized dynamic call graph and profile. .El .Sh SEE ALSO .Xr cc 1 , .Xr profil 2 , .Xr clocks 7 .\" .Xr monitor 3 , .\" .Xr prof 1 .Rs .%T "An Execution Profiler for Modular Programs" .%A S. Graham .%A P. Kessler .%A M. McKusick .%J "Software - Practice and Experience" .%V 13 .%P pp. 671-685 .%D 1983 .Re .Rs .%T "gprof: A Call Graph Execution Profiler" .%A S. Graham .%A P. Kessler .%A M. McKusick .%J "Proceedings of the SIGPLAN '82 Symposium on Compiler Construction, SIGPLAN Notices" .%V 17 .%N 6 .%P pp. 120-126 .%D June 1982 .Re .Sh HISTORY The .Nm profiler appeared in .Bx 4.2 . .Sh BUGS The granularity of the sampling is shown, but remains statistical at best. We assume that the time for each execution of a function can be expressed by the total time for the function divided by the number of times the function is called. Thus the time propagated along the call graph arcs to the function's parents is directly proportional to the number of times that arc is traversed. .Pp Parents that are not themselves profiled will have the time of their profiled children propagated to them, but they will appear to be spontaneously invoked in the call graph listing, and will not have their time propagated further. Similarly, signal catchers, even though profiled, will appear to be spontaneous (although for more obscure reasons). Any profiled children of signal catchers should have their times propagated properly, unless the signal catcher was invoked during the execution of the profiling routine, in which case all is lost. .Pp The profiled program must call .Xr exit 3 or return normally for the profiling information to be saved in the graph profile file. Index: head/usr.bin/ipcrm/ipcrm.1 =================================================================== --- head/usr.bin/ipcrm/ipcrm.1 (revision 235210) +++ head/usr.bin/ipcrm/ipcrm.1 (revision 235211) @@ -1,119 +1,119 @@ .\" Copyright (c) 1994 Adam Glass .\" 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. The name of the Author may not be used to endorse or promote products .\" derived from this software without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY Adam Glass ``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 Adam Glass 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$ .\"" .Dd December 12, 2007 .Dt IPCRM 1 .Os .Sh NAME .Nm ipcrm .Nd "remove the specified message queues, semaphore sets, and shared segments" .Sh SYNOPSIS .Nm .Op Fl W .Op Fl v .Op Fl q Ar msqid .Op Fl m Ar shmid .Op Fl s Ar semid .Op Fl Q Ar msgkey .Op Fl M Ar shmkey .Op Fl S Ar semkey .Ar ... .Sh DESCRIPTION The .Nm utility removes the specified message queues, semaphores and shared memory segments. These System V IPC objects can be specified by their creation ID or any associated key. .Pp The following options are generic: .Bl -tag -width indent .It Fl v If specified once with -W or with -1 for an object, it will show all removed objects. If specified twice with -W or with -1 for an objects, it will show all removed objects and all failed removals. .It Fl W Try to wipe all specified message queues, semaphores and shared memory segments. .It Fl y Use the .Xr kvm 3 interface instead of the .Xr sysctl 3 interface to extract the required information. If .Nm is to operate on the running system, using .Xr kvm 3 will require read privileges to .Pa /dev/kmem . .El .Pp The following options are used to specify which IPC objects will be removed. Any number and combination of these options can be used: .Bl -tag -width indent .It Fl q Ar msqid Remove the message queue associated with the ID .Ar msqid from the system. .It Fl m Ar shmid Mark the shared memory segment associated with ID .Ar shmid for removal. This marked segment will be destroyed after the last detach. .It Fl s Ar semid Remove the semaphore set associated with ID .Ar semid from the system. .It Fl Q Ar msgkey Remove the message queue associated with key .Ar msgkey from the system. .It Fl M Ar shmkey Mark the shared memory segment associated with key .Ar shmkey for removal. This marked segment will be destroyed after the last detach. .It Fl S Ar semkey Remove the semaphore set associated with key .Ar semkey from the system. .El .Pp The identifiers and keys associated with these System V IPC objects can be determined by using .Xr ipcs 1 . If the identifier or the key is -1, it will remove all these objects. .Sh SEE ALSO .Xr ipcs 1 .Sh HISTORY The wiping of all System V IPC objects was first implemented in -.Fx 6.4 and 7.1. +.Fx 6.4 No and 7.1. .Sh AUTHORS The original author was Adam Glass. The wiping of all System V IPC objects was thought up by Callum Gibson and extended and implemented by Edwin Groothuis. Index: head/usr.bin/join/join.1 =================================================================== --- head/usr.bin/join/join.1 (revision 235210) +++ head/usr.bin/join/join.1 (revision 235211) @@ -1,223 +1,223 @@ .\" Copyright (c) 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" the Institute of Electrical and Electronics Engineers, Inc. .\" .\" 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. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. .\" .\" @(#)join.1 8.3 (Berkeley) 4/28/95 .\" $FreeBSD$ .\" .Dd July 5, 2004 .Dt JOIN 1 .Os .Sh NAME .Nm join .Nd relational database operator .Sh SYNOPSIS .Nm .Oo .Fl a Ar file_number | Fl v Ar file_number .Oc .Op Fl e Ar string .Op Fl o Ar list .Op Fl t Ar char .Op Fl 1 Ar field .Op Fl 2 Ar field .Ar file1 .Ar file2 .Sh DESCRIPTION The .Nm utility performs an .Dq equality join on the specified files and writes the result to the standard output. The .Dq join field is the field in each file by which the files are compared. The first field in each line is used by default. There is one line in the output for each pair of lines in .Ar file1 and .Ar file2 which have identical join fields. Each output line consists of the join field, the remaining fields from .Ar file1 and then the remaining fields from .Ar file2 . .Pp The default field separators are tab and space characters. In this case, multiple tabs and spaces count as a single field separator, and leading tabs and spaces are ignored. The default output field separator is a single space character. .Pp Many of the options use file and field numbers. Both file numbers and field numbers are 1 based, i.e., the first file on the command line is file number 1 and the first field is field number 1. The following options are available: .Bl -tag -width indent .It Fl a Ar file_number In addition to the default output, produce a line for each unpairable line in file .Ar file_number . .It Fl e Ar string Replace empty output fields with .Ar string . .It Fl o Ar list The .Fl o option specifies the fields that will be output from each file for each line with matching join fields. Each element of .Ar list has either the form .Ar file_number . Ns Ar field , where .Ar file_number is a file number and .Ar field is a field number, or the form .Ql 0 .Pq zero , representing the join field. The elements of list must be either comma .Pq Ql \&, or whitespace separated. -(The latter requires quoting to protect it from the shell, or, a simpler +(The letter requires quoting to protect it from the shell, or, a simpler approach is to use multiple .Fl o options.) .It Fl t Ar char Use character .Ar char as a field delimiter for both input and output. Every occurrence of .Ar char in a line is significant. .It Fl v Ar file_number Do not display the default output, but display a line for each unpairable line in file .Ar file_number . The options .Fl v Cm 1 and .Fl v Cm 2 may be specified at the same time. .It Fl 1 Ar field Join on the .Ar field Ns 'th field of .Ar file1 . .It Fl 2 Ar field Join on the .Ar field Ns 'th field of .Ar file2 . .El .Pp When the default field delimiter characters are used, the files to be joined should be ordered in the collating sequence of .Xr sort 1 , using the .Fl b option, on the fields on which they are to be joined, otherwise .Nm may not report all field matches. When the field delimiter characters are specified by the .Fl t option, the collating sequence should be the same as .Xr sort 1 without the .Fl b option. .Pp If one of the arguments .Ar file1 or .Ar file2 is .Sq Fl , the standard input is used. .Sh EXIT STATUS .Ex -std .Sh COMPATIBILITY For compatibility with historic versions of .Nm , the following options are available: .Bl -tag -width indent .It Fl a In addition to the default output, produce a line for each unpairable line in both .Ar file1 and .Ar file2 . .It Fl j1 Ar field Join on the .Ar field Ns 'th field of .Ar file1 . .It Fl j2 Ar field Join on the .Ar field Ns 'th field of .Ar file2 . .It Fl j Ar field Join on the .Ar field Ns 'th field of both .Ar file1 and .Ar file2 . .It Fl o Ar list ... Historical implementations of .Nm permitted multiple arguments to the .Fl o option. These arguments were of the form .Ar file_number . Ns Ar field_number as described for the current .Fl o option. This has obvious difficulties in the presence of files named .Pa 1.2 . .El .Pp These options are available only so historic shell scripts do not require modification and should not be used. .Sh SEE ALSO .Xr awk 1 , .Xr comm 1 , .Xr paste 1 , .Xr sort 1 , .Xr uniq 1 .Sh STANDARDS The .Nm command conforms to .St -p1003.1-2001 . Index: head/usr.bin/limits/limits.1 =================================================================== --- head/usr.bin/limits/limits.1 (revision 235210) +++ head/usr.bin/limits/limits.1 (revision 235211) @@ -1,412 +1,412 @@ .\" Copyright (c) 1996 David Nugent .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, is permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice immediately at the beginning of the file, without modification, .\" 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. .\" 3. This work was done expressly for inclusion into FreeBSD. Other use .\" is permitted provided this notation is included. .\" 4. Absolutely no warranty of function or purpose is made by the author .\" David Nugent. .\" 5. Modifications may be freely made to this file providing the above .\" conditions are met. .\" .\" $FreeBSD$ .\" -.Dd January 23, 2011 +.Dd January 23, 2012 .Dt LIMITS 1 .Os .Sh NAME .Nm limits .Nd set or display process resource limits .Sh SYNOPSIS .Nm .Op Fl C Ar class | Fl P Ar pid | Fl U Ar user .Op Fl SHB .Op Fl ea .Op Fl bcdflmnstuvpw Op Ar val .Nm .Op Fl C Ar class | Fl U Ar user .Op Fl SHB .Op Fl bcdflmnstuvpw Op Ar val .Op Fl E .Oo .Op Ar name Ns = Ns Ar value ... .Ar command .Oc .Sh DESCRIPTION The .Nm utility either prints or sets kernel resource limits, and may optionally set environment variables like .Xr env 1 and run a program with the selected resources. Three uses of the .Nm utility are possible: .Bl -tag -width indent .It Xo .Nm .Op Ar limitflags .Op Ar name Ns = Ns Ar value ... .Ar command .Xc This usage sets limits according to .Ar limitflags , optionally sets environment variables given as .Ar name Ns = Ns Ar value pairs, and then runs the specified .Ar command . .It Nm Op Ar limitflags This usage determines values of resource settings according to .Ar limitflags , does not attempt to set them and outputs these values to standard output. By default, this will output the current kernel resource settings active for the calling process. Using the .Fl C Ar class or .Fl U Ar user options, you may also display the current resource settings modified by the appropriate login class resource limit entries from the .Xr login.conf 5 login capabilities database. .It Nm Fl e Op Ar limitflags This usage determines values of resource settings according to .Ar limitflags , but does not set them itself. Like the previous usage, it outputs these values to standard output, except that it will emit them in .Ic eval format, suitable for the calling shell. The calling shell is determined by examining the entries in the .Pa /proc file system for the parent process. If the shell is known (i.e., it is one of .Nm sh , csh , bash , tcsh , ksh , pdksh or .Nm rc ) , .Nm emits .Ic limit or .Ic ulimit commands in the format understood by that shell. If the name of the shell cannot be determined, then the .Ic ulimit format used by .Xr sh 1 is used. .Pp This is very useful for setting limits used by scripts, or prior launching of daemons and other background tasks with specific resource limit settings, and provides the benefit of allowing global configuration of maximum resource usage by maintaining a central database of settings in the login class database. .Pp Within a shell script, .Nm will normally be used with eval within backticks as follows: .Pp .Dl "eval `limits -e -C daemon`" .Pp which causes the output of .Nm to be evaluated and set by the current shell. .El .Pp The value of .Ar limitflags specified in the above contains one or more of the following options: .Bl -tag -width ".Fl C Ar class" .It Fl C Ar class Use current resource values, modified by the resource entries applicable for the login class .Ar class . .It Fl U Ar user Use current resource values, modified by the resource entries applicable to the login class the .Ar user belongs to. If user does not belong to any class, then the resource capabilities for the .Dq Li default class are used, if it exists, or the .Dq Li root class if the user is a superuser account. .It Fl P Ar pid Select or set limits for the process identified by the .Ar pid . .It Fl S Select display or setting of .Dq soft (or current) resource limits. If specific limits settings follow this switch, only soft limits are affected unless overridden later with either the .Fl H or .Fl B options. .It Fl H Select display or setting of .Dq hard (or maximum) resource limits. If specific limits settings follow this switch, only hard limits are affected until overridden later with either the .Fl S or .Fl B options. .It Fl B Select display or setting of both .Dq soft (current) or .Dq hard (maximum) resource limits. If specific limits settings follow this switch, both soft and hard limits are affected until overridden later with either the .Fl S or .Fl H options. -.Fl e +.It Fl e Select .Dq "eval mode" formatting for output. This is valid only on display mode and cannot be used when running a command. The exact syntax used for output depends upon the type of shell from which .Nm is invoked. .It Fl b Op Ar val Select or set the .Va sbsize resource limit. .It Fl c Op Ar val Select or set (if .Ar val is specified) the .Va coredumpsize resource limit. A value of 0 disables core dumps. .It Fl d Op Ar val Select or set (if .Ar val is specified) the .Va datasize resource limit. .It Fl f Op Ar val Select or set the .Va filesize resource limit. .It Fl l Op Ar val Select or set the .Va memorylocked resource limit. .It Fl m Op Ar val Select or set the .Va memoryuse size limit. .It Fl n Op Ar val Select or set the .Va openfiles resource limit. The system-wide limit on the maximum number of open files per process can be viewed by examining the .Va kern.maxfilesperproc .Xr sysctl 8 variable. The total number of simultaneously open files in the entire system is limited to the value displayed by the .Va kern.maxfiles .Xr sysctl 8 variable. .It Fl s Op Ar val Select or set the .Va stacksize resource limit. .It Fl t Op Ar val Select or set the .Va cputime resource limit. .It Fl u Op Ar val Select or set the .Va maxproc resource limit. The system-wide limit on the maximum number of processes allowed per UID can be viewed by examining the .Va kern.maxprocperuid .Xr sysctl 8 variable. The maximum number of processes that can be running simultaneously in the entire system is limited to the value of the .Va kern.maxproc .Xr sysctl 8 variable. .It Fl v Op Ar val Select or set the .Va virtualmem resource limit. This limit encompasses the entire VM space for the user process and is inclusive of text, data, bss, stack, .Xr brk 2 , .Xr sbrk 2 and .Xr mmap 2 Ns 'd space. .It Fl p Op Ar val Select or set the .Va pseudoterminals resource limit. .It Fl w Op Ar val Select or set the .Va swapuse resource limit. .El .Pp Valid values for .Ar val in the above set of options consist of either the string .Dq Li infinity , .Dq Li inf , .Dq Li unlimited or .Dq Li unlimit for an infinite (or kernel-defined maximum) limit, or a numeric value optionally followed by a suffix. Values which relate to size default to a value in bytes, or one of the following suffixes may be used as a multiplier: .Pp .Bl -tag -offset indent -width 4n -compact .It Li b 512 byte blocks. .It Li k kilobytes (1024 bytes). .It Li m megabytes (1024*1024 bytes). .It Li g gigabytes. .It Li t terabytes. .El .Pp The .Va cputime resource defaults to a number of seconds, but a multiplier may be used, and as with size values, multiple values separated by a valid suffix are added together: .Pp .Bl -tag -offset indent -width 4n -compact .It Li s seconds. .It Li m minutes. .It Li h hours. .It Li d days. .It Li w weeks. .It Li y 365 day years. .El .Bl -tag -width ".Fl C Ar class" .It Fl E Cause .Nm to completely ignore the environment it inherits. .It Fl a Force all resource settings to be displayed even if other specific resource settings have been specified. For example, if you wish to disable core dumps when starting up the Usenet News system, but wish to set all other resource settings as well that apply to the .Dq Li news account, you might use: .Pp .Dl "eval `limits -U news -aBec 0`" .Pp As with the .Xr setrlimit 2 call, only the superuser may raise process .Dq hard resource limits. Non-root users may, however, lower them or change .Dq soft resource limits within to any value below the hard limit. When invoked to execute a program, the failure of .Nm to raise a hard limit is considered a fatal error. .El .Sh EXIT STATUS The .Nm utility exits with .Dv EXIT_FAILURE if usage is incorrect in any way; i.e., an invalid option, or set/display options are selected in the same invocation, .Fl e is used when running a program, etc. When run in display or eval mode, .Nm exits with a status of .Dv EXIT_SUCCESS . When run in command mode and execution of the command succeeds, the exit status will be whatever the executed program returns. .Sh SEE ALSO .Xr csh 1 , .Xr env 1 , .Xr limit 1 , .Xr sh 1 , .Xr getrlimit 2 , .Xr setrlimit 2 , .Xr login_cap 3 , .Xr login.conf 5 , .Xr rctl 8 , .Xr sysctl 8 .Sh BUGS The .Nm utility does not handle commands with equal .Pq Ql = signs in their names, for obvious reasons. .Pp When eval output is selected, the .Pa /proc file system must be installed and mounted for the shell to be correctly determined, and therefore output syntax correct for the running shell. The default output is valid for .Xr sh 1 , so this means that any usage of .Nm in eval mode prior mounting .Pa /proc may only occur in standard bourne shell scripts. .Pp The .Nm utility makes no effort to ensure that resource settings emitted or displayed are valid and settable by the current user. Only a superuser account may raise hard limits, and when doing so the .Fx kernel will silently lower limits to values less than specified if the values given are too high. Index: head/usr.bin/ncplogin/ncplogout.1 =================================================================== --- head/usr.bin/ncplogin/ncplogout.1 (revision 235210) +++ head/usr.bin/ncplogin/ncplogout.1 (revision 235211) @@ -1,56 +1,56 @@ .\" $FreeBSD$ .Dd September 15, 1999 .Dt NCPLOGOUT 1 .Os .Sh NAME .Nm ncplogout .Nd schedule permanent connection to close .Sh SYNOPSIS .Nm .Op Fl S Ar server .Op Fl U Ar user .Op Fl c Ar handle .Nm .Op Fl c Ar handle .No / Ns Ar server Ns : Ns Ar user .Sh DESCRIPTION The .Nm utility will schedule a connection created by .Xr ncplogin 1 command to be closed. If the connection is busy (i.e., used by other processes) it will be closed when the last process using it is terminated. This command is similar to the .Tn DOS .Pa logout.exe command. .Pp The options are: .Bl -tag -width indent .It Fl S Ar server Specify the name of the -.Tn Netware +.Tn NetWare server to which the connection should be terminated. Can be omitted if there is only one connection active. .It Fl U Ar user Specify the name of the user to use when identifying the connection. Can be omitted if there is only one connection active. .It Fl c Ar handle Close a connection by handle. A list of available handles can be obtained with the following command: .Pp .Dl "ncplist c" .El .Sh HISTORY The .Nm utility first appeared in .Fx 4.0 . .Sh AUTHORS .An Boris Popov Aq bp@butya.kz , .Aq bp@FreeBSD.org .Sh BUGS Please report any bugs to the author. Index: head/usr.bin/tftp/tftp.1 =================================================================== --- head/usr.bin/tftp/tftp.1 (revision 235210) +++ head/usr.bin/tftp/tftp.1 (revision 235211) @@ -1,272 +1,272 @@ .\" Copyright (c) 1990, 1993, 1994 .\" The Regents of the University of California. 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. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. .\" .\" @(#)tftp.1 8.2 (Berkeley) 4/18/94 .\" $FreeBSD$ .\" .Dd June 22, 2011 .Dt TFTP 1 .Os .Sh NAME .Nm tftp .Nd trivial file transfer program .Sh SYNOPSIS .Nm .Op Ar host Op Ar port .Sh DESCRIPTION The .Nm utility is the user interface to the Internet .Tn TFTP (Trivial File Transfer Protocol), which allows users to transfer files to and from a remote machine. The remote .Ar host may be specified on the command line, in which case .Nm uses .Ar host as the default host for future transfers (see the .Cm connect command below). .Sh COMMANDS Once .Nm is running, it issues the prompt .Dq Li tftp> and recognizes the following commands: .Pp .Bl -tag -width verbose -compact .It Cm \&? Ar command-name ... Print help information. .Pp .It Cm ascii Shorthand for "mode ascii" .Pp .It Cm binary Shorthand for "mode binary" .Pp .It Cm blocksize Ar [size] Sets the TFTP blksize option in TFTP Read Request or Write Request packets to .Ar [size] as specified in RFC 2348. Valid values are between 8 and 65464. If no blocksize is specified, then by default a blocksize of 512 bytes will be used. .Pp .It Cm blocksize2 Ar [size] Sets the TFTP blksize2 option in TFTP Read Request or Write Request packets to .Ar [size] . Values are restricted to powers of 2 between 8 and 32768. This is a non-standard TFTP option. .Pp .It Cm connect Ar host Op Ar port Set the .Ar host (and optionally .Ar port ) for transfers. Note that the .Tn TFTP protocol, unlike the .Tn FTP protocol, does not maintain connections between transfers; thus, the .Cm connect command does not actually create a connection, but merely remembers what host is to be used for transfers. You do not have to use the .Cm connect command; the remote host can be specified as part of the .Cm get or .Cm put commands. .Pp .It Cm debug Ar level Enable or disable debugging levels during verbose output. The value of .Ar level can be one of -.Cm packet, simple, options, +.Cm packet , simple , options , or -.Cm access. +.Cm access . .Pp .It Cm get Oo Ar host : Oc Ns Ar file Op Ar localname .It Cm get Xo .Oo Ar host1 : Oc Ns Ar file1 .Oo Ar host2 : Oc Ns Ar file2 ... .Oo Ar hostN : Oc Ns Ar fileN .Xc Get one or more files from the remote host. When using the .Ar host argument, the .Ar host will be used as default host for future transfers. If .Ar localname is specified, the file is stored locally as .Ar localname , otherwise the original filename is used. Note that it is not possible to download two files at a time, only one, three, or more than three files, at a time. .Pp To specify an IPv6 numeric address for a host, wrap it using square brackets like .Dq Li [3ffe:2900:e00c:ffee::1234] : Ns Ar file to disambiguate the colons used in the IPv6 address from the colon separating the host and the filename. .Pp .It Cm mode Ar transfer-mode Set the mode for transfers; .Ar transfer-mode may be one of .Em ascii or .Em binary . The default is .Em ascii . .Pp .It Cm packetdrop [arg] Randomly drop .Ar arg out of 100 packets during a transfer. This is a debugging feature. .Pp .It Cm put Ar file Op Oo Ar host : Oc Ns Ar remotename .It Cm put Ar file1 file2 ... fileN Op Oo Ar host : Oc Ns Ar remote-directory Put a file or set of files to the remote host. When .Ar remotename is specified, the file is stored remotely as .Ar remotename , otherwise the original filename is used. If the .Ar remote-directory argument is used, the remote host is assumed to be a .Ux machine. To specify an IPv6 numeric address for a .Ar host , see the example under the .Cm get command. .Pp .It Cm options Ar [arg] Enable or disable support for TFTP options. The valid values of .Ar arg are .Cm on (enable RFC 2347 options), .Cm off (disable RFC 2347 options), and .Cm extra (toggle support for non-RFC defined options). .Pp .It Cm quit Exit .Nm . An end of file also exits. .Pp .It Cm rexmt Ar retransmission-timeout Set the per-packet retransmission timeout, in seconds. .Pp .It Cm rollover [arg] Specify the rollover option in TFTP Read Request or Write Request packets. After 65535 packets have been transmitted, set the block counter to .Ar arg . Valid values of .Ar arg are 0 and 1. This is a non-standard TFTP option. .Pp .It Cm status Show current status. .Pp .It Cm timeout Ar total-transmission-timeout Set the total transmission timeout, in seconds. .Pp .It Cm trace Toggle packet tracing. .Pp .It Cm verbose Toggle verbose mode. .El .Sh SEE ALSO .Xr tftpd 8 .Pp The following RFC's are supported: .Rs .%T RFC 1350: The TFTP Protocol (Revision 2) .Re .Rs .%T RFC 2347: TFTP Option Extension .Re .Rs .%T RFC 2348: TFTP Blocksize Option .Re .Rs .%T RFC 2349: TFTP Timeout Interval and Transfer Size Options .Re .Rs .%T RFC 3617: Uniform Resource Identifier (URI) Scheme and Applicability Statement for the Trivial File Transfer Protocol (TFTP) .Re .Pp The non-standard .Cm rollover and .Cm blksize2 TFTP options are mentioned here: .Rs .%T Extending TFTP .%U http://www.compuphase.com/tftp.htm .Re .Sh HISTORY The .Nm command appeared in .Bx 4.3 . .Pp Edwin Groothuis performed a major rewrite of the .Xr tftpd 8 and .Nm code to support RFC2348. .Sh NOTES Because there is no user-login or validation within the .Tn TFTP protocol, the remote site will probably have some sort of file-access restrictions in place. The exact methods are specific to each site and therefore difficult to document here. .Pp Files larger than 33488896 octets (65535 blocks) cannot be transferred without client and server supporting the TFTP blocksize option (RFC2348), or the non-standard TFTP rollover option. Index: head/usr.bin/who/who.1 =================================================================== --- head/usr.bin/who/who.1 (revision 235210) +++ head/usr.bin/who/who.1 (revision 235211) @@ -1,157 +1,157 @@ .\" Copyright (c) 1986, 1991, 1993 .\" The Regents of the University of California. 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. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. .\" .\" @(#)who.1 8.2 (Berkeley) 12/30/93 .\" $FreeBSD$ .\" .Dd February 11, 2012 .Dt WHO 1 .Os .Sh NAME .Nm who .Nd display who is on the system .Sh SYNOPSIS .Nm .Op Fl abHmqsTu .Op Cm am I .Op Ar file .Sh DESCRIPTION The .Nm utility displays information about currently logged in users. By default, this includes the login name, tty name, date and time of login and remote hostname if not local. .Pp The options are as follows: .Bl -tag -width indent .It Fl a Equivalent to .Fl bTu , with the exception that output isn't restricted to the time and date of the last system reboot. .It Fl b Write the time and date of the last system reboot. .It Fl H Write column headings above the output. .It Fl m Show information about the terminal attached to standard input only. .It Fl q .Dq "Quick mode" : List the names and number of logged in users in columns. All other command line options are ignored. .It Fl s Show the name, line and time fields only. This is the default. .It Fl T Indicate whether each user is accepting messages. One of the following characters is written: .Pp .Bl -tag -width 1n -compact .It Li + User is accepting messages. .It Li \&- User is not accepting messages. .It Li \&? An error occurred. .El .It Fl u Show idle time for each user in hours and minutes as .Ar hh Ns : Ns Ar mm , .Ql \&. -if the user has been idle less that a minute, and +if the user has been idle less than a minute, and .Dq Li old if the user has been idle more than 24 hours. .It Cm am I Equivalent to .Fl m . .El .Pp By default, .Nm gathers information from the file .Pa /var/run/utx.active . An alternate .Ar file may be specified which is usually .Pa /var/log/utx.log (or .Pa /var/log/utx.log.[0-6] depending on site policy as .Pa utx.log can grow quite large and daily versions may or may not be kept around after compression by .Xr ac 8 ) . The .Pa utx.log file contains a record of every login, logout, crash, shutdown and date change since .Pa utx.log was last truncated or created. .Pp If .Pa /var/log/utx.log is being used as the file, the user name may be empty or one of the special characters '|', '}' and '~'. Logouts produce an output line without any user name. For more information on the special characters, see .Xr getutxent 3 . .Sh ENVIRONMENT The .Ev COLUMNS , LANG , LC_ALL and .Ev LC_TIME environment variables affect the execution of .Nm as described in .Xr environ 7 . .Sh FILES .Bl -tag -width /var/log/utx.log.[0-6] -compact .It Pa /var/run/utx.active .It Pa /var/log/utx.log .It Pa /var/log/utx.log.[0-6] .El .Sh EXIT STATUS .Ex -std .Sh SEE ALSO .Xr last 1 , .Xr users 1 , .Xr w 1 , .Xr getutxent 3 .Sh STANDARDS The .Nm utility conforms to .St -p1003.1-2001 . .Sh HISTORY A .Nm command appeared in .At v1 . Index: head/usr.bin/whois/whois.1 =================================================================== --- head/usr.bin/whois/whois.1 (revision 235210) +++ head/usr.bin/whois/whois.1 (revision 235211) @@ -1,268 +1,268 @@ .\" Copyright (c) 1985, 1990, 1993 .\" The Regents of the University of California. 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. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. .\" .\" From: @(#)whois.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd October 2, 2009 .Dt WHOIS 1 .Os .Sh NAME .Nm whois .Nd "Internet domain name and network number directory service" .Sh SYNOPSIS .Nm .Op Fl aAbfgiIklmQrR .Op Fl c Ar country-code | Fl h Ar host .Op Fl p Ar port .Ar name ... .Sh DESCRIPTION The .Nm utility looks up records in the databases maintained by several Network Information Centers .Pq Tn NICs . .Pp The options are as follows: .Bl -tag -width indent .It Fl a Use the American Registry for Internet Numbers .Pq Tn ARIN database. It contains network numbers used in those parts of the world covered neither by .Tn APNIC , AfriNIC , LACNIC , nor by .Tn RIPE . .Pp (Hint: All point of contact handles in the .Tn ARIN whois database end with .Qq Li -ARIN . ) .Pp .It Fl A Use the Asia/Pacific Network Information Center .Pq Tn APNIC database. It contains network numbers used in East Asia, Australia, New Zealand, and the Pacific islands. .It Fl b Use the Network Abuse Clearinghouse database. It contains addresses to which network abuse should be reported, indexed by domain name. .It Fl c Ar country-code This is the equivalent of using the .Fl h option with an argument of .Qq Ar country-code Ns Li .whois-servers.net . .It Fl f Use the African Network Information Centre .Pq Tn AfriNIC database. It contains network numbers used in Africa and the islands of the western Indian Ocean. .It Fl g Use the US non-military federal government database, which contains points of contact for subdomains of .Pa .GOV . .It Fl h Ar host Use the specified host instead of the default variant. Either a host name or an IP address may be specified. .Pp By default .Nm constructs the name of a whois server to use from the top-level domain .Pq Tn TLD of the supplied (single) argument, and appending .Qq Li .whois-servers.net . This effectively allows a suitable whois server to be selected automatically for a large number of .Tn TLDs . .Pp In the event that an IP address is specified, the whois server will default to the American Registry for Internet Numbers .Pq Tn ARIN . If a query to .Tn ARIN references .Tn APNIC , AfriNIC , LACNIC , or .Tn RIPE , that server will be queried also, provided that the .Fl Q option is not specified. .Pp If the query is not a domain name or IP address, .Nm will fall back to .Pa whois.crsnic.net . .It Fl i Use the Network Solutions Registry for Internet Numbers .Pq Pa whois.networksolutions.com database. It contains network numbers and domain contact information for most of .Pa .COM , .NET , .ORG and .Pa .EDU domains. .Pp .Sy NOTE ! The registration of these domains is now done by a number of independent and competing registrars and this database holds no information on the domains registered by organizations other than Network Solutions, Inc. Also, note that the .Tn InterNIC database .Pq Pa whois.internic.net is no longer handled by Network Solutions, Inc. For details, see .Pa http://www.internic.net/ . .Pp (Hint: Contact information, identified by the term .Em handle , can be looked up by prefixing .Qq Li "handle " to the .Tn NIC handle in the query.) .It Fl I Use the Internet Assigned Numbers Authority .Pq Tn IANA database. It contains network information for top-level domains. .It Fl k Use the National Internet Development Agency of Korea's .Pq Tn KRNIC database. It contains network numbers and domain contact information for Korea. .It Fl l Use the Latin American and Caribbean IP address Regional Registry .Pq Tn LACNIC database. It contains network numbers used in much of Latin America and the Caribbean. .It Fl m Use the Route Arbiter Database .Pq Tn RADB database. It contains route policy specifications for a large number of operators' networks. .It Fl p Ar port Connect to the whois server on .Ar port . If this option is not specified, .Nm defaults to port 43. .It Fl Q Do a quick lookup. This means that .Nm will not attempt to lookup the name in the authoritative whois server (if one is listed). This option has no effect when combined with any other options. .It Fl r Use the R\(aaeseaux IP Europ\(aaeens .Pq Tn RIPE database. It contains network numbers and domain contact information for Europe. .It Fl R Use the Russia Network Information Center .Pq Tn RIPN database. It contains network numbers and domain contact information for subdomains of .Pa .RU . This option is deprecated; use the .Fl c option with an argument of .Qq Li RU instead. +.El .Pp The operands specified to .Nm are treated independently and may be used as queries on different whois servers. -.El .Sh EXIT STATUS .Ex -std .Sh EXAMPLES Most types of data, such as domain names and .Tn IP addresses, can be used as arguments to .Nm without any options, and .Nm will choose the correct whois server to query. Some exceptions, where .Nm will not be able to handle data correctly, are detailed below. .Pp To obtain contact information about an administrator located in the Russian .Tn TLD domain .Qq Li RU , use the .Fl c option as shown in the following example, where .Ar CONTACT-ID is substituted with the actual contact identifier. .Pp .Dl "whois -c RU CONTACT-ID" .Pp (Note: This example is specific to the .Tn TLD .Qq Li RU , but other .Tn TLDs can be queried by using a similar syntax.) .Pp The following example demonstrates how to query a whois server using a non-standard port, where .Dq Li query-data is the query to be sent to .Dq Li whois.example.com on port .Dq Li rwhois (written numerically as 4321). .Pp .Dl "whois -h whois.example.com -p rwhois query-data" .Sh SEE ALSO .Rs .%A Ken Harrenstien .%A Vic White .%T NICNAME/WHOIS .%D 1 March 1982 .%O RFC 812 .Re .Sh HISTORY The .Nm command appeared in .Bx 4.3 . Index: head/usr.sbin/pkg_install/updating/pkg_updating.1 =================================================================== --- head/usr.sbin/pkg_install/updating/pkg_updating.1 (revision 235210) +++ head/usr.sbin/pkg_install/updating/pkg_updating.1 (revision 235211) @@ -1,90 +1,90 @@ .\" .\" FreeBSD updating - Scan the installed ports and show all UPDATING entries .\" that affect one of the installed ports. Alternative a list of portnames .\" could be passed to pkg_updating .\" .\" "THE BEER-WARE LICENSE" (Revision 42): .\" wrote this file. As long as you retain this notice you .\" can do whatever you want with this stuff. If we meet some day, and you think .\" this stuff is worth it, you can buy me a beer in return. Beat Gätzi .\" .\" $FreeBSD$ .\" .Dd May 30, 2008 .Dt PKG_UPDATING 1 .Os .Sh NAME .Nm pkg_updating .Nd a utility for displaying UPDATING entries of software packages .Sh SYNOPSIS .Nm .Op Fl h .Op Fl d Ar date .Op Fl f Ar file .Op Ar pkg-name ... .Nm .Sh DESCRIPTION The .Nm command scans the installed ports and show all UPDATING entries that affect one of the installed ports. Alternative a list of pkg-names could be passed. .Sh OPTIONS The following command line options are supported: .Bl -tag -width indent .It Ar pkg-name ... UPDATING entries for the named packages are displayed. .It Fl d , -date Ar date Only entries newer than .Ar date are shown. Use a YYYYMMDD date format. .It Fl f , -file Ar file Defines a alternative location of the UPDATING .Ar file . .It Fl h , -help Print help message. .El .Sh ENVIRONMENT .Bl -tag -width PKG_DBDIR .It Ev PKG_DBDIR Specifies an alternative location for the installed package database. .It Ev PORTSDIR Location of the ports tree. .El .Sh FILES .Bl -tag -width /var/db/pkg -compact .It Pa /var/db/pkg Default location of the installed package database. .It Pa /usr/ports -The default ports directory and default location of the UPDATING file +The default ports directory and default location of the UPDATING file. .El .Sh EXAMPLES Shows all entries of all installed ports: .Dl % pkg_updating .Pp Shows all entries of all installed ports since 2007-01-01: .Dl % pkg_updating -d 20070101 .Pp Shows all entries for all apache and mysql ports: .Dl % pkg_updating apache mysql .Pp Shows all apache entries since 2006-01-01: .Dl % pkg_updating -d 20060101 apache .Pp Defines that the UPDATING file is in /tmp and shows all entries of all installed ports: .Dl % pkg_updating -f /tmp/UPDATING .Pp Fetch UPDATING file from ftp mirror and show all entries of all installed ports: .Dl % pkg_updating -f ftp://ftp.freebsd.org/pub/FreeBSD/ports/packages/UPDATING .Sh SEE ALSO .Xr pkg_add 1 , .Xr pkg_create 1 , .Xr pkg_delete 1 , .Xr pkg_version 1 .Sh AUTHORS .An Beat G\(:atzi Aq beat@chruetertee.ch .Sh CONTRIBUTORS .An Martin Tournoij Aq carpetsmoker@xs4all.nl .Sh BUGS Sure to be some.