Man Pages(1): User Commands

SunOS Reference Manual

Sun Microsystems, Inc. 2550 Garcia Avenue Mountain View, CA 94043 U.S.A.  1994 Sun Microsystems, Inc. 2550 Garcia Avenue, Mountain View, California 94043-1100 U.S.A. All rights reserved. This product or document is protected by copyright and distributed under licenses restricting its use, copying, distribution, and decompilation. No part of this product or document may be reproduced in any form by any means without prior written authorization of Sun and its licensors, if any. Portions of this product may be derived from the UNIX system, licensed from UNIX System Laboratories, Inc., a wholly owned subsidiary of Novell, Inc., and from the Berkeley 4.3 BSD system, licensed from the University of California. Third- party software, including font technology in this product, is protected by copyright and licensed from Sun’s suppliers. RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 and FAR 52.227-19. The product described in this manual may be protected by one or more U.S. patents, foreign patents, or pending applications. TRADEMARKS Sun, Sun Microsystems, the Sun logo, SunSoft, the SunSoft logo, Solaris, SunOS, OpenWindows, DeskSet, ONC, ONC+, and NFS are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. UNIX is a registered trademark in the United States and other countries, exclusively licensed through X/Open Company, Ltd. OPEN LOOK is a registered trademark of Novell, Inc. PostScript and Display PostScript are trademarks of Adobe Systems, Inc. All SPARC trademarks are trademarks or registered trademarks of SPARC International, Inc. in the United States and other countries. SPARCcenter, SPARCcluster, SPARCompiler, SPARCdesign, SPARC811, SPARCengine, SPARCprinter, SPARCserver, SPARCstation, SPARCstorage, SPARCworks, microSPARC, microSPARC-II, and UltraSPARC are licensed exclusively to Sun Microsystems, Inc. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc. The OPEN LOOK and Sun Graphical User Interfaces were developed by Sun Microsystems, Inc. for its users and licensees. Sun acknowledges the pioneering efforts of Xerox in researching and developing the concept of visual or graphical user interfaces for the computer industry. Sun holds a non-exclusive license from Xerox to the Xerox Graphical User Interface, which license also covers Sun’s licensees who implement OPEN LOOK GUIs and otherwise comply with Sun’s written license agreements. X Window System is a trademark of the X Consortium. THIS PUBLICATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS PUBLICATION COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN. THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THE PUBLICATION. SUN MICROSYSTEMS, INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAMS(S) DESCRIBED IN THIS PUBLICATION AT ANY TIME. Portions  AT&T 1983-1990 and reproduced with permission from AT&T. Preface

OVERVIEW A man page is provided for both the naive user, and sophisticated user who is familiar with the SunOS operating system and is in need of on-line information. A man page is intended to answer concisely the question “What does it do?” The man pages in general comprise a reference manual. They are not intended to be a tutorial. The following contains a brief description of each section in the man pages and the information it references:

· Section 1 describes, in alphabetical order, commands available with the operating system.

· Section 1M describes, in alphabetical order, commands that are used chieﬂy for system maintenance and administration purposes.

· Section 2 describes all of the system calls. Most of these calls have one or more error returns. An error condition is indicated by an otherwise impossible returned value.

· Section 3 describes functions found in various libraries, other than those functions that directly invoke UNIX system primitives, which are described in Section 2 of this volume.

i · Section 4 outlines the formats of various ﬁles. The C structure declarations for the ﬁle formats are given where applicable.

· Section 5 contains miscellaneous documentation such as character set tables, etc.

· Section 6 contains available games and demos.

· Section 7 describes various special ﬁles that refer to speciﬁc hardware peripherals, and device drivers. STREAMS software drivers, modules and the STREAMS-generic set of system calls are also described.

· Section 9 provides reference information needed to write device drivers in the kernel operating systems environment. It describes two device driver interface speciﬁcations: the Device Driver Interface (DDI) and the Driver–Kernel Interface (DKI).

· Section 9E describes the DDI/DKI, DDI-only, and DKI-only entry-point routines a developer may include in a device driver.

· Section 9F describes the kernel functions available for use by device drivers.

· Section 9S describes the data structures used by drivers to share information between the driver and the kernel. Below is a generic format for man pages. The man pages of each manual section generally follow this order, but include only needed headings. For example, if there are no bugs to report, there is no BUGS section. See the intro pages for more information and detail about each section, and man(1) for more information about man pages in general.

NAME This section gives the names of the commands or functions documented, followed by a brief description of what they do.

SYNOPSIS This section shows the syntax of commands or functions. When a command or file does not exist in the standard path, its full pathname is shown. Literal characters (commands and options) are in bold font and variables (arguments, parameters and substitution characters) are in italic font. Options and ii arguments are alphabetized, with single letter arguments first, and options with arguments next, unless a different argument order is required. The following special characters are used in this section: [ ] The option or argument enclosed in these brackets is optional. If the brackets are omitted, the argument must be specified. . . . Ellipses. Several values may be provided for the previous argument, or the previous argument can be specified multiple times, for example, ‘filename . . .’. | Separator. Only one of the arguments separated by this character can be specified at time. { } Braces. The options and/or arguments enclosed within braces are interdependent, such that everything enclosed must be treated as a unit.

PROTOCOL This section occurs only in subsection 3R to indicate the protocol description ﬁle. The protocol speciﬁcation pathname is always listed in bold font.

AVAILABILITY This section briefly states any limitations on the availabilty of the command. These limitations could be hardware or software specific. A specification of a class of hardware platform, such as x86 or SPARC, denotes that the command or interface is applicable for the hardware platform specified. In Section 1 and Section 1M, AVAILABILITY indicates which package contains the command being described on the manual page. In order to use the command, the specified package must have been installed with the operating system. If the package was not installed, see pkgadd(1) for information on how to upgrade.

MT-LEVEL This section lists the MT-LEVEL of the library functions described in the Section 3 manual pages. The MT-LEVEL deﬁnes the libraries’ ability to support threads. See Intro(3) for more information.

Preface iii DESCRIPTION This section deﬁnes the functionality and behavior of the service. Thus it describes concisely what the command does. It does not discuss OPTIONS or cite EXAMPLES. Interactive commands, subcommands, requests, macros, functions and such, are described under USAGE.

IOCTL This section appears on pages in Section 7 only. Only the device class which supplies appropriate parameters to the ioctl(2) system call is called ioctl and generates its own heading. ioctl calls for a speciﬁc device are listed alphabetically (on the man page for that speciﬁc device). ioctl calls are used for a particular class of devices all of which have an io ending, such as mtio(7).

OPTIONS This lists the command options with a concise summary of what each option does. The options are listed literally and in the order they appear in the SYNOPSIS section. Possible arguments to options are discussed under the option, and where appropriate, default values are supplied.

OPERANDS This section lists the command operands and describes how they affect the actions of the command.

OUTPUT This section describes the output - standard output, standard error, or output ﬁles - generated by the command.

RETURN VALUES If the man page documents functions that return values, this section lists these values and describes the conditions under which they are returned. If a function can return only constant values, such as 0 or −1, these values are listed in tagged paragraphs. Otherwise, a single paragraph describes the return values of each function. Functions declared as void do not return values, so they are not discussed in RETURN VALUES.

iv ERRORS On failure, most functions place an error code in the global variable errno indicating why they failed. This section lists alphabetically all error codes a function can generate and describes the conditions that cause each error. When more than one condition can cause the same error, each condition is described in a separate paragraph under the error code.

USAGE This section is provided as a guidance on use. This section lists special rules, features and commands that require in-depth explanations. The subsections listed below are used to explain built-in functionality: Commands Modiﬁers Variables Expressions Input Grammar

EXAMPLES This section provides examples of usage or of how to use a command or function. Wherever possible a complete example including command line entry and machine response is shown. Whenever an example is given, the prompt is shown as example% or if the user must be super-user, example# Examples are followed by explanations, variable substitution rules, or returned values. Most examples illustrate concepts from the SYNOPSIS, DESCRIPTION, OPTIONS and USAGE sections.

ENVIRONMENT This section lists any environment variables that the command or function affects, followed by a brief description of the effect.

Preface v EXIT STATUS This section lists the values the command returns to the calling program or shell and the conditions that cause these values to be returned. Usually, zero is returned for successful completion and values greater than zero for various error conditions.

FILES This section lists all filenames referred to by the man page, files of interest, and files created or required by commands. Each is followed by a descriptive summary or explanation.

SEE ALSO This section lists references to other man pages, in-house documentation and outside publications.

DIAGNOSTICS This section lists diagnostic messages with a brief explanation of the condition causing the error. Messages appear in bold font with the exception of variables, which are in italic font.

WARNINGS This section lists warnings about special conditions which could seriously affect your working conditions — this is not a list of diagnostics.

NOTES This section lists additional information that does not belong anywhere else on the page. It takes the form of an aside to the user, covering points of special interest. Critical information is never covered here.

BUGS This section describes known bugs and wherever possible suggests workarounds.

vi SunOS 5.5 User Commands Intro ( 1 )

NAME Intro, intro − introduction to commands and application programs

AVAILABILITY This section indicates which package contains the commands being described on this page. To be able to use the command, the indicated package must have been installed with the operating system. For information on how to add a package see pkgadd(1).

DESCRIPTION This section describes, in alphabetical order, commands available with this operating system. Pages of special interest are categorized as follows: 1B Commands found only in the SunOS/BSD Compatibility Package. Refer to the Source Compatibility Guide for more information. 1C Commands for communicating with other systems. 1F Commands associated with Form and Menu Language Interpreter (FMLI). 1S Commands speciﬁc to the SunOS system.

OTHER SECTIONS See these sections of the man Pages(1M): System Administration Commands for more information. · Section 1M in this manual for system maintenance commands. · Section 4 of this manual for information on ﬁle formats. · Section 5 of this manual for descriptions of publicly available ﬁles and miscellaneous information pages. · Section 6 in this manual for computer demonstrations. For tutorial information about these commands and procedures, see: · Solaris Advanced User's Guide · Programming Utilities Guide

Manual Page Unless otherwise noted, commands described in the SYNOPSIS section of a manual page Command Syntax accept options and other arguments according to the following syntax and should be interpreted as explained below. name [−option...] [cmdarg...] where: [ ] Surround an option or cmdarg that is not required. ... Indicates multiple occurrences of the option or cmdarg . name The name of an executable ﬁle. { } The options and/or arguments enclosed within braces are interdependent, such that everything enclosed must be treated as a unit. option (Always preceded by a “−”.) noargletter ... or, argletter optarg[,...] modiﬁed 24 Feb 1993 1-5 Intro ( 1 ) User Commands SunOS 5.5

noargletter A single letter representing an option without an option-argument. Note that more than one noargletter option can be grouped after one “−” (Rule 5, below). argletter A single letter representing an option requiring an option-argument. optarg An option-argument (character string) satisfying a preceding argletter. Note that groups of optargs following an argletter must be separated by commas, or separated by a tab or space character and quoted (Rule 8, below). cmdarg Path name (or other command argument) not beginning with “−”, or “−” by itself indicating the standard input.

Command Syntax These command syntax rules are not followed by all current commands, but all new com- Standard: Rules mands will obey them. getopts(1) should be used by all shell procedures to parse posi- tional parameters and to check for legal options. It supports Rules 3-10 below. The enforcement of the other rules must be done by the command itself. 1. Command names (name above) must be between two and nine characters long. 2. Command names must include only lower-case letters and digits. 3. Option names (option above) must be one character long. 4. All options must be preceded by “−”. 5. Options with no arguments may be grouped after a single “−”. 6. The ﬁrst option-argument (optarg above) following an option must be preceded by a tab or space character. 7. Option-arguments cannot be optional. 8. Groups of option-arguments following an option must either be separated by commas or separated by tab or space character and quoted (−o xxx,z,yy or −o "xxx z yy"). 9. All options must precede operands (cmdarg above) on the command line. 10. “−−−−” may be used to indicate the end of the options. 11. The order of the options relative to one another should not matter. 12. The relative order of the operands (cmdarg above) may affect their signiﬁcance in ways determined by the command with which they appear. 13. “−” preceded and followed by a space character should only be used to mean standard input.

SEE ALSO getopts(1), wait(1), exit(2), getopt(3C), wait(3B)

1-6 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

DIAGNOSTICS Upon termination, each command returns two bytes of status, one supplied by the system and giving the cause for termination, and (in the case of “normal” termination) one supplied by the program [see wait(3B) and exit(2)]. The former byte is 0 for normal termination; the latter is customarily 0 for successful execution and non-zero to indicate troubles such as erroneous parameters, or bad or inaccessible data. It is called variously “exit code”, “exit status”, or “return code”, and is described only where special conven- tions are involved.

WARNINGS Some commands produce unexpected results when processing ﬁles containing null characters. These commands often treat text input lines as strings and therefore become con- fused upon encountering a null character (the string terminator) within a line.

Name Description

acctcom(1) search and print process accounting files adb(1) general-purpose debugger addbib(1) create or extend a bibliographic database admin(1) See sccs-admin(1) aedplot(1B) See plot(1B) alias(1) create or remove a pseudonym or shorthand for a command or series of commands apropos(1) locate commands by keyword lookup ar(1) maintain portable archive or library arch(1) display the architecture of the current host as(1) assembler asa(1) convert FORTRAN carriage-control output to printable form at(1) execute commands at a later time atoplot(1B) See plot(1B) atq(1) display the jobs queued to run at specified times atrm(1) remove jobs spooled by at or batch audioconvert(1) convert audio file formats audioplay(1) play audio files audiorecord(1) record an audio file awk(1) pattern scanning and processing language banner(1) make posters basename(1) deliver portions of path names basename(1B) display portions of pathnames modified 24 Feb 1993 1-7 Intro ( 1 ) User Commands SunOS 5.5

batch(1) See at(1) bc(1) arbitrary precision arithmetic language bdiff(1) big diff bg(1) See jobs(1) bgplot(1B) See plot(1B) biff(1B) give notice of incoming mail messages break(1) shell built-in functions to escape from or advance within a controlling while, for, foreach, or until loop cal(1) display a calendar calendar(1) reminder service cancel(1) See lp(1) case(1) shell built-in functions to choose from among a list of actions cat(1) concatenate and display files cc(1B) C compiler cd(1) change working directory cdc(1) See sccs-cdc(1) chdir(1) See cd(1) checkeq(1) See eqn(1) checknr(1) check nroff and troff input files; report possible errors chgrp(1) change file group ownership chkey(1) change user’s secure RPC key pair chmod(1) change the permissions mode of a file chown(1) change file ownership chown(1B) change owner ckdate(1) prompts for and validates a date ckgid(1) prompts for and validates a group id ckint(1) display a prompt; verify and return an integer value ckitem(1) build a menu; prompt for and return a menu item ckkeywd(1) prompts for and validates a keyword ckpath(1) display a prompt; verify and return a pathname ckrange(1) prompts for and validates an integer ckstr(1) display a prompt; verify and return a string answer cksum(1) write file checksums and sizes cktime(1) display a prompt; verify and return a time of day ckuid(1) prompts for and validates a user ID

1-8 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

ckyorn(1) prompts for and validates yes/no clear(1) clear the terminal screen cmp(1) compare two files cocheck(1F) See coproc(1F) cocreate(1F) See coproc(1F) codestroy(1F) See coproc(1F) col(1) reverse line-feeds filter comb(1) See sccs-comb(1) comm(1) select or reject lines common to two files command(1) execute a simple command compress(1) compress, uncompress files or display expanded files continue(1) See break(1) coproc(1F) communicate with a process coreceive(1F) See coproc(1F) cosend(1F) See coproc(1F) cp(1) copy files cpio(1) copy file archives in and out cpp(1) the C language preprocessor crontab(1) user crontab file crtplot(1B) See plot(1B) crypt(1) encode or decode a file csh(1) shell command interpreter with a C-like syntax csplit(1) split files based on context ct(1C) spawn login to a remote terminal ctags(1) create a tags file for use with ex and vi cu(1C) call another UNIX system cut(1) cut out selected fields of each line of a file date(1) write the date and time dc(1) desk calculator delta(1) See sccs-delta(1) deroff(1) remove nroff/troff, tbl, and eqn constructs df(1B) display status of disk space on file systems diff(1) display line-by-line differences between pairs of text files diff3(1) 3-way differential file comparison modified 24 Feb 1993 1-9 Intro ( 1 ) User Commands SunOS 5.5

diffmk(1) mark differences between versions of a troff input file dircmp(1) directory comparison dirname(1) See basename(1) dirs(1) See cd(1) dis(1) object code disassembler disable(1) See enable(1) dispgid(1) displays a list of all valid group names dispuid(1) displays a list of all valid user names dos2unix(1) convert text file from DOS format to ISO format download(1) host resident PostScript font downloader dpost(1) troff postprocessor for PostScript printers du(1B) display the number of disk blocks used per directory or file dumbplot(1B) See plot(1B) dump(1) dump selected parts of an object file dumpcs(1) show codeset table for the current locale dumpkeys(1) See loadkeys(1) echo(1) echo arguments echo(1B) echo arguments to standard output echo(1F) put string on virtual output ed(1) text editor edit(1) text editor (variant of ex for casual users) egrep(1) search a file for a pattern using full regular expressions eject(1) eject media such as CD-ROM and floppy from drive enable(1) enable/disable LP printers env(1) obtain or alter environment variables for command execution eqn(1) typeset mathematics test errange(1) See ckrange(1) errdate(1) See ckdate(1) errgid(1) See ckgid(1) errint(1) See ckint(1) erritem(1) See ckitem(1) error(1) insert compiler error messages at right source lines errpath(1) See ckpath(1)

1-10 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

errstr(1) See ckstr(1) errtime(1) See cktime(1) erruid(1) See ckuid(1) erryorn(1) See ckyorn(1) eval(1) See exec(1) ex(1) text editor exec(1) shell built-in functions to execute other commands exit(1) shell built-in functions to enable the execution of the shell to advance beyond its sequence of steps expand(1) expand TAB characters to SPACE characters, and vice versa export(1) See set(1) exportfs(1B) translates exportfs options to share/unshare commands expr(1) evaluate arguments as an expression expr(1B) evaluate arguments as a logical, arithmetic, or string expression exstr(1) extract strings from source files face(1) executable for the Framed Access Command Environment Interface factor(1) obtain the prime factors of a number false(1) See true(1) fastboot(1B) reboot/halt the system without checking the disks fasthalt(1B) See fastboot(1B) fc(1) See history(1) fdformat(1) format floppy diskette or PCMCIA memory card fg(1) See jobs(1) fgrep(1) search a file for a character string file(1) determine file type file(1B) determine the type of a file by examining its contents find(1) find files finger(1) display information about local and remote users fmlcut(1F) cut out selected fields of each line of a file fmlexpr(1F) evaluate arguments as an expression fmlgrep(1F) search a file for a pattern fmli(1) invoke FMLI modified 24 Feb 1993 1-11 Intro ( 1 ) User Commands SunOS 5.5

fmt(1) simple text formatters fmtmsg(1) display a message on stderr or system console fnattr(1) Update and examine attributes associated with an FNS named object fnbind(1) Bind a reference to an FNS name fnlist(1) Display the names and references bound in an FNS context fnlookup(1) Display the reference bound to an FNS name fnrename(1) Rename the binding of an FNS name fnunbind(1) Unbind the reference from an FNS name fold(1) filter for folding lines for(1) shell built-in functions to repeatedly execute action(s) for a selected number of times foreach(1) See for(1) from(1B) display the sender and date of newly-arrived mail messages ftp(1) file transfer program function(1) shell built-in command to define a function which is usable within this shell gcore(1) get core images of running processes gencat(1) generate a formatted message catalog get(1) See sccs-get(1) getconf(1) get configuration values getfacl(1) display discretionary information for a file or files getfrm(1F) returns the current frameID number getitems(1F) returns a list of currently marked menu items getopt(1) parse command options getoptcvt(1) convert to getopts to parse command options getopts(1) parse utility options gettext(1) retrieve text string from message database gettxt(1) retrieve a text string from a message database gigiplot(1B) See plot(1B) glob(1) shell built-in function to expand a word list goto(1) See exit(1) gprof(1) display call-graph profile data graph(1) draw a graph

1-12 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

grep(1) search a file for a pattern groups(1) print group membership of user groups(1B) display a user’s group memberships grpck(1B) check group database entries hash(1) evaluate the internal hash table of the contents of directories hashstat(1) See hash(1) head(1) display first few lines of files help(1) See sccs-help(1) helpdate(1) See ckdate(1) helpgid(1) See ckgid(1) helpint(1) See ckint(1) helpitem(1) See ckitem(1) helppath(1) See ckpath(1) helprange(1) See ckrange(1) helpstr(1) See ckstr(1) helptime(1) See cktime(1) helpuid(1) See ckuid(1) helpyorn(1) See ckyorn(1) history(1) process command history list hostid(1) print the numeric identifier of the current host hostname(1) set or print name of current host system hp7221plot(1B) See plot(1B) hpplot(1B) See plot(1B) i286(1) See machid(1) i386(1) See machid(1) i486(1) See machid(1) i860(1) See machid(1) iAPX286(1) See machid(1) iconv(1) code set conversion utility if(1) evaluate condition(s) or make execution of actions dependent upon the evaluation of condition(s) implot(1B) See plot(1B) indicator(1F) display application specific alarms and/or the "working" indicator indxbib(1) create an inverted index to a bibliographic database modified 24 Feb 1993 1-13 Intro ( 1 ) User Commands SunOS 5.5

install(1B) install files ipcrm(1) remove a message queue, semaphore set, or shared memory ID ipcs(1) report inter-process communication facilities status jobs(1) control process execution join(1) relational database operator jsh(1) See sh(1) kbd(1) manipulate the state of keyboard or display the type of keyboard kdestroy(1) destroy Kerberos tickets kerberos(1) introduction to the Kerberos system keylogin(1) decrypt and store secret key with keyserv keylogout(1) delete stored secret key with keyserv kill(1) terminate or signal processes kinit(1) Kerberos login utility klist(1) list currently held Kerberos tickets ksh(1) KornShell, a standard/restricted command and programming language ksrvtgt(1) fetch and store Kerberos ticket-granting ticket using a service key last(1) display login and logout information about users and terminals lastcomm(1) display the last commands executed, in reverse order ld(1) link editor for object files ld(1B) link editor, dynamic link editor ldd(1) list dynamic dependencies of executable files or shared objects let(1) shell built-in function to evaluate one or more arithmetic expressions lex(1) generate programs for lexical tasks limit(1) set or get limitations on the system resources available to the current shell and its descendents line(1) read one line lint(1B) C program verifier listusers(1) list user login information ln(1) make hard or symbolic links to files ln(1B) make hard or symbolic links to files

1-14 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

loadfont(1) display or change font information in the RAM of the video card on an x86 system in text mode loadkeys(1) load and dump keyboard translation tables locale(1) get locale-specific information localedef(1) define locale environment logger(1) add entries to the system log logger(1B) add entries to the system log login(1) sign on to the system logname(1) return user’s login name logout(1) shell built-in function to exit from a login session longline(1F) See readfile(1F) look(1) find words in the system dictionary or lines in a sorted list lookbib(1) find references in a bibliographic database lorder(1) find ordering relation for an object or library archive lp(1) send/cancel requests to an LP print service lpc(1B) line printer control program lpq(1B) display the queue of printer jobs lpr(1B) send a job to the printer lprm(1B) remove jobs from the printer queue lpstat(1) print information about the status of the LP print service lptest(1B) generate lineprinter ripple pattern ls(1) list contents of directory ls(1B) list the contents of a directory m4(1) macro processor mach(1) display the processor type of the current host machid(1) get processor type truth value mail(1) read mail or send mail to users Mail(1B) See mailx(1) mail(1B) See mailx(1) mailcompat(1) provide SunOS compatibility for Solaris mailbox format mailstats(1) print statistics collected by sendmail mailx(1) interactive message processing system make(1S) maintain, update, and regenerate related programs modified 24 Feb 1993 1-15 Intro ( 1 ) User Commands SunOS 5.5

and files man(1) find and display reference manual pages mconnect(1) connect to SMTP mail server socket mcs(1) manipulate the comment section of an object file mesg(1) permit or deny messages message(1F) puts its arguments on FMLI message line mkdir(1) make directories mkmsgs(1) create message files for use by gettxt mkstr(1B) create an error message file by massaging C source files more(1) browse or page through a text file msgfmt(1) create a message object from a message file mt(1) magnetic tape control mv(1) move files nawk(1) pattern scanning and processing language neqn(1) See eqn(1) newaliases(1) rebuild the data base for the mail aliases file newform(1) change the format of a text file newgrp(1) log in to a new group news(1) print news items nice(1) run a command at a different priority nis+(1) a new version of the network information name service NIS+(1) See nis+(1) nis(1) See nis+(1) niscat(1) display NIS+ tables and objects nischgrp(1) change the group owner of a NIS+ object nischmod(1) change access rights on a NIS+ object nischown(1) change the owner of a NIS+ object nischttl(1) change the time to live value of a NIS+ object nisdefaults(1) display NIS+ default values niserror(1) display NIS+ error messages nisgrep(1) See nismatch(1) nisgrpadm(1) NIS+ group administration command nisln(1) symbolically link NIS+ objects nisls(1) list the contents of a NIS+ directory

1-16 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

nismatch(1) utilities for searching NIS+ tables nismkdir(1) create NIS+ directories nispasswd(1) change NIS+ password information nisrm(1) remove NIS+ objects from the namespace nisrmdir(1) remove NIS+ directories nistbladm(1) NIS+ table administration command nistest(1) return the state of the NIS+ namespace using a condi- tional expression nl(1) line numbering filter nm(1) print name list of an object file nohup(1) run a command immune to hangups notify(1) See jobs(1) nroff(1) format documents for display or line-printer od(1) octal dump on(1) execute a command on a remote system, but with the local environment onintr(1) See trap(1) pack(1) compress and expand files page(1) See more(1) pagesize(1) display the size of a page of memory passwd(1) change login password and password attributes paste(1) merge corresponding or subsequent lines of files patch(1) apply changes to files pathchk(1) check path names pathconv(1F) search FMLI criteria for filename pax(1) portable archive interchange pcat(1) See pack(1) pcmapkeys(1) set keyboard extended map and scancode translation for the PC console in text mode pcred(1) See proc(1) pdp11(1) See machid(1) pfiles(1) See proc(1) pflags(1) See proc(1) pg(1) files perusal filter for CRTs pkginfo(1) display software package information pkgmk(1) produce an installable package modified 24 Feb 1993 1-17 Intro ( 1 ) User Commands SunOS 5.5

pkgparam(1) displays package parameter values pkgproto(1) generate prototype file entries for input to pkgmk command pkgtrans(1) translate package format pldd(1) See proc(1) plot(1B) graphics filters for various plotters plottoa(1B) See plot(1B) pmap(1) See proc(1) popd(1) See cd(1) postdaisy(1) PostScript translator for Diablo 630 daisy-wheel files postdmd(1) PostScript translator for DMD bitmap files postio(1) serial interface for PostScript printers postmd(1) matrix display program for PostScript printers postplot(1) PostScript translator for plot(4) graphics files postprint(1) PostScript translator for text files postreverse(1) reverse the page order in a PostScript file posttek(1) PostScript translator for Tektronix 4014 files pr(1) print files prex(1) probe external control print(1) shell built-in function to output characters to the screen or window printenv(1B) display environment variables currently set printf(1) write formatted output priocntl(1) display or set scheduling parameters of specified process(es) proc(1) proc tools prof(1) display profile data prs(1) See sccs-prs(1) prt(1) See sccs-prt(1) prun(1) See proc(1) ps(1) report process status ps(1B) display the status of current processes psig(1) See proc(1) pstack(1) See proc(1) pstop(1) See proc(1) ptime(1) See proc(1)

1-18 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

ptree(1) See proc(1) pushd(1) See cd(1) pvs(1) display the internal version information of dynamic objects pwait(1) See proc(1) pwd(1) return working directory name pwdx(1) See proc(1) ranlib(1) convert archives to random libraries rcp(1) remote file copy rdist(1) remote file distribution program read(1) read a line from standard input readfile(1F) reads file, gets longest line readonly(1) shell built-in function to protect the value of the given variable from reassignment red(1) See ed(1) refer(1) expand and insert references from a bibliographic database regcmp(1) regular expression compile regex(1F) match patterns against a string rehash(1) See hash(1) reinit(1F) runs an initialization file remote_shell(1) See rsh(1) remsh(1) See rsh(1) renice(1) alter priority of running processes repeat(1) See for(1) reset(1B) See tset(1B) reset(1F) reset the current form field to its default values return(1) See exit(1) rksh(1) See ksh(1) rlogin(1) remote login rm(1) remove directory entries rmail(1) See mail(1) rmdel(1) See sccs-rmdel(1) rmdir(1) See rm(1) roffbib(1) format and print a bibliographic database rpcgen(1) an RPC protocol compiler modified 24 Feb 1993 1-19 Intro ( 1 ) User Commands SunOS 5.5

rsh(1) remote shell run(1F) run an executable rup(1) show host status of remote machines (RPC version) rup(1C) show host status of remote machines (RPC version) ruptime(1) show host status of local machines rusage(1B) print resource usage for a command rusers(1) who’s logged in on remote machines rwho(1) who’s logged in on local machines sact(1) See sccs-sact(1) sag(1) system activity graph sar(1) system activity reporter sccs(1) front end for the Source Code Control System (SCCS) sccs-admin(1) create and administer SCCS history files sccs-cdc(1) change the delta commentary of an SCCS delta sccs-comb(1) combine SCCS deltas sccs-delta(1) make a delta to an SCCS file sccsdiff(1) See sccs-sccsdiff(1) sccs-get(1) retrieve a version of an SCCS file sccs-help(1) ask for help regarding SCCS error or warning messages sccs-prs(1) display selected portions of an SCCS history sccs-prt(1) display delta table information from an SCCS file sccs-rmdel(1) remove a delta from an SCCS file sccs-sact(1) show editing activity status of an SCCS file sccs-sccsdiff(1) compare two versions of an SCCS file sccs-unget(1) undo a previous get of an SCCS file sccs-val(1) validate an SCCS file script(1) make record of a terminal session sdiff(1) print differences between two files side-by-side sed(1) stream editor sed(1B) stream editor select(1) See case(1) set(1) shell built-in functions to determine the characteristics for environmental variables of the current shell and its descendents set(1F) set and unset local or global environment variables

1-20 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

setcolor(1F) redefine or create a color setenv(1) See set(1) setfacl(1) modify the Access Control List (ACL) for a file or files sh(1) shell: the standard shell, and job control shell -- command interpreters shell(1F) run a command using shell shell_builtins(1) shell command interpreter built-in functions shift(1) shell built-in function to traverse either a shell’s argument list or a list of field-separated words shutdown(1B) close down the system at a given time size(1) print section sizes in bytes of object files sleep(1) suspend execution for an interval soelim(1) resolve and eliminate .so requests from nroff or troff input sort(1) sort, merge, or sequence check text files sortbib(1) sort a bibliographic database source(1) See exec(1) sparc(1) See machid(1) spell(1) find spelling errors spline(1) interpolate smooth curve split(1) split a file into pieces srchtxt(1) display contents of, or search for a text string in, message data bases stop(1) See jobs(1) strchg(1) change or query stream configuration strconf(1) See strchg(1) strings(1) find printable strings in an object or binary file strip(1) strip symbol table, debugging and line number information from an object file stty(1) set the options for a terminal stty(1B) set the options for a terminal sum(1) print checksum and block count for a file sum(1B) calculate a checksum for a file sun(1) See machid(1) suspend(1) shell built-in function to halt the current shell switch(1) See case(1) modified 24 Feb 1993 1-21 Intro ( 1 ) User Commands SunOS 5.5

symorder(1) rearrange a list of symbols sysV-make(1) maintain, update, and regenerate groups of programs t300(1) See tplot(1) t300(1B) See plot(1B) t300s(1) See tplot(1) t300s(1B) See plot(1B) t4013(1B) See plot(1B) t4014(1) See tplot(1) t450(1) See tplot(1) t450(1B) See plot(1B) tabs(1) set tabs on a terminal tail(1) deliver the last part of a file talk(1) talk to another user tar(1) create tape archives, and add or extract files tbl(1) format tables for nroff or troff tcopy(1) copy a magnetic tape tee(1) replicate the standard output tek(1) See tplot(1) tek(1B) See plot(1B) telnet(1) user interface to a remote system using the TELNET protocol test(1) See if(1) test(1B) condition evaluation command test(1F) condition evaluation command tftp(1) trivial file transfer program time(1) time a simple command times(1) shell built-in function to report time usages of the current shell timex(1) time a command; report process data and system activity tip(1) connect to remote system tnfdump(1) converts binary TNF file to ASCII tnfxtract(1) extract kernel probes output into a trace file touch(1) change file access and modification times touch(1B) update the access and modification times of a file tplot(1) graphics filters for various plotters

1-22 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

tput(1) initialize a terminal or query terminfo database tr(1) translate characters tr(1B) translate characters trap(1) shell built-in functions to respond to (hardware) signals troff(1) typeset or format documents true(1) provide truth values truss(1) trace system calls and signals tset(1B) establish or restore terminal characteristics tsort(1) topological sort tty(1) return user’s terminal name type(1) write a description of command type typeset(1) shell built-in functions to set/get attributes and values for shell variables and functions u370(1) See machid(1) u3b(1) See machid(1) u3b15(1) See machid(1) u3b2(1) See machid(1) u3b5(1) See machid(1) ucblinks(1B) adds /dev entries to give SunOS 4.x compatible names to SunOS 5.x devices ul(1) do underlining ulimit(1) See limit(1) umask(1) get or set the file mode creation mask unalias(1) See alias(1) uname(1) print name of current system uncompress(1) See compress(1) unexpand(1) See expand(1) unget(1) See sccs-unget(1) unhash(1) See hash(1) unifdef(1) resolve and remove ifdef’ed lines from C program source uniq(1) report or filter out repeated lines in a file units(1) converts quantities expressed in standard scales to other scales unix2dos(1) convert text file from ISO format to DOS format modified 24 Feb 1993 1-23 Intro ( 1 ) User Commands SunOS 5.5

unlimit(1) See limit(1) unpack(1) See pack(1) unset(1) See set(1) unset(1F) See set(1F) unsetenv(1) See set(1) until(1) See while(1) uptime(1) show how long the system has been up users(1B) display a compact list of users logged in uucp(1C) UNIX-to-UNIX system copy uudecode(1C) See uuencode(1C) uuencode(1C) encode a binary ﬁle, or decode its encoded represen- tation uuglist(1C) print the list of service grades that are available on this UNIX system uulog(1C) See uucp(1C) uuname(1C) See uucp(1C) uupick(1C) See uuto(1C) uustat(1C) uucp status inquiry and job control uuto(1C) public UNIX-to-UNIX system ﬁle copy uux(1C) UNIX-to-UNIX system command execution vacation(1) reply to mail automatically val(1) See sccs-val(1) valdate(1) See ckdate(1) valgid(1) See ckgid(1) valint(1) See ckint(1) valpath(1) See ckpath(1) valrange(1) See ckrange(1) valstr(1) See ckstr(1) valtime(1) See cktime(1) valuid(1) See ckuid(1) valyorn(1) See ckyorn(1) vax(1) See machid(1) vc(1) version control vedit(1) See vi(1) ver(1) See tplot(1) vgrind(1) grind nice program listings

1-24 modiﬁed 24 Feb 1993 SunOS 5.5 User Commands Intro ( 1 )

vi(1) screen-oriented (visual) display editor based on ex view(1) See vi(1) vipw(1B) edit the password file volcancel(1) cancel user’s request for removable media that is not currently in drive volcheck(1) checks for media in a drive and by default checks all floppy media volmissing(1) notify user that volume requested is not in the CD- ROM or floppy drive vplot(1B) See plot(1B) vsig(1F) synchronize a co-process with the controlling FMLI application w(1) who is logged in, and what are they doing wait(1) await process completion wc(1) display a count of lines, words and characters in a file what(1) extract SCCS version information from a file whatis(1) display a one-line summary about a keyword whence(1) See typeset(1) whereis(1B) locate the binary, source, and manual page files for a command which(1) locate a command; display its pathname or alias while(1) shell built-in functions to repetitively execute a set of actions while/until conditions are evaluated TRUE who(1) who is on the system whoami(1B) display the effective current username whois(1) Internet user name directory service write(1) write to another user xargs(1) construct argument lists and invoke utility xgettext(1) extract gettext call strings from C programs xstr(1) extract strings from C programs to implement shared strings yacc(1) yet another compiler-compiler ypcat(1) print values in a NIS database ypmatch(1) print the value of one or more keys from a NIS map yppasswd(1) change your network password in the NIS database ypwhich(1) return name of NIS server or map master zcat(1) See compress(1) modified 24 Feb 1993 1-25 acctcom ( 1 ) User Commands SunOS 5.5

NAME acctcom − search and print process accounting ﬁles

SYNOPSIS acctcom [ −abfhikmqrtv ][−Csec ][−etime ][−Etime ][−ggroup ][−Hfactor ] [ −I chars ][−lline ][−npattern ][−ooutput-ﬁle ][−Osec ][−stime ] [ −S time ][−uuser ][ﬁlename ...]

AVAILABILITY SUNWaccu

DESCRIPTION acctcom reads filenames, the standard input, or /var/adm/pacct, in the form described by acct(4) and writes selected records to standard output. Each record represents the execution of one process. The output shows the COMMAND NAME, USER, TTYNAME, START TIME, END TIME, REAL (SEC), CPU (SEC), MEAN SIZE (K), and optionally, F (the fork( )/exec( ) flag: 1 for fork( ) without exec( )), STAT (the system exit status), HOG FAC- TOR, KCORE MIN, CPU FACTOR, CHARS TRNSFD, and BLOCKS READ (total blocks read and written). A‘#’ is prepended to the command name if the command was executed with super-user privileges. If a process is not associated with a known terminal, a ‘ ? ’ is printed in the TTYNAME field. If no filename is specified, and if the standard input is associated with a terminal or /dev/null (as is the case when using ‘ & ’ in the shell), /var/adm/pacct is read; otherwise, the standard input is read. If any filename arguments are given, they are read in their respective order. Each file is normally read forward, that is, in chronological order by process completion time. The file /var/adm/pacct is usually the current file to be examined; a busy system may need several such files of which all but the current file are found in /var/adm/pacctincr.

OPTIONS −a Show some average statistics about the processes selected. The statistics will be printed after the output records. −b Read backwards, showing latest commands ﬁrst. This option has no effect when standard input is read. −f Print the fork()/exec() ﬂag and system exit status columns in the output. The numeric output for this option will be in octal. −h Instead of mean memory size, show the fraction of total available CPU time consumed by the process during its execution. This “hog factor” is computed as (total CPU time)/(elapsed time). −i Print columns containing the I/O counts in the output. −k Instead of memory size, show total kcore-minutes. −m Show mean core size (the default). −q Do not print any output records, just print the average statistics as with the −a option. −r Show CPU factor (user-time/(system-time + user-time)).

1-26 modiﬁed 20 Jan 1995 SunOS 5.5 User Commands acctcom ( 1 )

−t Show separate system and user CPU times. −v Exclude column headings from the output. −C sec Show only processes with total CPU time (system-time + user-time) exceeding sec seconds. −e time Select processes existing at or before time. −E time Select processes ending at or before time. Using the same time for both −S and −E shows the processes that existed at time. −g group Show only processes belonging to group. The group may be designated by either the group ID or group name. −H factor Show only processes that exceed factor, where factor is the “hog factor” as explained in option −h above. −I chars Show only processes transferring more characters than the cutoff number given by chars. −l line Show only processes belonging to terminal /dev/term/line. −n pattern Show only commands matching pattern that may be a regular expression as in regcmp(3G), except + means one or more occurrences. −o output-file Copy selected process records in the input data format to output-file; suppress printing to standard output. −O sec Show only processes with CPU system time exceeding sec seconds. −s time Select processes existing at or after time, given in the format hr [:min [:sec ]]. −Stime Select processes starting at or after time. −u user Show only processes belonging to user . The user may be specified by a user ID, a login name that is then converted to a user ID,‘#’ (which designates only those processes executed with superuser privileges), or ‘ ? ’ (which designates only those processes associated with unknown user IDs).

FILES /etc/group system group file /etc/passwd system password file /var/adm/pacctincr active processes accounting file

SEE ALSO ps(1), acct(1M), acctcms(1M), acctcon(1M), acctmerg(1M), acctprc(1M), acctsh(1M), fwtmp(1M), runacct(1M), su(1M), acct(2), regcmp(3G), acct(4), utmp(4) System Administration Guide, Volume II

NOTES acctcom reports only on processes that have terminated; use ps(1) for active processes.

modiﬁed 20 Jan 1995 1-27 adb ( 1 ) User Commands SunOS 5.5

NAME adb − general-purpose debugger

SYNOPSIS adb [ −w ][−k][−Idir ][−Pprompt ][−Vmode ][objectfile [ corefile [ swapfile ]]]

AVAILABILITY SUNWcsu

DESCRIPTION adb is an interactive, general-purpose debugger. It can be used to examine files and provides a controlled environment for the execution of programs. objectfile is normally an executable program file, preferably containing a symbol table. If the file does not contain a symbol table, it can still be examined, but the symbolic features of adb cannot be used. The default for objectfile is a.out. corefile is assumed to be a core image file produced after executing objectfile. The default for corefile is core. swapfile is the image of the swap device used. It is valid only when used with the −k option.

OPTIONS −w Create both objectfile and corefile, if necessary, and open them for reading and writing so that they can be modified using adb. −k Perform kernel memory mapping; use when corefile is a system crash dump or /dev/mem, or when using a swapfile. −I dir Specify a colon-separated list of directories where files to be read with $< or $<< (see below) will be sought; the default is /usr/platform/plat- name/lib/adb:/usr/lib/adb, where plat-name is the name of the platform implementation. plat-name can be found using the −i option of uname(1). −P prompt Specify the adb prompt string. −V mode (SPARC only) Specify the disassembly and register display mode. Options are: 0 (v8), 1 (generic V9), and 2 (v9 plus Sun Ultra-SPARC specific instructions). The default mode is determined by the type of corefile being examined.

USAGE adb reads commands from the standard input and displays responses on the standard output. It does not supply a prompt by default. It ignores the QUIT signal. INTERRUPT invokes the next adb command. adb generally recognizes command input of the form: [ address ][,count ][command ][;] address and count (if supplied) are expressions that result, respectively, in a new current address, and a repetition count. command is composed of a verb followed by a modiﬁer or list of modiﬁers. The symbol ‘.’ represents the current location. It is initially zero. The default count is ‘1’.

Expressions . The value of dot. + The value of dot incremented by the current increment. ˆ The value of dot decremented by the current increment. & The last address typed. (In older versions of adb,‘"’ was used.) integer A number. The preﬁxes 0o and 0O indicate octal; 0t and 0T, decimal; 0x

1-28 modiﬁed 26 Jun 1995 SunOS 5.5 User Commands adb ( 1 )

and 0X, hexadecimal (the default). int.frac A ﬂoating-point number. ’cccc’ ASCII value of up to 4 characters.

Unary Operators ∗exp The contents of location exp in coreﬁle. %exp The contents of location exp in objectﬁle (In older versions of adb,‘@’ was used). −exp Integer negation. ˜exp Bitwise complement. #exp Logical negation.

Binary Operators Binary operators are left associative and have lower precedence than unary operators. + Integer addition. − Integer subtraction. ∗ Integer multiplication. % Integer division. & Bitwise conjunction (“AND”). | Bitwise disjunction (“OR”). # lhs rounded up to the next multiple of rhs.

Variables Named variables are set initially by adb but are not used subsequently. 0 The last value printed. 1 The last offset part of an instruction source. 2 The previous value of variable 1. 9 The count on the last $< or $<< command. On entry the following are set from the system header in the coreﬁle or objectﬁle as appropriate. b The base address of the data segment. d The data segment size. e The entry point. m The ‘magic’ number t The text segment size.

Commands Commands to adb consist of a verb followed by a modiﬁer or list of modiﬁers.

Verbs ? Print locations starting at address in objectfile. / Print locations starting at address in corefile. = Print the value of address itself. : Manage a subprocess. > Assign a value to a variable or register. RETURN Repeat the previous command with a count of 1. Increment ‘.’. ! Shell escape. modified 26 Jun 1995 1-29 adb ( 1 ) User Commands SunOS 5.5

?, /, and = Modifiers The following format modifiers apply to the commands ?, /, and =. To specify a format, follow the command with an optional repeat count, and the desired format letter or letters: { ?,/,= }[[r]f...]] where r is a repeat count, and f is one of the format letters listed below: o (‘.’ increment: 2) Print 2 bytes in octal. O (4) Print 4 bytes in octal. q (2) Print in signed octal. Q (4) Print long signed octal. d (2) Print in decimal. D (4) Print long decimal. x (2) Print 2 bytes in hexadecimal. X (4) Print 4 bytes in hexadecimal. u (2) Print as an unsigned decimal number. U (4) Print long unsigned decimal. f (4) Print a single-precision floating-point number. F (8) Print a double-precision floating-point number. b (1) Print the addressed byte in octal. c (1) Print the addressed character. C (1) Print the addressed character using ˆ escape convention. s (n) Print the addressed string. S (n) Print a string using the ˆ escape convention. Y (4) Print 4 bytes in date format. i (4 on SPARC; n on x86) Print as machine instructions. a (0) Print the value of ‘.’ in symbolic form. p (4) Print the addressed value in symbolic form. t (0) Tab to the next appropriate TAB stop. r (0) Print a SPACE. n (0) Print a NEWLINE. "..." (0) Print the enclosed string. ˆ (0) Decrement ‘.’. + (0) Increment ‘.’. − (0) Decrement ‘.’by1.

? and / Modiﬁers l value mask Apply mask and compare for value; move ‘.’ to matching location. L value mask Apply mask and compare for 4-byte value; move ‘.’ to matching location. w value Write the 2-byte value to address. W value Write the 4-byte value to address. m b1 e1 f1[ ?] Map new values for b1, e1, f1. If the ? or / is followed by ∗ then the second segment (b2 , e2 , f2) of the address mapping is changed. v Like w, but writes only bytes at a time.

1-30 modiﬁed 26 Jun 1995 SunOS 5.5 User Commands adb ( 1 )

: Modifiers b commands Set breakpoint, execute commands when reached. r Run objectfile as a subprocess. d Delete breakpoint at address. z Delete all breakpoints. cs x86: The subprocess is continued with signal s. ss Single-step the subprocess with signal s. i Add the signal specified by address to the list of signals passed directly to the subprocess. t Remove the signal specified by address from the list implicitly passed to the subprocess. k Terminate (kill) the current subprocess, if any. A Attach adb to an existing process id. (For example, 0t1234:A would attach adb to decimal process number 1234.) R Release the previously attached process. $ Modifiers <filename Read commands from the file filename. <<filename Similar to <, but can be used in a file of commands without closing the file. >filename Append output to filename, which is created if it does not exist. l x86: Show the current lightweight process (lwp) ID. L x86: Show all the lwp IDs. P Specify the adb prompt string. ? Print process ID, the signal which stopped the subprocess, and the registers. r Print the names and contents of the general CPU registers, and the instruction addressed by pc. x or X x86: Print the contents of floating point registers. $x and $X accept a "count" which determines the precision in which the floating point registers will be printed; the default is 25. Using $X will produce more ver- bose output than using $x. x SPARC: Print the names and contents of floating-point registers 0 through 15. X SPARC: Print the names and contents of floating-point registers 16 through 31. b Print all breakpoints and their associated counts and commands. c C stack backtrace. On SPARC systems, it is impossible for adb to determine how many parameters were passed to a function. The default that adb chooses in a $c command is to show the six parameter registers. This can be overridden by appending a hexadecimal number to the $c command, specifying how many parameters to display. For example, the $cf command will print 15 parameters for each function in the stack trace. C x86: Same as $c, but in addition it displays the frame pointer values. d Set the default radix to address and report the new value. Note: address is interpreted in the (old) current radix. Thus ‘10$d’ never changes the default radix. modified 26 Jun 1995 1-31 adb ( 1 ) User Commands SunOS 5.5

e Print the names and values of external variables. w Set the page width for output to address (default 80). s Set the limit for symbol matches to address (default 255). o All integers input are regarded as octal. q Exit from adb. v Print all non zero variables in octal. m Print the address map. f Print a list of known source filenames. p (Kernel debugging) Change the current kernel memory mapping to map the designated user structure to the address given by u; this is the address of the user’s proc structure. i Show which signals are passed to the subprocess with the minimum of adb interference. V SPARC: Change the current disassembly and register display mode. Options are: 0 (v8), 1 (generic V9), and 2 (v9 plus Sun Ultra-SPARC specific instructions). Omitting the numeric parameter prints information on the current disassembly mode. W Reopen objectfile and corefile for writing, as though the −w command-line argument had been given.

EXAMPLES To start adb on the running kernel, use (as root): example# adb -k /dev/ksyms /dev/mem /dev/ksyms is a special driver that provides an image of the kernel’s symbol table. This can be used to examine kernel state and debug device drivers. Refer to the Debugging chapter in Writing Device Drivers for more information.

EXIT STATUS The following exit values are returned: 0 Successful completion. non-zero The last command either failed or returned a nonzero status.

FILES /usr/lib/adb and /usr/platform/platform-name/lib/adb default directories in which files are to be read with $< and $<<. platform-name is the name of the platform implementation and can be found using uname −i. a.out default name for objectfile operand. core default name for corefile operand. /dev/ksyms special driver to provide an image of the kernel’s symbolic table.

SEE ALSO uname(1), ptrace(2), a.out(4), core(4), proc(4), ksyms(7D) Writing Device Drivers

DIAGNOSTICS adb, when there is no current command or format, comments about inaccessible ﬁles, syntax errors, abnormal termination of commands, etc.

1-32 modiﬁed 26 Jun 1995 SunOS 5.5 User Commands adb ( 1 )

NOTES adb should be changed to use the new format symbolic information generated by −g. adb is platform and release dependent. Kernel core dumps should be examined on the same platform they were created on.

BUGS Since no shell is invoked to interpret the arguments of the :r command, the customary wild-card and variable expansions cannot occur. Since there is little type-checking on addresses, using a sourceﬁle address in an inap- propriate context may lead to unexpected results. The $cparameter-count command is a workaround.

modiﬁed 26 Jun 1995 1-33 addbib ( 1 ) User Commands SunOS 5.5

NAME addbib − create or extend a bibliographic database

SYNOPSIS addbib [ −a ][−ppromptﬁle ] database

AVAILABILITY SUNWdoc

DESCRIPTION When addbib starts up, answering y to the initial Instructions? prompt yields directions; typing n or RETURN skips them. addbib then prompts for various bibliographic fields, reads responses from the terminal, and sends output records to database. A null response (just RETURN) means to leave out that field. A ‘−’ (minus sign) means to go back to the previous field. A trailing backslash allows a field to be continued on the next line. The repeating Continue? prompt allows the user either to resume by typing y or RETURN,to quit the current session by typing n or q, or to edit database with any system editor (see vi(1), ex(1), ed(1)).

OPTIONS −a Suppress prompting for an abstract; asking for an abstract is the default. Abstracts are ended with a CTRL−D. −p promptfile Use a new prompting skeleton, defined in promptfile. This file should contain prompt strings, a TAB, and the key-letters to be written to the database.

USAGE Bibliography Key The most common key-letters and their meanings are given below. addbib insulates you Letters from these key-letters, since it gives you prompts in English, but if you edit the bibliography file later on, you will need to know this information. %A Author’s name %B Book containing article referenced %C City (place of publication) %D Date of publication %E Editor of book containing article referenced %F Footnote number or label (supplied by refer) %G Government order number %H Header commentary, printed before reference %I Issuer (publisher) %J Journal containing article %K Keywords to use in locating reference %L Label field used by −k option of refer %M Bell Labs Memorandum (undefined) %N Number within volume %O Other commentary, printed at end of reference

1-34 modiﬁed 14 Sep 1992 SunOS 5.5 User Commands addbib ( 1 )

%P Page number(s) %Q Corporate or Foreign Author (unreversed) %R Report, paper, or thesis (unpublished) %S Series title %T Title of article or book %V Volume number %X Abstract — used by roffbib, not by refer %Y,Z Ignored by refer

EXAMPLES Except for A, each ﬁeld should be given just once. Only relevant ﬁelds should be supplied. %A Mark Twain %T Life on the Mississippi %I Penguin Books %C New York %D 1978

SEE ALSO ed(1), ex(1), indxbib(1), lookbib(1), refer(1), roffbib(1), sortbib(1), vi(1)

modiﬁed 14 Sep 1992 1-35 alias ( 1 ) User Commands SunOS 5.5

NAME alias, unalias − create or remove a pseudonym or shorthand for a command or series of commands

SYNOPSIS /usr/bin/alias [alias-name[=string]...] /usr/bin/unalias alias-name ... /usr/bin/unalias -a

csh alias [ name [ def ]] unalias pattern

ksh alias [ −tx ][name[ =value ]]... unalias name...

DESCRIPTION /usr/bin/alias The alias utility creates or redefines alias definitions or writes the values of existing alias definitions to standard output. An alias definition provides a string value that replaces a command name when it is encountered. An alias definition affects the current shell execution environment and the execution environments of the subshells of the current shell. When used as specified by this document, the alias definition will not affect the parent process of the current shell nor any utility environment invoked by the shell.

/usr/bin/unalias The unalias utility removes the deﬁnition for each alias name speciﬁed. The aliases are removed from the current shell execution environment.

csh alias assigns def to the alias name. def is a list of words that may contain escaped history- substitution metasyntax. name is not allowed to be alias or unalias.Ifdef is omitted, the alias name is displayed along with its current definition. If both name and def are omitted, all aliases are displayed. Because of implementation restrictions, an alias definition must have been entered on a previous command line before it can be used. unalias discards aliases that match (filename substitution) pattern. All aliases may be removed by ‘unalias ∗’.

ksh alias with no arguments prints the list of aliases in the form name=value on standard output. An alias is defined for each name whose value is given. A trailing space in value causes the next word to be checked for alias substitution. The −t flag is used to set and list tracked aliases. The value of a tracked alias is the full pathname corresponding to the given name. The value becomes undefined when the value of PATH is reset but the aliases remained tracked. Without the −t flag, for each name in the argument list for which no value is given, the name and value of the alias is printed. The −x flag is used to set or print exported aliases. An exported alias is defined for scripts invoked by name. The exit status is non-zero if a name is given, but no value, and no alias has been defined for

1-36 modiﬁed 28 Mar 1995 SunOS 5.5 User Commands alias ( 1 )

the name. The aliases given by the list of names may be removed from the alias list with unalias.

OPTIONS The following option is supported by unalias: −a Remove all alias deﬁnitions from the current shell execution environment.

OPERANDS The following operands are supported: alias alias-name Write the alias deﬁnition to standard output. unalias alias-name The name of an alias to be removed. alias-name=string Assign the value of string to the alias alias-name. If no operands are given, all alias deﬁnitions will be written to standard output.

OUTPUT The format for displaying aliases (when no operands or only name operands are speciﬁed) is: "%s=%s\n" name, value The value string will be written with appropriate quoting so that it is suitable for reinput to the shell.

EXAMPLES 1. Change ls to give a columnated, more annotated output: alias ls="ls −CF" 2. Create a simple “redo” command to repeat previous entries in the command history ﬁle: alias r=’fc −s’ 3. Use 1K units for du: alias du=du\ −k 4. Set up nohup so that it can deal with an argument that is itself an alias name: alias nohup="nohup "

ENVIRONMENT See environ(5) for descriptions of the following environment variables that affect the execution of alias and unalias: LC_CTYPE, LC_MESSAGES, and NLSPATH.

EXIT STATUS The following exit values are returned: 0 Successful completion. alias >0 One of the alias-name operands specified did not have an alias definition, or an error occurred. unalias >0 One of the alias-name operands specified did not represent a valid alias definition, or an error occurred.

SEE ALSO csh(1), ksh(1), shell_builtins(1), environ(5)

modiﬁed 28 Mar 1995 1-37 apropos ( 1 ) User Commands SunOS 5.5

NAME apropos − locate commands by keyword lookup

SYNOPSIS apropos keyword...

AVAILABILITY SUNWdoc

DESCRIPTION apropos displays the man page name, section number, and a short description for each man page whose NAME line contains keyword. This information is contained in the /usr/share/man/windex database created by catman(1M). If catman(1M) was not run, or was run with the −n option, apropos fails. Each word is considered separately and the case of letters is ignored. Words which are part of other words are considered; for example, when looking for ‘compile’, apropos finds all instances of ‘compiler’ also. apropos is actually just the −k option to the man(1) command. Try example% apropos password and example% apropos editor If the line starts ‘filename(section) . . .’ you can do ‘man −s section filename’ to display the man page for filename. Try example% apropos format and then example% man −s 3s printf to get the manual page on the subroutine printf( ).

FILES /usr/share/man/windex table of contents and keyword database