man pages section 1: User CommandsBeta

Part No: 821–1461–06November 2010

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectualproperty laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software,unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related software documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the followingnotice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are“commercial computer software” or “commercial technical data” pursuant to the applicable Federal Acquisition Regulation and agency-specific supplementalregulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicableGovernment contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, CommercialComputer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherentlydangerous applications, including applications which may create a risk of personal injury. If you use this software or hardware in dangerous applications, then youshall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim anyliability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. Intel and Intel Xeon aretrademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARCInternational, Inc. UNIX is a registered trademark licensed through X/Open Company, Ltd.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation andits affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporationand its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

110425@25097

Contents

Preface ...................................................................................................................................................19

Introduction .........................................................................................................................................23Intro(1) ................................................................................................................................................ 24

User Commands ...................................................................................................................................29acctcom(1) ............................................................................................................................................ 30adb(1) .................................................................................................................................................... 33addbib(1) .............................................................................................................................................. 34alias(1) ................................................................................................................................................ 36allocate(1) ......................................................................................................................................... 40amt(1) .................................................................................................................................................... 42appcert(1) ............................................................................................................................................ 43apptrace(1) ......................................................................................................................................... 50apropos(1) ............................................................................................................................................ 54ar(1) ...................................................................................................................................................... 56arch(1) .................................................................................................................................................. 60as(1) ...................................................................................................................................................... 61asa(1) .................................................................................................................................................... 66at(1) ...................................................................................................................................................... 68atq(1) .................................................................................................................................................... 75atrm(1) .................................................................................................................................................. 76audioconvert(1) ................................................................................................................................. 77audioctl(1) ......................................................................................................................................... 81audioplay(1) ....................................................................................................................................... 83audiorecord(1) ................................................................................................................................... 85audiotest(1) ....................................................................................................................................... 87

3

auths(1) ................................................................................................................................................ 88auto_ef(1) ............................................................................................................................................ 90awk(1) .................................................................................................................................................... 93banner(1) .............................................................................................................................................. 99basename(1) ....................................................................................................................................... 100basename(1B) ..................................................................................................................................... 102bc(1) .................................................................................................................................................... 103bdiff(1) .............................................................................................................................................. 107bfs(1) .................................................................................................................................................. 108biff(1B) ............................................................................................................................................. 112break(1) .............................................................................................................................................. 113builtin(1) .......................................................................................................................................... 115cal(1) .................................................................................................................................................. 117calendar(1) ....................................................................................................................................... 118cancel(1) ............................................................................................................................................ 120cat(1) .................................................................................................................................................. 122cd(1) .................................................................................................................................................... 126cdrw(1) ................................................................................................................................................ 130checknr(1) .......................................................................................................................................... 137chgrp(1) .............................................................................................................................................. 139chkey(1) .............................................................................................................................................. 142chmod(1) .............................................................................................................................................. 144chown(1) .............................................................................................................................................. 167chown(1B) ........................................................................................................................................... 172ckdate(1) ............................................................................................................................................ 173ckgid(1) .............................................................................................................................................. 176ckint(1) .............................................................................................................................................. 178ckitem(1) ............................................................................................................................................ 180ckkeywd(1) .......................................................................................................................................... 183ckpath(1) ............................................................................................................................................ 185ckrange(1) .......................................................................................................................................... 188ckstr(1) .............................................................................................................................................. 191cksum(1) .............................................................................................................................................. 194cktime(1) ............................................................................................................................................ 200ckuid(1) .............................................................................................................................................. 202ckyorn(1) ............................................................................................................................................ 204

Contents

man pages section 1: User Commands • November 2010 (Beta)4

clear(1) .............................................................................................................................................. 206cmp(1) .................................................................................................................................................. 207col(1) .................................................................................................................................................. 209comm(1) ................................................................................................................................................ 211command(1) .......................................................................................................................................... 213compress(1) ....................................................................................................................................... 217cp(1) .................................................................................................................................................... 221cpio(1) ................................................................................................................................................ 226cpp(1) .................................................................................................................................................. 234cputrack(1) ....................................................................................................................................... 240crle(1) ................................................................................................................................................ 245crontab(1) .......................................................................................................................................... 257crypt(1) .............................................................................................................................................. 263csh(1) .................................................................................................................................................. 264csplit(1) ............................................................................................................................................ 291ct(1C) ................................................................................................................................................. 294ctags(1) .............................................................................................................................................. 296ctrun(1) .............................................................................................................................................. 299ctstat(1) ............................................................................................................................................ 302ctwatch(1) .......................................................................................................................................... 306cu(1C) ................................................................................................................................................. 308cut(1) .................................................................................................................................................. 315date(1) ................................................................................................................................................ 318dc(1) .................................................................................................................................................... 322deallocate(1) ................................................................................................................................... 325deroff(1) ............................................................................................................................................ 327des(1) .................................................................................................................................................. 328df(1B) .................................................................................................................................................. 330dhcpinfo(1) ....................................................................................................................................... 332diff(1) ................................................................................................................................................ 335diff3(1) .............................................................................................................................................. 339diffmk(1) ............................................................................................................................................ 341digest(1) ............................................................................................................................................ 342dircmp(1) ............................................................................................................................................ 344dis(1) .................................................................................................................................................. 345disown(1) ............................................................................................................................................ 347

Contents

5

dispgid(1) .......................................................................................................................................... 348dispuid(1) .......................................................................................................................................... 349dos2unix(1) ....................................................................................................................................... 350download(1) ....................................................................................................................................... 352dpost(1) .............................................................................................................................................. 354du(1) .................................................................................................................................................... 357du(1B) .................................................................................................................................................. 360dump(1) ................................................................................................................................................ 362dumpcs(1) ............................................................................................................................................ 365echo(1) ................................................................................................................................................ 366echo(1B) ............................................................................................................................................. 369ed(1) .................................................................................................................................................... 370edit(1) ................................................................................................................................................ 385egrep(1) .............................................................................................................................................. 390eject(1) .............................................................................................................................................. 393elfdump(1) .......................................................................................................................................... 395elfedit(1) .......................................................................................................................................... 401elfsign(1) .......................................................................................................................................... 411elfwrap(1) .......................................................................................................................................... 416enable(1) ............................................................................................................................................ 419encrypt(1) .......................................................................................................................................... 421enhance(1) .......................................................................................................................................... 425env(1) .................................................................................................................................................. 427eqn(1) .................................................................................................................................................. 429error(1) .............................................................................................................................................. 433ex(1) .................................................................................................................................................... 436exec(1) ................................................................................................................................................ 447exit(1) ................................................................................................................................................ 450expand(1) ............................................................................................................................................ 453exportfs(1B) ..................................................................................................................................... 455expr(1) ................................................................................................................................................ 456expr(1B) ............................................................................................................................................. 460exstr(1) .............................................................................................................................................. 463factor(1) ............................................................................................................................................ 467fastboot(1B) ..................................................................................................................................... 468fdformat(1) ....................................................................................................................................... 469

Contents

man pages section 1: User Commands • November 2010 (Beta)6

fgrep(1) .............................................................................................................................................. 473file(1) ................................................................................................................................................ 476file(1B) ............................................................................................................................................. 479filebench(1) ..................................................................................................................................... 481filesync(1) ....................................................................................................................................... 483find(1) ................................................................................................................................................ 491finger(1) ............................................................................................................................................ 499fmt(1) .................................................................................................................................................. 502fmtmsg(1) ............................................................................................................................................ 503fold(1) ................................................................................................................................................ 507from(1B) ............................................................................................................................................. 509ftp(1) .................................................................................................................................................. 510ftpcount(1) ....................................................................................................................................... 525ftpwho(1) ............................................................................................................................................ 526gcore(1) .............................................................................................................................................. 527gencat(1) ............................................................................................................................................ 529geniconvtbl(1) ................................................................................................................................. 532genmsg(1) ............................................................................................................................................ 535getconf(1) .......................................................................................................................................... 541getfacl(1) .......................................................................................................................................... 551getlabel(1) ....................................................................................................................................... 555getopt(1) ............................................................................................................................................ 556getoptcvt(1) ..................................................................................................................................... 558getopts(1) .......................................................................................................................................... 561gettext(1) .......................................................................................................................................... 571gettxt(1) ............................................................................................................................................ 573getzonepath(1) ................................................................................................................................. 575glob(1) ................................................................................................................................................ 576gprof(1) .............................................................................................................................................. 577grep(1) ................................................................................................................................................ 582groups(1) ............................................................................................................................................ 587groups(1B) ......................................................................................................................................... 588grpck(1B) ........................................................................................................................................... 589hash(1) ................................................................................................................................................ 590head(1) ................................................................................................................................................ 592history(1) .......................................................................................................................................... 595

Contents

7

hostid(1) ............................................................................................................................................ 605hostname(1) ....................................................................................................................................... 606iconv(1) .............................................................................................................................................. 607idnconv(1) .......................................................................................................................................... 610indxbib(1) .......................................................................................................................................... 615install(1B) ....................................................................................................................................... 616ipcrm(1) .............................................................................................................................................. 618ipcs(1) ................................................................................................................................................ 620isainfo(1) .......................................................................................................................................... 624isalist(1) .......................................................................................................................................... 626jobs(1) ................................................................................................................................................ 627join(1) ................................................................................................................................................ 635kbd(1) .................................................................................................................................................. 639kdestroy(1) ....................................................................................................................................... 646keylogin(1) ....................................................................................................................................... 647keylogout(1) ..................................................................................................................................... 648kill(1) ................................................................................................................................................ 649kinit(1) .............................................................................................................................................. 654klist(1) .............................................................................................................................................. 661kmdb(1) ................................................................................................................................................ 663kmfcfg(1) ............................................................................................................................................ 669kpasswd(1) .......................................................................................................................................... 678krb5-config(1) ................................................................................................................................. 679ksh(1) .................................................................................................................................................. 681ksh93(1) .............................................................................................................................................. 732ktutil(1) ............................................................................................................................................ 791lari(1) ................................................................................................................................................ 793last(1) ................................................................................................................................................ 801lastcomm(1) ....................................................................................................................................... 803ld(1) .................................................................................................................................................... 805ldap(1) ................................................................................................................................................ 825ldapdelete(1) ................................................................................................................................... 829ldaplist(1) ....................................................................................................................................... 835ldapmodify(1) ................................................................................................................................... 840ldapmodrdn(1) ................................................................................................................................... 848ldapsearch(1) ................................................................................................................................... 854

Contents

man pages section 1: User Commands • November 2010 (Beta)8

ldd(1) .................................................................................................................................................. 864ld.so.1(1) .......................................................................................................................................... 870let(1) .................................................................................................................................................. 879lex(1) .................................................................................................................................................. 880lgrpinfo(1) ....................................................................................................................................... 892limit(1) .............................................................................................................................................. 898line(1) ................................................................................................................................................ 904list_devices(1) ............................................................................................................................... 905listusers(1) ..................................................................................................................................... 909llc2_autoconfig(1) ......................................................................................................................... 910llc2_config(1) ................................................................................................................................. 911llc2_stats(1) ................................................................................................................................... 913ln(1) .................................................................................................................................................... 921ln(1B) .................................................................................................................................................. 924loadkeys(1) ....................................................................................................................................... 927locale(1) ............................................................................................................................................ 928localedef(1) ..................................................................................................................................... 931logger(1) ............................................................................................................................................ 936logger(1B) ......................................................................................................................................... 938login(1) .............................................................................................................................................. 940logname(1) .......................................................................................................................................... 948logout(1) ............................................................................................................................................ 950look(1) ................................................................................................................................................ 951lookbib(1) .......................................................................................................................................... 952lorder(1) ............................................................................................................................................ 953lp(1) .................................................................................................................................................... 954lpc(1B) ............................................................................................................................................... 962lpq(1B) ............................................................................................................................................... 966lpr(1B) ............................................................................................................................................... 968lprm(1B) ............................................................................................................................................. 971lpstat(1) ............................................................................................................................................ 973lptest(1B) ......................................................................................................................................... 977ls(1) .................................................................................................................................................... 978ls(1B) ................................................................................................................................................ 1001m4(1) .................................................................................................................................................. 1004mac(1) ................................................................................................................................................ 1010

Contents

9

mach(1) .............................................................................................................................................. 1013machid(1) .......................................................................................................................................... 1014madv.so.1(1) ................................................................................................................................... 1016mail(1) .............................................................................................................................................. 1020mail(1B) ........................................................................................................................................... 1026mailcompat(1) ................................................................................................................................. 1027mailp(1) ............................................................................................................................................ 1029mailq(1) ............................................................................................................................................ 1031mailstats(1) ................................................................................................................................... 1033mailx(1) ............................................................................................................................................ 1035make(1S) ............................................................................................................................................ 1060makekey(1) ........................................................................................................................................ 1095man(1) ................................................................................................................................................ 1096mconnect(1) ..................................................................................................................................... 1103mcs(1) ................................................................................................................................................ 1104mdb(1) ................................................................................................................................................ 1106mesg(1) .............................................................................................................................................. 1150mkdir(1) ............................................................................................................................................ 1151mkmsgs(1) .......................................................................................................................................... 1154mkstr(1B) ......................................................................................................................................... 1156mktemp(1) .......................................................................................................................................... 1158moe(1) ................................................................................................................................................ 1161more(1) .............................................................................................................................................. 1163mp(1) .................................................................................................................................................. 1170mpss.so.1(1) ................................................................................................................................... 1178msgcc(1) ............................................................................................................................................ 1181msgcpp(1) .......................................................................................................................................... 1184msgcvt(1) .......................................................................................................................................... 1191msgfmt(1) .......................................................................................................................................... 1192msggen(1) .......................................................................................................................................... 1198msgget(1) .......................................................................................................................................... 1201mt(1) .................................................................................................................................................. 1202mv(1) .................................................................................................................................................. 1205nawk(1) .............................................................................................................................................. 1208nc(1) .................................................................................................................................................. 1228nca(1) ................................................................................................................................................ 1237

Contents

man pages section 1: User Commands • November 2010 (Beta)10

ncab2clf(1) ..................................................................................................................................... 1239ncakmod(1) ........................................................................................................................................ 1241newform(1) ........................................................................................................................................ 1242newgrp(1) .......................................................................................................................................... 1245news(1) .............................................................................................................................................. 1248newtask(1) ........................................................................................................................................ 1249nice(1) .............................................................................................................................................. 1251nl(1) .................................................................................................................................................. 1253nm(1) .................................................................................................................................................. 1256nohup(1) ............................................................................................................................................ 1261nroff(1) ............................................................................................................................................ 1265od(1) .................................................................................................................................................. 1268on(1) .................................................................................................................................................. 1274optisa(1) .......................................................................................................................................... 1276pack(1) .............................................................................................................................................. 1277pagesize(1) ..................................................................................................................................... 1280pargs(1) ............................................................................................................................................ 1281passwd(1) .......................................................................................................................................... 1283paste(1) ............................................................................................................................................ 1292patch(1) ............................................................................................................................................ 1294pathchk(1) ........................................................................................................................................ 1299pax(1) ................................................................................................................................................ 1302perl(1) .............................................................................................................................................. 1334pfexec(1) .......................................................................................................................................... 1341pg(1) .................................................................................................................................................. 1343pgrep(1) ............................................................................................................................................ 1348pkcs11_inspect(1) ......................................................................................................................... 1352pkginfo(1) ........................................................................................................................................ 1354pkgmk(1) ............................................................................................................................................ 1356pkgparam(1) ..................................................................................................................................... 1359pkgproto(1) ..................................................................................................................................... 1361pkgtrans(1) ..................................................................................................................................... 1363pklogin_finder(1) ......................................................................................................................... 1367pktool(1) .......................................................................................................................................... 1369plabel(1) .......................................................................................................................................... 1387plgrp(1) ............................................................................................................................................ 1388

Contents

11

plimit(1) .......................................................................................................................................... 1392pmadvise(1) ..................................................................................................................................... 1394pmap(1) .............................................................................................................................................. 1397postdaisy(1) ................................................................................................................................... 1409postdmd(1) ........................................................................................................................................ 1411postio(1) .......................................................................................................................................... 1413postmd(1) .......................................................................................................................................... 1416postplot(1) ..................................................................................................................................... 1419postprint(1) ................................................................................................................................... 1421postreverse(1) ............................................................................................................................... 1423posttek(1) ........................................................................................................................................ 1425ppgsz(1) ............................................................................................................................................ 1427ppriv(1) ............................................................................................................................................ 1430pr(1) .................................................................................................................................................. 1434praliases(1) ................................................................................................................................... 1438prctl(1) ............................................................................................................................................ 1439preap(1) ............................................................................................................................................ 1446prex(1) .............................................................................................................................................. 1448print(1) ............................................................................................................................................ 1460printenv(1B) ................................................................................................................................... 1463printf(1) .......................................................................................................................................... 1464priocntl(1) ..................................................................................................................................... 1473proc(1) .............................................................................................................................................. 1484prof(1) .............................................................................................................................................. 1489profiles(1) ..................................................................................................................................... 1493projects(1) ..................................................................................................................................... 1495ps(1) .................................................................................................................................................. 1497ps(1B) ................................................................................................................................................ 1507ptree(1) ............................................................................................................................................ 1510pvs(1) ................................................................................................................................................ 1512pwd(1) ................................................................................................................................................ 1517ranlib(1) .......................................................................................................................................... 1518rcapstat(1) ..................................................................................................................................... 1519rcp(1) ................................................................................................................................................ 1523rdist(1) ............................................................................................................................................ 1527read(1) .............................................................................................................................................. 1535

Contents

man pages section 1: User Commands • November 2010 (Beta)12

readonly(1) ..................................................................................................................................... 1539refer(1) ............................................................................................................................................ 1541regcmp(1) .......................................................................................................................................... 1543renice(1) .......................................................................................................................................... 1545rev(1) ................................................................................................................................................ 1548rlogin(1) .......................................................................................................................................... 1549rm(1) .................................................................................................................................................. 1553rmformat(1) ..................................................................................................................................... 1558rmmount(1) ........................................................................................................................................ 1564roffbib(1) ........................................................................................................................................ 1566roles(1) ............................................................................................................................................ 1568rpcgen(1) .......................................................................................................................................... 1570rpm2cpio(1) ..................................................................................................................................... 1576rsh(1) ................................................................................................................................................ 1577runat(1) ............................................................................................................................................ 1582rup(1) ................................................................................................................................................ 1585rup(1C) ............................................................................................................................................. 1586ruptime(1) ........................................................................................................................................ 1587rusage(1B) ....................................................................................................................................... 1588rusers(1) .......................................................................................................................................... 1590rwho(1) .............................................................................................................................................. 1591sar(1) ................................................................................................................................................ 1592sccs(1) .............................................................................................................................................. 1597sccs-admin(1) ................................................................................................................................. 1607sccs-cdc(1) ..................................................................................................................................... 1612sccs-comb(1) ................................................................................................................................... 1614sccs-delta(1) ................................................................................................................................. 1616sccs-get(1) ..................................................................................................................................... 1619sccs-help(1) ................................................................................................................................... 1625sccs-prs(1) ..................................................................................................................................... 1626sccs-prt(1) ..................................................................................................................................... 1630sccs-rmdel(1) ................................................................................................................................. 1633sccs-sact(1) ................................................................................................................................... 1634sccs-sccsdiff(1) ........................................................................................................................... 1635sccs-unget(1) ................................................................................................................................. 1636sccs-val(1) ..................................................................................................................................... 1637

Contents

13

scp(1) ................................................................................................................................................ 1639script(1) .......................................................................................................................................... 1641sdiff(1) ............................................................................................................................................ 1642sed(1) ................................................................................................................................................ 1644sed(1B) ............................................................................................................................................. 1652set(1) ................................................................................................................................................ 1658setfacl(1) ........................................................................................................................................ 1668setlabel(1) ..................................................................................................................................... 1672setpgrp(1) ........................................................................................................................................ 1674sftp(1) .............................................................................................................................................. 1675sh(1) .................................................................................................................................................. 1679shcomp(1) .......................................................................................................................................... 1700shell_builtins(1) ......................................................................................................................... 1702shift(1) ............................................................................................................................................ 1708shutdown(1B) ................................................................................................................................... 1710size(1) .............................................................................................................................................. 1711sleep(1) ............................................................................................................................................ 1713smbutil(1) ........................................................................................................................................ 1715soelim(1) .......................................................................................................................................... 1720sort(1) .............................................................................................................................................. 1721sortbib(1) ........................................................................................................................................ 1728sotruss(1) ........................................................................................................................................ 1730spell(1) ............................................................................................................................................ 1732split(1) ............................................................................................................................................ 1734srchtxt(1) ........................................................................................................................................ 1736ssh(1) ................................................................................................................................................ 1739ssh-add(1) ........................................................................................................................................ 1751ssh-agent(1) ................................................................................................................................... 1753ssh-http-proxy-connect(1) ........................................................................................................ 1755ssh-keygen(1) ................................................................................................................................. 1757ssh-keyscan(1) ............................................................................................................................... 1761ssh-socks5-proxy-connect(1) .................................................................................................... 1763strchg(1) .......................................................................................................................................... 1765strings(1) ........................................................................................................................................ 1768strip(1) ............................................................................................................................................ 1770stty(1) .............................................................................................................................................. 1772

Contents

man pages section 1: User Commands • November 2010 (Beta)14

stty(1B) ........................................................................................................................................... 1781sum(1) ................................................................................................................................................ 1788sum(1B) ............................................................................................................................................. 1793suspend(1) ........................................................................................................................................ 1794svcprop(1) ........................................................................................................................................ 1795svcs(1) .............................................................................................................................................. 1799symorder(1) ..................................................................................................................................... 1806sys-suspend(1) ............................................................................................................................... 1807sysV-make(1) ................................................................................................................................... 1809tabs(1) .............................................................................................................................................. 1816tail(1) .............................................................................................................................................. 1820talk(1) .............................................................................................................................................. 1825tar(1) ................................................................................................................................................ 1828tbl(1) ................................................................................................................................................ 1841tcopy(1) ............................................................................................................................................ 1843tee(1) ................................................................................................................................................ 1844telnet(1) .......................................................................................................................................... 1846test(1) .............................................................................................................................................. 1859test(1B) ........................................................................................................................................... 1868tftp(1) .............................................................................................................................................. 1870time(1) .............................................................................................................................................. 1873times(1) ............................................................................................................................................ 1876timex(1) ............................................................................................................................................ 1877tip(1) ................................................................................................................................................ 1879tnfdump(1) ........................................................................................................................................ 1888tnfxtract(1) ................................................................................................................................... 1894touch(1) ............................................................................................................................................ 1896touch(1B) ......................................................................................................................................... 1900tplot(1) ............................................................................................................................................ 1901tput(1) .............................................................................................................................................. 1902tr(1) .................................................................................................................................................. 1907tr(1B) ................................................................................................................................................ 1912trap(1) .............................................................................................................................................. 1913troff(1) ............................................................................................................................................ 1916true(1) .............................................................................................................................................. 1919truss(1) ............................................................................................................................................ 1920

Contents

15

tset(1B) ........................................................................................................................................... 1928tsort(1) ............................................................................................................................................ 1933tty(1) ................................................................................................................................................ 1935type(1) .............................................................................................................................................. 1937typeset(1) ........................................................................................................................................ 1938ul(1) .................................................................................................................................................. 1940umask(1) ............................................................................................................................................ 1941uname(1) ............................................................................................................................................ 1945unifdef(1) ........................................................................................................................................ 1947uniq(1) .............................................................................................................................................. 1949units(1) ............................................................................................................................................ 1952unix2dos(1) ..................................................................................................................................... 1954uptime(1) .......................................................................................................................................... 1956userattr(1) ..................................................................................................................................... 1957users(1B) ......................................................................................................................................... 1958uucp(1C) ........................................................................................................................................... 1959uuencode(1C) ................................................................................................................................... 1963uuglist(1C) ..................................................................................................................................... 1967uustat(1C) ....................................................................................................................................... 1968uuto(1C) ........................................................................................................................................... 1972uux(1C) ............................................................................................................................................. 1975vacation(1) ..................................................................................................................................... 1979vc(1) .................................................................................................................................................. 1983vgrind(1) .......................................................................................................................................... 1986vi(1) .................................................................................................................................................. 1989vipw(1B) ........................................................................................................................................... 2000volcheck(1) ..................................................................................................................................... 2001volrmmount(1) ................................................................................................................................. 2003w(1) .................................................................................................................................................... 2005wait(1) .............................................................................................................................................. 2007wc(1) .................................................................................................................................................. 2010what(1) .............................................................................................................................................. 2012whatis(1) .......................................................................................................................................... 2014whereis(1B) ..................................................................................................................................... 2015which(1) ............................................................................................................................................ 2017who(1) ................................................................................................................................................ 2018

Contents

man pages section 1: User Commands • November 2010 (Beta)16

whoami(1B) ....................................................................................................................................... 2022whocalls(1) ..................................................................................................................................... 2023whois(1) ............................................................................................................................................ 2024write(1) ............................................................................................................................................ 2025xargs(1) ............................................................................................................................................ 2028xgettext(1) ..................................................................................................................................... 2033xstr(1) .............................................................................................................................................. 2035yacc(1) .............................................................................................................................................. 2037yes(1) ................................................................................................................................................ 2040ypcat(1) ............................................................................................................................................ 2041ypmatch(1) ........................................................................................................................................ 2042yppasswd(1) ..................................................................................................................................... 2043ypwhich(1) ........................................................................................................................................ 2044zlogin(1) .......................................................................................................................................... 2045zonename(1) ..................................................................................................................................... 2048zonestat(1) ..................................................................................................................................... 2049

Contents

17

18

Preface

Both novice users and those familar with the SunOS operating system can use online man pagesto obtain information about the system and its features. A man page is intended to answerconcisely the question “What does it do?” The man pages in general comprise a referencemanual. They are not intended to be a tutorial.

OverviewThe following contains a brief description of each man page section and the information itreferences:

■ Section 1 describes, in alphabetical order, commands available with the operating system.■ Section 1M describes, in alphabetical order, commands that are used chiefly 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.■ Section 4 outlines the formats of various files. The C structure declarations for the file

formats are given where applicable.■ Section 5 contains miscellaneous documentation such as character-set tables.■ Section 7 describes various special files that refer to specific hardware peripherals and device

drivers. STREAMS software drivers, modules and the STREAMS-generic set of system callsare also described.

■ Section 9E describes the DDI (Device Driver Interface)/DKI (Driver/Kernel Interface),DDI-only, and DKI-only entry-point routines a developer can 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 generallyfollow this order, but include only needed headings. For example, if there are no bugs to report,

19

there is no BUGS section. See the intro pages for more information and detail about eachsection, and man(1) for more information about man pages in general.

NAME This section gives the names of the commands or functionsdocumented, followed by a brief description of what theydo.

SYNOPSIS This section shows the syntax of commands or functions.When a command or file does not exist in the standardpath, its full path name is shown. Options and argumentsare alphabetized, with single letter arguments first, andoptions with arguments next, unless a different argumentorder is required.

The following special characters are used in this section:

[ ] Brackets. The option or argument enclosed inthese brackets is optional. If the brackets areomitted, the argument must be specified.

. . . Ellipses. Several values can be provided for theprevious argument, or the previous argumentcan be specified multiple times, for example,"filename . . ." .

| Separator. Only one of the argumentsseparated by this character can be specified at atime.

{ } Braces. The options and/or argumentsenclosed within braces are interdependent,such that everything enclosed must be treatedas a unit.

PROTOCOL This section occurs only in subsection 3R to indicate theprotocol description file.

DESCRIPTION This section defines the functionality and behavior of theservice. Thus it describes concisely what the commanddoes. It does not discuss OPTIONS or cite EXAMPLES.Interactive commands, subcommands, requests, macros,and functions are described under USAGE.

IOCTL This section appears on pages in Section 7 only. Only thedevice class that supplies appropriate parameters to theioctl(2) system call is called ioctl and generates its ownheading. ioctl calls for a specific device are listedalphabetically (on the man page for that specific device).

Preface

man pages section 1: User Commands • November 2010 (Beta)20

http://www.oracle.com/pls/topic/lookup?ctx=821-1463&id=ioctl-2

ioctl calls are used for a particular class of devices all ofwhich have an io ending, such as mtio(7I).

OPTIONS This secton lists the command options with a concisesummary of what each option does. The options are listedliterally and in the order they appear in the SYNOPSISsection. Possible arguments to options are discussed underthe option, and where appropriate, default values aresupplied.

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

OUTPUT This section describes the output – standard output,standard error, or output files – generated by thecommand.

RETURN VALUES If the man page documents functions that return values,this section lists these values and describes the conditionsunder which they are returned. If a function can returnonly constant values, such as 0 or –1, these values are listedin tagged paragraphs. Otherwise, a single paragraphdescribes the return values of each function. Functionsdeclared void do not return values, so they are notdiscussed in RETURN VALUES.

ERRORS On failure, most functions place an error code in the globalvariable errno indicating why they failed. This section listsalphabetically all error codes a function can generate anddescribes the conditions that cause each error. When morethan one condition can cause the same error, eachcondition is described in a separate paragraph under theerror code.

USAGE This section lists special rules, features, and commandsthat require in-depth explanations. The subsections listedhere are used to explain built-in functionality:

CommandsModifiersVariablesExpressionsInput Grammar

EXAMPLES This section provides examples of usage or of how to use acommand or function. Wherever possible a complete

Preface

21

http://www.oracle.com/pls/topic/lookup?ctx=821-1475&id=mtio-7i

example including command-line entry and machineresponse is shown. Whenever an example is given, theprompt is shown as example%, or if the user must besuperuser, example#. Examples are followed byexplanations, variable substitution rules, or returnedvalues. Most examples illustrate concepts from theSYNOPSIS, DESCRIPTION, OPTIONS, and USAGEsections.

ENVIRONMENT VARIABLES This section lists any environment variables that thecommand or function affects, followed by a briefdescription of the effect.

EXIT STATUS This section lists the values the command returns to thecalling program or shell and the conditions that cause thesevalues to be returned. Usually, zero is returned forsuccessful completion, and values other than zero forvarious error conditions.

FILES This section lists all file names 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.

ATTRIBUTES This section lists characteristics of commands, utilities,and device drivers by defining the attribute type and itscorresponding value. See attributes(5) for moreinformation.

SEE