1766
man pages section 1: User Commands Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054 U.S.A. Part No: 817–0689–10 December 2003

817-0689 --PDF guide

Embed Size (px)

Citation preview

man pages section 1: User Commands

Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054 U.S.A.Part No: 817068910 December 2003

Copyright 2003 Sun Microsystems, Inc.

4150 Network Circle, Santa Clara, CA 95054 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. Third-party software, including font technology, is copyrighted and licensed from Sun suppliers. Parts of the product may be derived from Berkeley BSD systems, licensed from the University of California. UNIX is a registered trademark in the U.S. and other countries, exclusively licensed through X/Open Company, Ltd. Sun, Sun Microsystems, the Sun logo, docs.sun.com, AnswerBook, AnswerBook2, and Solaris are trademarks, registered trademarks, or service marks of Sun Microsystems, Inc. in the U.S. and other countries. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc. The OPEN LOOK and Sun Graphical User Interface was 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 Suns licensees who implement OPEN LOOK GUIs and otherwise comply with Suns written license agreements. Federal Acquisitions: Commercial SoftwareGovernment Users Subject to Standard License Terms and Conditions. DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. Copyright 2003 Sun Microsystems, Inc. 4150 Network Circle, Santa Clara, CA 95054 U.S.A. Tous droits rservs.

Ce produit ou document est protg par un copyright et distribu avec des licences qui en restreignent lutilisation, la copie, la distribution, et la dcompilation. Aucune partie de ce produit ou document ne peut tre reproduite sous aucune forme, par quelque moyen que ce soit, sans lautorisation pralable et crite de Sun et de ses bailleurs de licence, sil y en a. Le logiciel dtenu par des tiers, et qui comprend la technologie relative aux polices de caractres, est protg par un copyright et licenci par des fournisseurs de Sun. Des parties de ce produit pourront tre drives du systme Berkeley BSD licencis par lUniversit de Californie. UNIX est une marque dpose aux Etats-Unis et dans dautres pays et licencie exclusivement par X/Open Company, Ltd. Sun, Sun Microsystems, le logo Sun, docs.sun.com, AnswerBook, AnswerBook2, et Solaris sont des marques de fabrique ou des marques dposes, ou marques de service, de Sun Microsystems, Inc. aux Etats-Unis et dans dautres pays. Toutes les marques SPARC sont utilises sous licence et sont des marques de fabrique ou des marques dposes de SPARC International, Inc. aux Etats-Unis et dans dautres pays. Les produits portant les marques SPARC sont bass sur une architecture dveloppe par Sun Microsystems, Inc. Linterface dutilisation graphique OPEN LOOK et Sun a t dveloppe par Sun Microsystems, Inc. pour ses utilisateurs et licencis. Sun reconnat les efforts de pionniers de Xerox pour la recherche et le dveloppement du concept des interfaces dutilisation visuelle ou graphique pour lindustrie de linformatique. Sun dtient une licence non exclusive de Xerox sur linterface dutilisation graphique Xerox, cette licence couvrant galement les licencis de Sun qui mettent en place linterface dutilisation graphique OPEN LOOK et qui en outre se conforment aux licences crites de Sun. CETTE PUBLICATION EST FOURNIE EN LETAT ET AUCUNE GARANTIE, EXPRESSE OU IMPLICITE, NEST ACCORDEE, Y COMPRIS DES GARANTIES CONCERNANT LA VALEUR MARCHANDE, LAPTITUDE DE LA PUBLICATION A REPONDRE A UNE UTILISATION PARTICULIERE, OU LE FAIT QUELLE NE SOIT PAS CONTREFAISANTE DE PRODUIT DE TIERS. CE DENI DE GARANTIE NE SAPPLIQUERAIT PAS, DANS LA MESURE OU IL SERAIT TENU JURIDIQUEMENT NUL ET NON AVENU.

030827@6671

ContentsPreface 19

Introduction Intro(1) 26

25

User Commands acctcom(1) adb(1) addbib(1) alias(1) allocate(1) amt(1) 41 36 39 33 34 30

29

answerbook2(1) appcert(1) apptrace(1) apropos(1) ar(1) arch(1) as(1) asa(1) at(1) atq(1) atrm(1) 57 61 62 66 68 75 76 43 50 55

42

audioconvert(1) audioplay(1) 81

77

3

audiorecord(1) auths(1) awk(1) banner(1) basename(1) basename(1B) bc(1) bdiff(1) bfs(1) biff(1B) break(1) cal(1) cancel(1) cat(1) cc(1B) cd(1) cdrw(1) checknr(1) chgrp(1) chkey(1) chmod(1) chown(1) chown(1B) ckdate(1) ckgid(1) ckint(1) ckitem(1) ckkeywd(1) ckpath(1) ckrange(1) ckstr(1) cksum(1) cktime(1) ckuid(1) ckyorn(1) clear(1) cmp(1)4

83

86 88 93 94 96

97 101 102 106 107 109 110 112 114 117 119 122 128 129 131 133 139 141 142 145 147 149 152 154 157 160 163 165 167 169 171 172

calendar(1)

man pages section 1: User Commands December 2003

col(1) comm(1)

174 176 178 181 184

command(1) compress(1) coproc(1F) cp(1) cpio(1) cpp(1) crle(1) crypt(1) csh(1) csplit(1) ct(1C) ctags(1) cu(1C) cut(1) date(1) dc(1) 188 192 200

cputrack(1) 210 crontab(1) 225

206 220

224 251 254 256 259 266 269 273 277 279 280 281 283 287 289 290 293 294 295 297

deallocate(1) deroff(1) df(1B) diff(1) diff3(1) diffmk(1) dircmp(1) dis(1) 291 dispgid(1) dispuid(1) dos2unix(1) download(1) dpost(1) du(1) du(1B) dump(1) dumpcs(1) 299 302 305 307 dhcpinfo(1)

310Contents 5

echo(1) echo(1B) echo(1F) ed(1) edit(1) egrep(1) eject(1) enable(1) env(1) eqn(1) error(1) ex(1) exec(1) exit(1) expand(1)

311 315 316 317 329 333 336 340 342 344 346 351 355 365 367 369 371 372 375 378 382 383 384 385

elfdump(1)

exportfs(1B) expr(1) expr(1B) exstr(1) face(1) factor(1) fdformat(1) fgrep(1) le(1) le(1B) lesync(1) nd(1) nger(1) fmlcut(1F) fmlexpr(1F) fmlgrep(1F) fmli(1) fmt(1) fnattr(1) fnbind(1)6

fastboot(1B) 390 392 394

396 410 413 415 418

403

420 423 424 429 432

fmtmsg(1)

man pages section 1: User Commands December 2003

fnlist(1)

434 436 437 438 445 448 449 460 461 462 463 466 469

fnlookup(1) fnrename(1) fnsearch(1) fnunbind(1) fold(1) from(1B) ftp(1) ftpcount(1) ftpwho(1) gcore(1) gencat(1) 446

geniconvtbl(1) genlayouttbl(1) genmsg(1) getconf(1) getfacl(1) getfrm(1F) getitems(1F) getopt(1) getoptcvt(1) getopts(1) gettext(1) gettxt(1) glob(1) gprof(1) graph(1) grep(1) groups(1) groups(1B) grpck(1B) hash(1) head(1) history(1) hostid(1) iconv(1) hostname(1) 547 indicator(1F) 532 534 536 545 484 490 495 499

500 501 503 506 512

514 516 517 522 524 529 530 531

546 549Contents 7

indxbib(1) install(1B) ipcrm(1) ipcs(1) isainfo(1) isalist(1) jobs(1) join(1) kbd(1) 554

550 551 553 558 560

561 568 571 574 575 577

kdestroy(1) keylogin(1) keylogout(1) kill(1) kinit(1) klist(1) ksh(1) ktutil(1) last(1) ld(1) ld(1B) ldap(1) ldaplist(1) 578 582 587

kpasswd(1) 590 641 643

589

lastcomm(1) 647 659 660

645

ldapdelete(1) ldapmodify(1) ldapmodrdn(1) ldapsearch(1) ldd(1) ld.so.1(1) let(1) lex(1) limit(1) line(1) lint(1B) 695 696 708 713 714 683 688

664 667 671 675 678

list_devices(1) listusers(1)

716 718 719

llc2_autocong(1)8

man pages section 1: User Commands December 2003

llc2_cong(1) llc2_stats(1) ln(1) ln(1B) locale(1) localedef(1) logger(1) logger(1B) login(1) logout(1) look(1) lookbib(1) lorder(1) lp(1) lpc(1B) lpq(1B) lpr(1B) lprm(1B) lpstat(1) lptest(1B) ls(1) ls(1B) m4(1) mach(1) machid(1) madv.so.1(1) mail(1B) mailp(1) mailq(1) mailstats(1) mailx(1) make(1S) man(1) mcs(1) mconnect(1) 877 805 mailcompat(1) 807 809 784 790 793 798 760 767 771 773 777 779 783 logname(1) 757 730 733

720 722

loadkeys(1)

736 737 740 744 746

748 755 756 758 759

799 801 806

811 813 835

870 876

Contents

9

mdb(1) mesg(1)

879 920 921 923 925 927 929 931 938 946 949

message(1F) mixerctl(1) mkdir(1) mkmsgs(1) mkstr(1B) more(1) mp(1)

mpss.so.1(1) msgfmt(1) mt(1) mv(1) nawk(1) nca(1) ncab2clf(1) ncakmod(1) netscape(1) newform(1) newgrp(1) news(1) newtask(1) nice(1) nis+(1) niscat(1) nischgrp(1) nischmod(1) nischown(1) nischttl(1) niserror(1) nisgrpadm(1) nisln(1) nisls(1) 1038 1040 nisdefaults(1) 997 955 958 961 982

984 986 987 992 995 998

1001 1003 1018 1021 1023 1026 1028 1030 1033 1034

nismatch(1) nismkdir(1) nisopaccess(1) nispasswd(1)10

1042 1045 1048 1051

man pages section 1: User Commands December 2003

nisrm(1) nisrmdir(1)

1055 1057 1059 1065 1071 1076 1080 1083 1089 1091 1092 1095 1096 1098 1105 1108 1113 1116

nistbladm(1) nistest(1) nl(1) nm(1) nohup(1) nroff(1) od(1) on(1) pack(1) pargs(1) passwd(1) paste(1) patch(1) pathchk(1) pathconv(1F) pax(1) perl(1) pfexec(1) pg(1) pgrep(1) pkginfo(1) pkgmk(1) pkgparam(1) pkgproto(1) pkgtrans(1) plimit(1) plot(1B) pmap(1) postdmd(1) postio(1) postmd(1) postplot(1) postprint(1) 1118 1127 1067

optisa(1) pagesize(1)

1134 1140 1144 1146 1149 1151 1153 1156 1158 1160 1167 1169 1171 1174 1177 1179Contents 11

1135

postdaisy(1)

postreverse(1) posttek(1) ppgsz(1) pr(1) prctl(1) preap(1) prex(1) print(1) printf(1) priocntl(1) proc(1) prof(1) proles(1) projects(1) ps(1) ps(1B) pvs(1) pwd(1) ranlib(1) rcapstat(1) rcp(1) rdist(1) read(1) 1260 1262 1267 1239 1248 1251 1254 1255 praliases(1) 1188 1185

1181

1183

1193 1197

1194 1199 1211 1212 1218 1229 1232 1236 1238 1213

printenv(1B)

1256

readle(1F) readonly(1) refer(1) regcmp(1) regex(1F) reinit(1F) renice(1) reset(1F) rlogin(1) rm(1)

1270 1271 1274 1276 1278 1279 1282 1283

1272

1286 1290 1298 1300

rmformat(1) roffbib(1) roles(1)12

man pages section 1: User Commands December 2003

rpcgen(1) rpm2cpio(1) rsh(1) run(1F) runat(1) rup(1) rup(1C) ruptime(1) rusage(1B) rusers(1) rwho(1) sag(1) sar(1) sccs(1)

1302 1307

1308 1312 1314 1317 1318 1319 1320 1322 1323 1324 1326 1331 1341 1345 1347 1349 1352 1358 1359 1363 1366 1367 1368 1369 1370 1374 1375 1377 1385 1391 1396 1398 1399 1403 1404Contents 13

sccs-admin(1) sccs-cdc(1) sccs-comb(1) sccs-delta(1) sccs-get(1) sccs-help(1) sccs-prs(1) sccs-prt(1) sccs-rmdel(1) sccs-sact(1) sccs-unget(1) sccs-val(1) scp(1) script(1) sdiff(1) sed(1) sed(1B) set(1) set(1F) setfacl(1) setpgrp(1) sftp(1) 1372 sccs-sccsdiff(1)

setcolor(1F)

sh(1)

1407 1425 1426 1431 1430 1432 1434 1436 1438 1439 1449 1451 1453 1456 1457 1459 1472 1474 1476 1481 1478 1462 1442

shell(1F) shift(1) size(1) sleep(1) soelim(1) solregis(1) sort(1) sortbib(1) sotruss(1) spell(1) spline(1) split(1) srchtxt(1) ssh(1) ssh-add(1)

shell_builtins(1) shutdown(1B)

smart2cfg(1)

ssh-agent(1) ssh-keygen(1) strchg(1) strings(1) strip(1) stty(1) stty(1B) sum(1) sum(1B) suspend(1) symorder(1) sysV-make(1) tabs(1) tail(1) talk(1) tar(1) tbl(1)14

ssh-http-proxy-connect(1) ssh-socks5-proxy-connect(1) 1483 1486 1488 1490 1498 1505 1506 1507 1508 1509

1516 1520 1523 1526 1537

man pages section 1: User Commands December 2003

tcopy(1) tee(1) telnet(1) test(1) test(1B) test(1F) tftp(1) time(1) times(1) timex(1) tip(1) tnfdump(1) tnfxtract(1) touch(1) touch(1B) tplot(1) tput(1) tr(1) tr(1B) trap(1) troff(1) true(1) truss(1) tset(1B) tsort(1) tty(1) type(1) typeset(1)

1539 1540 1541 1551 1559 1561 1563 1566 1569 1570 1572 1581 1586 1588 1592 1593 1594

1599 1604 1605 1607 1610 1611 1618 1623 1625 1626 1627 1629 1631 1635 1638 1640 1643 1645 1647 1648Contents 15

ucblinks(1B) ul(1) 1630 umask(1) uname(1) unifdef(1) uniq(1) units(1) uptime(1) users(1B)

unix2dos(1)

uucp(1C) uuglist(1C) uustat(1C) uuto(1C) uux(1C) vacation(1) vc(1) vi(1)

1649 1653 1656 1657 1661 1664 1668 1675 1689 1690 1691 1693 1694

uuencode(1C)

1671 1679

vgrind(1) vipw(1B) volcancel(1) volcheck(1)

volmissing(1) volrmmount(1) vsig(1F) w(1) wait(1) wc(1) what(1) whatis(1) whereis(1B) which(1) who(1) whoami(1B) whocalls(1) whois(1) write(1) xargs(1) xgettext(1) xstr(1) yacc(1) yes(1) ypcat(1) ypmatch(1) yppasswd(1) ypwhich(1) 1710 1696 1699 1702 1704 1697

1706 1707 1709 1713 1714 1715 1716 1719 1724 1726 1728 1732 1733 1734 1735 1736

16

man pages section 1: User Commands December 2003

Index

1737

Contents

17

18

man pages section 1: User Commands December 2003

PrefaceBoth novice users and those familar with the SunOS operating system can use online man pages to obtain information about the system and its features. 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.

OverviewThe following contains a brief description of each man page section and the information it references:I

Section 1 describes, in alphabetical order, commands available with the operating system. Section 1M describes, in alphabetical order, commands that are used chiey 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 les. The C structure declarations for the le formats are given where applicable. Section 5 contains miscellaneous documentation such as character-set tables. Section 6 contains available games and demos. Section 7 describes various special les that refer to specic hardware peripherals and device drivers. STREAMS software drivers, modules and the STREAMS-generic set of system calls are also described.

I

I

I

I

I I I

19

I

Section 9 provides reference information needed to write device drivers in the kernel environment. It describes two device driver interface specications: the Device Driver Interface (DDI) and the DriverKernel Interface (DKI). Section 9E describes the DDI/DKI, 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.

I

I I

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. This section shows the syntax of commands or functions. When a command or le does not exist in the standard path, its full path name is shown. Options and arguments are alphabetized, with single letter arguments rst, and options with arguments next, unless a different argument order is required. The following special characters are used in this section: [ ] Brackets. The option or argument enclosed in these brackets is optional. If the brackets are omitted, the argument must be specied. Ellipses. Several values can be provided for the previous argument, or the previous argument can be specied multiple times, for example, "filename . . ." . Separator. Only one of the arguments separated by this character can be specied at a time. Braces. The options and/or arguments enclosed within braces are interdependent, such that everything enclosed must be treated as a unit.

SYNOPSIS

. . .

|

{ }

20

man pages section 1: User Commands December 2003

PROTOCOL DESCRIPTION

This section occurs only in subsection 3R to indicate the protocol description le. This section denes 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, and functions are described under USAGE. This section appears on pages in Section 7 only. Only the device class that supplies appropriate parameters to the ioctl(2) system call is called ioctl and generates its own heading. ioctl calls for a specic device are listed alphabetically (on the man page for that specic device). ioctl calls are used for a particular class of devices all of which have an io ending, such as mtio(7I). This secton 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. This section lists the command operands and describes how they affect the actions of the command. This section describes the output standard output, standard error, or output les generated by the command. 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 void do not return values, so they are not discussed in RETURN VALUES. 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 thanPreface 21

IOCTL

OPTIONS

OPERANDS

OUTPUT

RETURN VALUES

ERRORS

one condition can cause the same error, each condition is described in a separate paragraph under the error code. USAGE This section lists special rules, features, and commands that require in-depth explanations. The subsections listed here are used to explain built-in functionality: Commands Modiers 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 superuser, example#. Examples are followed by explanations, variable substitution rules, or returned values. Most examples illustrate concepts from the SYNOPSIS, DESCRIPTION, OPTIONS, and USAGE sections. This section lists any environment variables that the command or function affects, followed by a brief description of the effect. 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 other than zero for various error conditions. This section lists all le names referred to by the man page, les of interest, and les created or required by commands. Each is followed by a descriptive summary or explanation. This section lists characteristics of commands, utilities, and device drivers by dening the attribute type and its corresponding value. See attributes(5) for more information. This section lists references to other man pages, in-house documentation, and outside publications.

ENVIRONMENT VARIABLES

EXIT STATUS

FILES

ATTRIBUTES

SEE ALSO

22

man pages section 1: User Commands December 2003

DIAGNOSTICS WARNINGS

This section lists diagnostic messages with a brief explanation of the condition causing the error. This section lists warnings about special conditions which could seriously affect your working conditions. This is not a list of diagnostics. 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. This section describes known bugs and, wherever possible, suggests workarounds.

NOTES

BUGS

Preface

23

24

man pages section 1: User Commands December 2003

Introduction

25

Intro(1)NAME DESCRIPTION Intro introduction to commands and application programs This section describes, in alphabetical order, commands available with this operating system. Pages of special interest are categorized as follows: 1B 1C 1F 1S OTHER SECTIONS Commands found only in the SunOS/BSD Compatibility Package. Commands for communicating with other systems. Commands associated with Form and Menu Language Interpreter (FMLI). Commands specic to the SunOS system.

See these sections of the man pages section 1M: System Administration Commands for more information.I I I

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.

I

For tutorial information about these commands and procedures, see:I

Solaris Advanced Users Guide

Manual Page Command Syntax

Unless otherwise noted, commands described in the SYNOPSIS section of a manual page accept options and other arguments according to the following syntax and should be interpreted as explained below. name [-option...] [cmdarg...] where: [ ] ... name { } Surround an option or cmdarg that is not required. Indicates multiple occurrences of the option or cmdarg. 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. (Always preceded by a .) noargletter... or, argletter optarg[,...] 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). A single letter representing an option requiring an option-argument.

option noargletter

argletter

26

man pages section 1: User Commands Last Revised 1 Nov 1999

Intro(1)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). Path name (or other command argument) not beginning with , or by itself indicating the standard input.

cmdarg Command Syntax Standard: Rules

These command syntax rules are not followed by all current commands, but all new commands will obey them. getopts(1) should be used by all shell procedures to parse positional 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 signicance 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.

ATTRIBUTES SEE ALSO DIAGNOSTICS

See attributes(5) for a discussion of the attributes listed in this section. getopts(1), wait(1), exit(2), getopt(3C), wait(3UCB), attributes(5) 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(3UCB) 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 conventions are involved.

Introduction

27

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

28

man pages section 1: User Commands Last Revised 1 Nov 1999

User Commands

29

acctcom(1)NAME SYNOPSIS acctcom search and print process accounting les acctcom [-abfhikmqrtv] [-C sec] [-e time] [-E time] [-g group] [-H factor] [-I chars] [-l line] [-n pattern] [-o output-le] [-O sec] [-s time] [-S time] [-u user] [lename] The acctcom utility reads lenames, the standard input, or /var/adm/pacct, in the form described by acct(3HEAD) 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() ag: 1 for fork() without exec()), STAT (the system exit status), HOG FACTOR, 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 eld. If no lename is specied, 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 lename arguments are given, they are read in their respective order. Each le is normally read forward, that is, in chronological order by process completion time. The le /var/adm/pacct is usually the current le to be examined; a busy system may need several such les of which all but the current le are found in /var/adm/pacctincr. OPTIONS The following options are supported: -a -b -f -h Show some average statistics about the processes selected. The statistics will be printed after the output records. Read backwards, showing latest commands rst. This option has no effect when standard input is read. Print the fork()/exec() ag and system exit status columns in the output. The numeric output for this option will be in octal. 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). Print columns containing the I/O counts in the output. Instead of memory size, show total kcore-minutes. Show mean core size (the default). Do not print any output records, just print the average statistics as with the -a option. Show CPU factor (user-time/(system-time + user-time)).

DESCRIPTION

-i -k -m -q -r

30

man pages section 1: User Commands Last Revised 11 Jan 1996

acctcom(1)-t -v -C sec -e time -E time -g group -H factor -I chars -l line -n pattern Show separate system and user CPU times. Exclude column headings from the output. Show only processes with total CPU time (system-time + user-time) exceeding sec seconds. Select processes existing at or before time. Select processes ending at or before time. Using the same time for both -S and -E shows the processes that existed at time. Show only processes belonging to group. The group may be designated by either the group ID or group name. Show only processes that exceed factor, where factor is the hog factor as explained in option -h above. Show only processes transferring more characters than the cutoff number given by chars. Show only processes belonging to terminal /dev/term/line. Show only commands matching pattern that may be a regular expression as in regcmp(3C), except + means one or more occurrences. Copy selected process records in the input data format to output-le; suppress printing to standard output. Show only processes with CPU system time exceeding sec seconds. Select processes existing at or after time, given in the format hr [ :min [ :sec ] ]. Select processes starting at or after time. Show only processes belonging to user. The user may be specied 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). system group le system password le active processes accounting le

-o output-le -O sec -s time -S time -u user

FILES

/etc/group /etc/passwd /var/adm/pacctincr

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability

SUNWaccu

User Commands

31

acctcom(1)ATTRIBUTE TYPE ATTRIBUTE VALUE

CSI

enabled

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(3C), acct(3HEAD), utmp(4), attributes(5) System Administration Guide: Basic Administration

NOTES

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

32

man pages section 1: User Commands Last Revised 11 Jan 1996

adb(1)NAME SYNOPSIS DESCRIPTION adb general-purpose debugger adb [-kw] [-I dir] [-P prompt] [-V mode] [object [core]] The adb utility is an interactive, general-purpose debugger. It can be used to examine les and provides a controlled environment for the execution of programs. The adb utility is now implemented as a link to the mdb(1) utility in Solaris 9. mdb(1) is a low-level debugging utility that can be used to examine user processes as well as the live operating system or operating system crash dumps. The new mdb(1) utility provides complete backwards compatibility with the existing syntax and features of adb, including support for processing adb macro les. The Solaris Modular Debugger Guide and mdb(1) man page describes the features of mdb, including its adb compatibility mode. This mode will be activated by default when the adb link is executed. ATTRIBUTES See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability

SUNWmdb (32-bit) SUNWmdbx (64-bit)

SEE ALSO

mdb(1), attributes(5) Solaris Modular Debugger Guide

User Commands

33

addbib(1)NAME SYNOPSIS DESCRIPTION addbib create or extend a bibliographic database addbib [-a] [-p promptle] database When addbib starts up, answering y to the initial Instructions? prompt yields directions. Typing n (or RETURN) skips the directions. addbib then prompts for various bibliographic elds, reads responses from the terminal, and sends output records to database. A null response (just RETURN) means to leave out that eld. A (minus sign) means to go back to the previous eld. A trailing backslash allows a eld 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)). The following options are supported: -a -p promptle Suppresses prompting for an abstract. Asking for an abstract is the default. Abstracts are ended with a ControlD. Uses a new prompting skeleton, dened in promptle. This le should contain prompt strings, a TAB, and the key-letters to be written to the database.

OPTIONS

USAGE Bibliography Key Letters The most common key-letters and their meanings are given below. addbib insulates you from these key-letters, since it gives you prompts in English, but if you edit the bibliography le later on, you will need to know this information. %A %B %C %D %E %F %G %H %I %J %K %L %M %N %O34

Authors name Book containing article referenced City (place of publication) Date of publication Editor of book containing article referenced Footnote number or label (supplied by refer) Government order number Header commentary, printed before reference Issuer (publisher) Journal containing article Keywords to use in locating reference Label eld used by -k option of refer Bell Labs Memorandum (undened) Number within volume Other commentary, printed at end of reference

man pages section 1: User Commands Last Revised 14 Sep 1992

addbib(1)%P %Q %R %S %T %V %X %Y,Z EXAMPLESEXAMPLE 1

Page number(s) Corporate or Foreign Author (unreversed) Report, paper, or thesis (unpublished) Series title Title of article or book Volume number Abstract used by roffbib, not by refer Ignored by referEditing the bibliography le

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

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability

SUNWdoc

SEE ALSO

ed(1), ex(1), indxbib(1), lookbib(1), refer(1), roffbib(1), sortbib(1), vi(1), attributes(5)

User Commands

35

alias(1)NAME SYNOPSIS alias, unalias create or remove a pseudonym or shorthand for a command or series of commands /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 The alias and unalias utilities create or remove a pseudonym or shorthand term for a command or series of commands, with different functionality in the C-shell and Korn shell environments. The alias utility creates or redenes alias denitions or writes the values of existing alias denitions to standard output. An alias denition provides a string value that replaces a command name when it is encountered. An alias denition affects the current shell execution environment and the execution environments of the subshells of the current shell. When used as specied by this document, the alias denition will not affect the parent process of the current shell nor any utility environment invoked by the shell. /usr/bin/unalias csh The unalias utility removes the denition for each alias name specied. The aliases are removed from the current shell execution environment. 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. If def is omitted, the alias name is displayed along with its current denition. If both name and def are omitted, all aliases are displayed. Because of implementation restrictions, an alias denition must have been entered on a previous command line before it can be used. unalias discards aliases that match (lename 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 dened for each name whose value is given. A trailing space in value causes the next word to be checked for alias substitution. The -t ag 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 undened when the value of PATH is reset but the aliases remained tracked. Without the -t ag, for each name in

/usr/bin/alias

36

man pages section 1: User Commands Last Revised 28 Sep 2001

alias(1)the argument list for which no value is given, the name and value of the alias is printed. The -x ag is used to set or print exported aliases. An exported alias is dened for scripts invoked by name. The exit status is non-zero if a name is given, but no value, and no alias has been dened for 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 ksh Removes all alias denitions from the current shell execution environment.

The following option is supported by alias: -t Sets and lists tracked aliases.

OPERANDS alias unalias

The following operands are supported: alias-name alias-name alias-name=string Write the alias denition to standard output. The name of an alias to be removed. Assign the value of string to the alias alias-name.

If no operands are given, all alias denitions will be written to standard output. OUTPUT The format for displaying aliases (when no operands or only name operands are specied) 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. EXAMPLESEXAMPLE 1

Modifying a commands output

This example species that the output of the ls utility is columnated and more annotated:example% alias ls="ls CF"

EXAMPLE 2

Repeating previous entries in the command history le

This example creates a simple redo command to repeat previous entries in the command history le:example% alias r=fc s

EXAMPLE 3

Specifying a commands output options

This example provides that the du utility summarize disk output in units of 1024 bytes:User Commands 37

alias(1)EXAMPLE 3

Specifying a commands output options

(Continued)

example% alias du=du k

EXAMPLE 4

Dealing with an argument that is itself an alias name

This example sets up the nohup utility so that it can deal with an argument that is itself an alias name:example% alias nohup="nohup "

ENVIRONMENT VARIABLES

See environ(5) for descriptions of the following environment variables that affect the execution of alias and unalias: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH. The following exit values are returned: 0 Successful completion. One of the alias-name operands specied did not have an alias denition, or an error occurred. One of the alias-name operands specied did not represent a valid alias denition, or an error occurred.

EXIT STATUS

alias unalias ATTRIBUTES

>0 >0

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability Interface Stability

SUNWcsu Standard

SEE ALSO

csh(1), ksh(1), shell_builtins(1), attributes(5), environ(5), standards(5)

38

man pages section 1: User Commands Last Revised 28 Sep 2001

allocate(1)NAME SYNOPSIS allocate device allocation allocate [-s] [-U uname] device allocate [-s] [-U uname] -g dev-type allocate [-s] [-U uname] -F device DESCRIPTION The allocate utility manages the ownership of devices through its allocation mechanism. It ensures that each device is used by only one qualied user at a time. The device argument species the device to be manipulated. To preserve the integrity of the devices owner, the allocate operation is executed on all the device special les associated with that device. The argument devtype is the device type to be operated on and can only be used with the -g option. The default allocate operation allocates the device special les associated with device to the uid of the current process. If the -F option is specied, the device cleaning program is executed when allocation is performed. This cleaning program is found in /etc/security/lib. The name of this program is found in the device_allocate(4) entry for the device in the devexec eld. Only authorized users may allocate a device. The required authorizations are specied in device_allocate(4). OPTIONS The following options are supported: -g devtype -s -F device Allocates a nonallocated device with a devicetype matching devtype. Silent. Suppresses any diagnostic output. Reallocates the device allocated to another user. This option is often used with -U to reallocate a specic device to a specic user. Only a user with the solaris.devices.revoke authorization is permitted to use this option. Uses the user ID uname instead of the user ID of the current process when performing the allocate operation. Only a user with the solaris.devices.revoke authorization is permitted to use this option.

-U uname

EXIT STATUS

The following exit values are returned: nonzero An error occurred.

FILES

/etc/security/device_allocate /etc/security/device_maps

User Commands

39

allocate(1)/etc/security/dev/* /etc/security/lib/* ATTRIBUTES See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability

SUNWcsu

SEE ALSO NOTES

deallocate(1), list_devices(1), bsmconv(1M), dminfo(1M), device_allocate(4), device_maps(4), attributes(5) The functionality described in this man page is available only if the Basic Security Module (BSM) has been enabled. See bsmconv(1M) for more information. /etc/security/dev, mkdevalloc(1M), and mkdevmaps(1M) may not be supported in a future release of the Solaris operating environment.

40

man pages section 1: User Commands Last Revised 17 Jan 2001

amt(1)NAME SYNOPSIS DESCRIPTION amt run abstract machine test amt [-s] The amt command is for use in a Common Criteria security certied system. The command is used to verify that the low level functions necessary to enforce the object reuse requirements of the Controlled Access Protection Prole are working correctly. /usr/bin/amt is a shell script that executes tests specic to your system. For a 32bit system, the tests run as a 32bit application. For a 64bit system, the tests run twice; once as a 32bit application and once as a 64bit application. amt lists test results with a "pass" or "fail" for each test it performs, unless output is suppressed with the -s option. OPTIONS The following option is supported: s EXIT STATUS Suppresses output.

The following error values are returned: 0 >0 0 Successful completion. An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

User Commands

59

ar(1)/usr/ccs/bin/arAvailabilityATTRIBUTE TYPE ATTRIBUTE VALUE

SUNWbtool

/usr/xpg4/bin/arAvailability

ATTRIBUTE TYPE

ATTRIBUTE VALUE

SUNWxcu4 Standard

Interface Stability

SEE ALSO NOTES

basename(1), cc(1B), cpio(1), ld(1), lorder(1), strip(1), tar(1), ar(3HEAD), a.out(4), attributes(5), environ(5), standards(5) If the same le is mentioned twice in an argument list, it may be put in the archive twice. By convention, archives are suffixed with the characters .a.

60

man pages section 1: User Commands Last Revised 15 Feb 2002

arch(1)NAME SYNOPSIS DESCRIPTION arch display the architecture of the current host arch [-k | archname] arch displays the application architecture of the current host system. Due to extensive historical use of this command without any options, all SunOS 5.x SPARC based systems will return "sun4" as their application architecture. Use of this command is discouraged; see NOTES section below. Systems can be broadly classied by their architectures, which dene what executables will run on which machines. A distinction can be made between kernel architecture and application architecture (or, commonly, just architecture). Machines that run different kernels due to underlying hardware differences may be able to run the same application programs. OPTIONS -k Display the kernel architecture, such as sun4m, sun4c, and so forth. This denes which specic SunOS kernel will run on the machine, and has implications only for programs that depend on the kernel explicitly (for example, ps(1)).

OPERANDS

The following operand is supported: archname Use archname to determine whether the application binaries for this application architecture can run on the current host system. The archname must be a valid application architecture, such as sun4, i86pc, and so forth. If application binaries for archname can run on the current host system, TRUE (0) is returned; otherwise, FALSE (1) is returned.

EXIT STATUS

The following exit values are returned: 0 >0 Successful completion. An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability

SUNWcsu

SEE ALSO NOTES

mach(1), ps(1), uname(1), attributes(5) This command is provided for compatibility with previous releases and its use is discouraged. Instead, the uname command is recommended. See uname(1) for usage information.

User Commands

61

as(1)NAME SYNOPSIS Sparc as assembler

as [-b] [-K PIC] [-L] [-m] [-n] [-o outle] [-P] [-Dname] [-Dname=def] [-Ipath] [-Uname] [-q] [-Qy | n] [-s] [-S [a | b | c | l | A | B | C | L]] [-T] [-V] [-xarch=v7 | -xarch=v8 | -xarch=v8a | -xarch=v8plus | -xarch=v8plusa | -xarc [-xF] lename as [-b] [-K PIC] [-L] [-m] [-n] [-o outle] [-P] [-Dname] [-Dname=def] [-Ipath] [-Uname] [-Qy | n] [-s] [-S [a | b | c | l | A | B | C | L]] [-T] [-V] lename The as command creates object les from assembly language source les.

x86

DESCRIPTION OPTIONS Common Options

The following ags are common to both SPARC and x86. They may be specied in any order: -b -K PIC -L Generates extra symbol table information for the Sun SourceBrowser. Generates position-independent code. Saves all symbols, including temporary labels that are normally discarded to save space, in the ELF symbol table. Runs the m4(1) macro processor on the input to the assembler. Suppresses all the warnings while assembling. Puts the output of the assembly in outle. By default, the output le name is formed by removing the .s suffix, if there is one, from the input le name and appending a .o suffix. Runs cpp(1), the C preprocessor, on the les being assembled. The preprocessor is run separately on each input le, not on their concatenation. The preprocessor output is passed to the assembler. When the -P option is in effect, these options are passed to the cpp(1) preprocessor without interpretation by the as command; otherwise, they are ignored.

-m -n -o outle

-P

-Dname -Dname=def

62

man pages section 1: User Commands Last Revised 15 Apr 2002

as(1)-Ipath When the -P option is in effect, this option is passed to the cpp(1) preprocessor without interpretation by the as command; otherwise, it is ignored. When the -P option is in effect, this option is passed to the cpp(1) preprocessor without interpretation by the as command; otherwise, it is ignored. If y is specied, this option produces the "assembler version" information in the comment section of the output object le. If n is specied, the information is suppressed. Places all stabs in the .stabs section. By default, stabs are placed in stabs.excl sections, which are stripped out by the static linker, ld(1), during nal execution. When the -s option is used, stabs remain in the nal executable because .stab sections are not stripped by the static linker. Produces a disassembly of the emitted code to the standard output. Adding each of the following characters to the -S option produces: a b c l disassembling with address disassembling with .bof disassembling with comments disassembling with line numbers

-Uname

-Qy | n

-s

-S[a|b|c|l|A|B|C|L]

Capital letters turn the switch off for the corresponding option. -T This is a migration option for 4.x assembly les to be assembled on 5.x systems. With this option, the symbol names in 4.x assembly les will be interpreted as 5.x symbol names. Writes the version number of the assembler being run on the standard error output. Allows function reordering by the Performance Analyzer. If you compile with the -xF option, and then run the Performance Analyzer, you can generate a map le that shows an optimized order for the functions. The subsequent link to build the executable le can be directed to use that map le by using the linker -M maple option. It places each function from the executable le into a separate section.

-V -xF

User Commands

63

as(1)Options for SPARC only -q Performs a quick assembly. When the -q option is used, many error checks are not performed. Note: This option disables many error checks. Use of this option to assemble handwritten assembly language is not recommended. This option instructs the assembler to accept instructions dened in the SPARC version 7 (V7) architecture. The resulting object code is in ELF format. This option instructs the assembler to accept instructions dened in the SPARC-V8 architecture, less the quad-precision oating-point instructions. The resulting object code is in ELF format. This option instructs the assembler to accept instructions dened in the SPARC-V8 architecture, less the quad-precision oating-point instructions and less the fsmuld instruction. The resulting object code is in ELF format. This is the default choice of the -xarch=options. This option instructs the assembler to accept instructions dened in the SPARC-V9 architecture, less the quad-precision oating-point instructions. The resulting object code is in ELF format. It will not execute on a Solaris V8 system (a machine with a V8 processor). It will execute on a Solaris V8+ system. This combination is a SPARC 64bit processor and a 32bit OS. This option instructs the assembler to accept instructions dened in the SPARC-V9 architecture, less the quad-precision oating-point instructions, plus the instructions in the Visual Instruction Set (VIS). The resulting object code is in V8+ ELF format. It will not execute on a Solaris V8 system (a machine with a V8 processor). It will execute on a Solaris V8+ system This option limits the instruction set to the SPARC-V9 architecture. The resulting .o object les are in 64-bit ELF format and can only be linked with other object les in the same format. The resulting executable can only be run on a 64-bit SPARC processor running 64-bit Solaris with the 64bit kernel. This option limits the instruction set to the SPARC-V9 architecture, adding the Visual Instruction Set (VIS) and extensions specic to UltraSPARC processors. The resulting .o object les are in 64-bit ELF format and can

-xarch=v7

-xarch=v8

-xarch=v8a

-xarch=v8plus

-xarch=v8plusa

-xarch=v9

-xarch=v9a

64

man pages section 1: User Commands Last Revised 15 Apr 2002

as(1)only be linked with other object les in the same format. The resulting executable can only be run on a 64-bit SPARC processor running 64-bit Solaris with the 64bit kernel. OPERANDS The following operand is supported: lename ENVIRONMENT VARIABLES TMPDIR Assembly language source le The as command normally creates temporary les in the directory /tmp. Another directory may be specied by setting the environment variable TMPDIR to the chosen directory. (If TMPDIR is not a valid directory, then as will use /tmp).

FILES ATTRIBUTES

By default, as creates its temporary les in /tmp. See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability

SUNWsprot

SEE ALSO

cc(1B), cpp(1),ld(1), m4(1), nm(1), strip(1), tmpnam(3C), a.out(4), attributes(5) dbx and analyzer manual pages available with Forte Developer

NOTES

If the -m option, which invokes the m4(1) macro processor, is used, keywords for m4 cannot be used as symbols (variables, functions, labels) in the input le, since m4 cannot determine which keywords are assembler symbols and which keywords are real m4 macros. Whenever possible, access the assembler through a compilation system interface program such as cc(1B). All undened symbols are treated as global.

User Commands

65

asa(1)NAME SYNOPSIS DESCRIPTION asa convert FORTRAN carriage-control output to printable form asa [-f] [le] The asa utility will write its input les to standard output, mapping carriage-control characters from the text les to line-printer control sequences. The rst character of every line will be removed from the input, and the following actions will be performed. If the character removed is: SPACE 0 1 + The rest of the line will be output without change. It is replaced by a newline control sequence followed by the rest of the input line. It is replaced by a newpage control sequence followed by the rest of the input line. It is replaced by a control sequence that causes printing to return to the rst column of the previous line, where the rest of the input line is printed.

For any other character in the rst column of an input line, asa skips the character and prints the rest of the line unchanged. If asa is called without providing a lename, the standard input is used. OPTIONS The following option is supported: -f OPERANDS Start each le on a new page.

The following operand is supported: file A pathname of a text le used for input. If no file operands are specied, or is specied, then the standard input will be used.

EXAMPLES

The commanda.out | asa | lp

converts output from a.out to conform with conventional printers and directs it through a pipe to the printer. The commandasa output

shows the contents of le output on a terminal as it would appear on a printer. The following program is used in the next two examples:write(*,(" Blank")) write(*,("0Zero ")) write(*,("+ Plus "))

66

man pages section 1: User Commands Last Revised 18 Apr 1995

asa(1)write(*,("1One end "))

Both of the following examples produce two pages of output: Page 1:Blank ZeroPlus

Page 2:OneEXAMPLE 1

Using actual les

a.out > MyOutputFile asa < MyOutputFile | lp

EXAMPLE 2

Using only pipesasa | lp

a.out |

ENVIRONMENT VARIABLES EXIT STATUS

See environ(5) for descriptions of the following environment variables that affect the execution of asa: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH. The following exit values are returned: 0 >0 All input les were output successfully. An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability Interface Stability

SUNWcsu Standard

SEE ALSO

lp(1), attributes(5), environ(5), standards(5)

User Commands

67

at(1)NAME SYNOPSIS at, batch execute commands at a later time at [-c | -k | -s] [-m] [-f le] [-p project] [-q queuename] -t time at [-c | -k | -s] [-m] [-f le] [-p project] [-q queuename] timespec at -l [-p project] [-q queuename] [at_job_id. ..] at -r at_job_id. .. batch [-p project] DESCRIPTION at The at utility reads commands from standard input and groups them together as an at-job, to be executed at a later time. The at-job will be executed in a separate invocation of the shell, running in a separate process group with no controlling terminal, except that the environment variables, current working directory, le creation mask (see umask(1)), and system resource limits (for sh and ksh only, see ulimit(1)) in effect when the at utility is executed will be retained and used when the at-job is executed. When the at-job is submitted, the at_job_id and scheduled time are written to standard error. The at_job_id is an identier that will be a string consisting solely of alphanumeric characters and the period character. The at_job_id is assigned by the system when the job is scheduled such that it uniquely identies a particular job. User notication and the processing of the jobs standard output and standard error are described under the -m option. Users are permitted to use at and batch (see below) if their name appears in the le /usr/lib/cron/at.allow. If that le does not exist, the le /usr/lib/cron/at.deny is checked to determine if the user should be denied access to at. If neither le exists, only a user with the solaris.jobs.user authorization is allowed to submit a job. If only at.deny exists and is empty, global usage is permitted. The at.allow and at.deny les consist of one user name per line. cron and at jobs will be not be executed if the users account is locked. Only accounts which are not locked as dened in shadow(4) will have their job or process executed. batch The batch utility reads commands to be executed at a later time. It is the equivalent of the command:at q b m now

where queue b is a special at queue, specically for batch jobs. Batch jobs will be submitted to the batch queue for immediate execution. OPTIONS The following options are supported. If the -c, -k, or -s options are not specied, the SHELL environment variable by default determines which shell to use. -c68

C shell. csh(1) is used to execute the at-job.

man pages section 1: User Commands Last Revised 11 Jan 2002

at(1)-k -s -f le -l Korn shell. ksh(1) is used to execute the at-job. Bourne shell. sh(1) is used to execute the at-job. Species the path of a le to be used as the source of the at-job, instead of standard input. (The letter ell.) Reports all jobs scheduled for the invoking user if no at_job_id operands are specied. If at_job_ids are specied, reports only information for these jobs. Sends mail to the invoking user after the at-job has run, announcing its completion. Standard output and standard error produced by the at-job will be mailed to the user as well, unless redirected elsewhere. Mail will be sent even if the job produces no output. If -m is not used, the jobs standard output and standard error will be provided to the user by means of mail, unless they are redirected elsewhere; if there is no such output to provide, the user is not notied of the jobs completion. -p project Species under which project the at or batch job will be run. When used with the -l option, limits the search to that particular project. Values for project will be interpreted rst as a project name, and then as a possible project ID, if entirely numeric. By default, the users current project is used. Species in which queue to schedule a job for submission. When used with the -l option, limits the search to that particular queue. Values for queuename are limited to the lower case letters a through z. By default, at-jobs will be scheduled in queue a. In contrast, queue b is reserved for batch jobs. Since queue c is reserved for cron jobs, it can not be used with the -q option. Removes the jobs with the specied at_job_id operands that were previously scheduled by the at utility. Submits the job to be run at the time specied by the time option-argument, which must have the format as specied by the touch(1) utility.

-m

-q queuename

-r at_job_id -t time

OPERANDS

The following operands are supported: at_job_id timespec The name reported by a previous invocation of the at utility at the time the job was scheduled. Submit the job to be run at the date and time specied. All of the timespec operands are interpreted as if they were separated by space characters and concatenated. The date and time are

User Commands

69

at(1)interpreted as being in the timezone of the user (as determined by the TZ variable), unless a timezone name appears as part of time below. In the "C" locale, the following describes the three parts of the time specication string. All of the values from the LC_TIME categories in the "C" locale are recognized in a case-insensitive manner. time The time can be specied as one, two or four digits. One- and two-digit numbers are taken to be hours, four-digit numbers to be hours and minutes. The time can alternatively be specied as two numbers separated by a colon, meaning hour:minute. An AM/PM indication (one of the values from the am_pm keywords in the LC_TIME locale category) can follow the time; otherwise, a 24-hour clock time is understood. A timezone name of GMT, UCT, or ZULU (case insensitive) can follow to specify that the time is in Coordinated Universal Time. Other timezones can be specied using the TZ environment variable. The time eld can also be one of the following tokens in the "C" locale: midnight Indicates the time 12:00 am (00:00). noon now Indicates the time 12:00 pm. Indicate the current day and time. Invoking at now will submit an at-job for potentially immediate execution (that is, subject only to unspecied scheduling delays).

date

An optional date can be specied as either a month name (one of the values from the mon or abmon keywords in the LC_TIME locale category) followed by a day number (and possibly year number preceded by a comma) or a day of the week (one of the values from the day or abday keywords in the LC_TIME locale category). Two special days are recognized in the "C" locale: today Indicates the current day.

tomorrow Indicates the day following the current day.

70

man pages section 1: User Commands Last Revised 11 Jan 2002

at(1)If no date is given, today is assumed if the given time is greater than the current time, and tomorrow is assumed if it is less. If the given month is less than the current month (and no year is given), next year is assumed. increment The optional increment is a number preceded by a plus sign (+) and suffixed by one of the following: minutes, hours, days, weeks, months, or years. (The singular forms will be also accepted.) The keyword next is equivalent to an increment number of + 1. For example, the following are equivalent commands:at 2pm + 1 week at 2pm next week

USAGE

The format of the at command line shown here is guaranteed only for the "C" locale. Other locales are not supported for midnight, noon, now, mon, abmon, day, abday, today, tomorrow, minutes, hours, days, weeks, months, years, and next. Since the commands run in a separate shell invocation, running in a separate process group with no controlling terminal, open le descriptors, traps and priority inherited from the invoking environment are lost.

EXAMPLES atEXAMPLE 1

Typical sequence at a terminal

This sequence can be used at a terminal:$ at m 0730 tomorrow sort < file >outfile

EXAMPLE 2 Redirecting output

This sequence, which demonstrates redirecting standard error to a pipe, is useful in a command procedure (the sequence of output redirection specications is signicant):$ at now + 1 hour outfile | mailx mygroup

EXAMPLE 3

Self-rescheduling a job

To have a job reschedule itself, at can be invoked from within the at-job. For example, this "daily-processing" script named my.daily will run every day (although crontab is a more appropriate vehicle for such work):

User Commands

71

at(1)EXAMPLE 3

Self-rescheduling a job

(Continued)

# my.daily runs every day at now tomorrow < my.daily daily-processing

EXAMPLE 4

Various time and operand presentations

The spacing of the three portions of the "C" locale timespec is quite exible as long as there are no ambiguities. Examples of various times and operand presentations include:at at at at at 0815am Jan 24 8 :15amjan24 now "+ 1day" 5 pm FRIday 17 utc+ 30minutes

batch

EXAMPLE 5

Typical sequence at a terminal

This sequence can be used at a terminal:$ batch sort outfile

EXAMPLE 6 Redirecting output

This sequence, which demonstrates redirecting standard error to a pipe, is useful in a command procedure (the sequence of output redirection specications is signicant):$ batch outfile | mailx mygroup !

ENVIRONMENT VARIABLES

See environ(5) for descriptions of the following environment variables that affect the execution of at and batch: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, NLSPATH, and LC_TIME. DATEMSK If the environment variable DATEMSK is set, at will use its value as the full path name of a template le containing format strings. The strings consist of format speciers and text characters that are used to provide a richer set of allowable date formats in different languages by appropriate settings of the environment variable LANG or LC_TIME. The list of allowable format speciers is located in the getdate(3C) manual page. The formats described in the OPERANDS section for the time and date arguments, the special names noon, midnight, now, next, today, tomorrow, and the increment argument are not recognized when DATEMSK is set.

72

man pages section 1: User Commands Last Revised 11 Jan 2002

at(1)SHELL Determine a name of a command interpreter to be used to invoke the at-job. If the variable is unset or NULL, sh will be used. If it is set to a value other than sh, the implementation will use that shell; a warning diagnostic will be printed telling which shell will be used. Determine the timezone. The job will be submitted for execution at the time specied by timespec or -t time relative to the timezone specied by the TZ variable. If timespec species a timezone, it will override TZ. If timespec does not specify a timezone and TZ is unset or NULL, an unspecied default timezone will be used.

TZ

EXIT STATUS

The following exit values are returned: 0 >0 The at utility successfully submitted, removed or listed a job or jobs. An error occurred, and the job will not be scheduled. names of users, one per line, who are authorized access to the at and batch utilities names of users, one per line, who are denied access to the at and batch utilities

FILES

/usr/lib/cron/at.allow

/usr/lib/cron/at.deny ATTRIBUTES atAvailability CSI Interface Stability

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

SUNWcsu Not enabled Standard

batchAvailability CSI

ATTRIBUTE TYPE

ATTRIBUTE VALUE

SUNWesu Enabled Standard

Interface Stability

SEE ALSO

auths(1), crontab(1), csh(1), date(1), ksh(1), sh(1), touch(1), ulimit(1), umask(1), cron(1M), getdate(3C), auth_attr(4), shadow(4), attributes(5), environ(5), standards(5) Regardless of queue used, cron(1M) has a limit of 100 jobs in execution at any time.

NOTES

User Commands

73

at(1)There can be delays in cron at job execution. In some cases, these delays can compound to the point that cron job processing appears to be hung. All jobs will be executed eventually. When the delays are excessive, the only workaround is to kill and restart cron.

74

man pages section 1: User Commands Last Revised 11 Jan 2002

atq(1)NAME SYNOPSIS DESCRIPTION atq display the jobs queued to run at specied times atq [-c] [-n] [username] The atq utility displays the at jobs queued up for the current user. at(1) is a utility that allows users to execute commands at a later date. If invoked by a user with the solaris.jobs.admin authorization, atq will display all jobs in the queue. If no options are given, the jobs are displayed in chronological order of execution. When an authorized user invokes atq without specifying username, the entire queue is displayed; when a username is specied, only those jobs belonging to the named user are displayed. OPTIONS The following options are supported: -c -n FILES ATTRIBUTES Displays the queued jobs in the order they were created (that is, the time that the at command was given). Displays only the total number of jobs currently in the queue. spool area for at jobs.

/var/spool/cron/atjobs

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability

SUNWcsu

SEE ALSO

at(1), atrm(1), auths(1), cron(1M), auth_attr(4), attributes(5)

User Commands

75

atrm(1)NAME SYNOPSIS DESCRIPTION atrm remove jobs spooled by at or batch atrm [-afi] [ [job #] [user]] The atrm utility removes delayed-execution jobs that were created with the at(1) command, but have not yet executed. The list of these jobs and associated job numbers can be displayed by using atq(1). atrm removes each job-number you specify, and/or all jobs belonging to the user you specify, provided that you own the indicated jobs. You can only remove jobs belonging to other users if you have solaris.jobs.admin privileges. OPTIONS The following options are supported: -a -f -i FILES ATTRIBUTES All. Removes all unexecuted jobs that were created by the current user. If invoked by the privileged user, the entire queue will be ushed. Force. All information regarding the removal of the specied jobs is suppressed. Interactive. atrm asks if a job should be removed. If you respond with a y, the job will be removed. spool area for at jobs

/var/spool/cron/atjobs

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Availability

SUNWcsu

SEE ALSO

at(1), atq(1), auths(1), cron(1M), auth_attr(4), attributes(5)

76

man pages section 1: User Commands Last Revised 13 Aug 1999

audioconvert(1)NAME SYNOPSIS DESCRIPTION audioconvert convert audio le formats audioconvert [-pF] [-f outfmt] [-o outle] [ [-i infmt] [le]] audioconvert converts audio data between a set of supported audio encodings and le formats. It can be used to compress and decompress audio data, to add audio le headers to raw audio data les, and to convert between standard data encodings, such as -law and linear PCM. If no lenames are present, audioconvert reads the data from the standard input stream and writes an audio le to the standard output. Otherwise, input les are processed in order, concatenated, and written to the output le. Input les are expected to contain audio le headers that identify the audio data format. If the audio data does not contain a recognizable header, the format must be specied with the -i option, using the rate, encoding, and channels keywords to identify the input data format. The output le format is derived by updating the format of the rst input le with the format options in the -f specication. If -p is not specied, all subsequent input les are converted to this resulting format and concatenated together. The output le will contain an audio le header, unless format=raw is specied in the output format options. Input les may be converted in place by using the -p option. When -p is in effect, the format of each input le is modied according to the -f option to determine the output format. The existing les are then overwritten with the converted data. The file(1) command decodes and prints the audio data format of Sun audio les. OPTIONS The following options are supported: -p In Place: The input les are individually converted to the format specied by the -f option and rewritten. If a target le is a symbolic link, the underlying le will be rewritten. The -o option may not be specied with -p. Force: This option forces audioconvert to ignore any le header for input les whose format is specied by the -i option. If -F is not specied, audioconvert ignores the -i option for input les that contain valid audio le headers. Output Format: This option is used to specify the le format and data encoding of the output le. Defaults for unspecied elds are derived from the input le format. Valid keywords and values are listed in the next section. Output File: All input les are concatenated, converted to the output format, and written to the named output le. If -o and -p are not specied, the concatenated output is written to the standard output. The -p option may not be specied with -o.User Commands 77

-F

-f outfmt

-o outle

audioconvert(1)-i infmt Input Format: This option is used to specify the data encoding of raw input les. Ordinarily, the input data format is derived from the audio le header. This option is required when converting audio data that is not preceded by a valid audio le header. If -i is specied for an input le that contains an audio le header, the input format string will be ignored, unless -F is present. The format specication syntax is the same as the -f output le format. Multiple input formats may be specied. An input format describes all input les following that specication, until a new input format is specied. le File Specication: The named audio les are concatenated, converted to the output format, and written out. If no le name is present, or if the special le name is specied, audio data is read from the standard input. Help: Prints a command line usage message.

-? Format Specication

The syntax for the input and output format specication is: keyword=value[,keyword=value . . . ] with no intervening whitespace. Unambiguous values may be used without the preceding keyword=. rate The audio sampling rate is specied in samples per second. If a number is followed by the letter k, it is multiplied by 1000 (for example, 44.1k = 44100). Standard of the commonly used sample rates are: 8k, 16k, 32k, 44.1k, and 48k. The number of interleaved channels is specied as an integer. The words mono and stereo may also be used to specify one and two channel data, respectively. This option species the digital audio data representation. Encodings determine precision implicitly (ulaw implies 8-bit precision) or explicitly as part of the name (for example, linear16). Valid encoding values are: ulaw CCITT G.711 -law encoding. This is an 8-bit format primarily used for telephone quality speech. CCITT G.711 A-law encoding. This is an 8-bit format primarily used for telephone quality speech in Europe.

channels

encoding

alaw

linear8, linear16,78 man pages section 1: User Commands Last Revised 16 Feb 2001

audioconvert(1)linear32 Linear Pulse Code Modulation (PCM) encoding. The name identies the number of bits of precision. linear16 is typically used for high quality audio data. Same as linear16. CCITT G.721 compression format. This encoding uses Adaptive Delta Pulse Code Modulation (ADPCM) with 4-bit precision. It is primarily used for compressing -law voice data (achieving a 2:1 compression ratio). CCITT G.723 compression format. This encoding uses Adaptive Delta Pulse Code Modulation (ADPCM) with 3-bit precision. It is primarily used for compressing -law voice data (achieving an 8:3 compression ratio). The audio quality is similar to G.721, but may result in lower quality when used for non-speech data.

pcm g721

g723

The following encoding values are also accepted as shorthand to set the sample rate, channels, and encoding: voice cd dat format Equivalent to encoding=ulaw,rate=8k,channels=mono. Equivalent to encoding=linear16,rate=44.1k,channels=stereo. Equivalent to encoding=linear16,rate=48k,channels=stereo.

This option species the audio le format. Valid formats are: sun raw Sun compatible le format (the default). Use this format when reading or writing raw audio data (with no audio header), or in conjunction with an offset to import a foreign audio le format.

offset

(-i only) Species a byte offset to locate the start of the audio data. This option may be used to import audio data that contains an unrecognized le header.

USAGE

See largefile(5) for the description of the behavior of audioconvert when encountering les greater than or equal to 2 Gbyte ( 231 bytes).EXAMPLE 1

EXAMPLES

Recording and compressing voice data before storing it

Record voice data and compress it before storing it to a le:example% audiorecord | audioconvert -f g721 > mydata.au

User Commands

79

audioconvert(1)EXAMPLE 2

Concatenating two audio les

Concatenate two Sun format audio les, regardless of their data format, and output an 8-bit ulaw, 16 kHz, mono le:example% audioconvert -f ulaw,rate=16k,mono -o outfile.au infile1 infile2

EXAMPLE 3

Converting a directory to Sun format

Convert a directory containing raw voice data les, in place, to Sun format (adds a le header to each le):example% audioconvert -p -i voice -f sun *.au

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Architecture Availability Interface Stability

SPARC, x86 SUNWauda Evolving

SEE ALSO NOTES

audioplay(1), audiorecord(1), file(1), attributes(5), largefile(5) The algorithm used for converting multi-channel data to mono is implemented by simply summing the channels together. If the input data is perfectly in phase (as would be the case if a mono le is converted to stereo and back to mono), the resulting data may contain some distortion.

80

man pages section 1: User Commands Last Revised 16 Feb 2001

audioplay(1)NAME SYNOPSIS DESCRIPTION audioplay play audio les audioplay [-iV] [-v vol] [-b bal] [-p speaker | headphone | line] [-d dev] [le] The audioplay utility copies the named audio les (or the standard input if no lenames are present) to the audio device. If no input le is specied and standard input is a tty, the port, volume, and balance settings specied on the command line will be applied and the program will exit. The input les must contain a valid audio le header. The encoding information in this header is matched against the capabilities of the audio device and, if the data formats are incompatible, an error message is printed and the le is skipped. Compressed ADPCM (G.721) monaural audio data is automatically uncompressed before playing. Minor deviations in sampling frequency (that is, less than 1%) are ordinarily ignored. This allows, for instance, data sampled at 8012 Hz to be played on an audio device that only supports 8000 Hz. If the -V option is present, such deviations are agged with warning messages. OPTIONS The following options are supported: -i Immediate: If the audio device is unavailable (that is, another process currently has write access), audioplay ordinarily waits until it can obtain access to the device. When the -i option is present, audioplay prints an error message and exits immediately if the device is busy. -V Verbose: Prints messages on the standard error when waiting for access to the audio device or when sample rate deviations are detected. -v vol Volume: The output volume is set to the specied value before playing begins, and is reset to its previous level when audioplay exits. The vol argument is an integer value between 0 and 100, inclusive. If this argument is not specied, the output volume remains at the level most recently set by any process. -b bal Balance: The output balance is set to the specied value before playing begins, and is reset to its previous level when audioplay exits. The bal argument is an integer value between -100 and 100, inclusive. A value of -100 indicates left balance, 0 middle, and 100 right. If this argument is not specied, the output balance remains at the level most recently set by any process. -p speaker | headphone | line Output Port: Selects the built-in speaker (the default), headphone jack, or line out as the destination of the audio output signal. If this argument is not specied, the output port will remain unchanged. Please note: Not all audio adapters support all of the output ports. If the named port does not exist, an appropriate substitute will be used.User Commands 81

audioplay(1)-d dev Device: The dev argument species an alternate audio device to which output should be directed. If the -d option is not specied, the AUDIODEV environment variable is consulted (see below). Otherwise, /dev/audio is used as the default audio device. \? Help: Prints a command line usage message. OPERANDS le File Specication: Audio les named on the command line are played sequentially. If no lenames are present, the standard input stream (if it is not a tty) is played (it, too, must contain an audio le header). The special lename may be used to read the standard input stream instead of a le. If a relative path name is supplied, the AUDIOPATH environment variable is consulted (see below).

USAGE ENVIRONMENT VARIABLES

See largefile(5) for the description of the behavior of audioplay when encountering les greater than or equal to 2 Gbyte ( 231 bytes). AUDIODEV The full path name of the audio device to write to, if no -d argument is supplied. If the AUDIODEV variable is not set, /dev/audio is used. A colon-separated list of directories in which to search for audio les whose names are given by relative pathnames. The current directory (".") may be specied explicitly in the search path. If the AUDIOPATH variable is not set, only the current directory will be searched.

AUDIOPATH

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Architecture Availability Interface Stability

SPARC, x86 SUNWauda Evolving

SEE ALSO BUGS

audioconvert(1), audiorecord(1), mixerctl(1), attributes(5), largefile(5), usb_ac(7D), audio(7I), mixer(7I) audioplay currently supports a limited set of audio format conversions. If the audio le is not in a format supported by the audio device, it must rst be converted. For example, to convert to voice format on the y, use the command:example% audioconvert -f voice myfile | audioplay

The format conversion will not always be able to keep up with the audio output. If this is the case, you should convert to a temporary le before playing the data.82 man pages section 1: User Commands Last Revised 16 Feb 2001

audiorecord(1)NAME SYNOPSIS audiorecord record an audio le audiorecord [-af] [-v vol] [-b bal] [-m monvol] [-p mic | line | internal-cd] [-c channels] [-s rate] [-e encoding] [-t time] [-i info] [-d dev] [le] The audiorecord utility copies audio data from the audio device to a named audio le (or the standard output if no lename is present). If no output le is specied and standard output is a tty, the volume, balance, monitor volume, port, and audio format settings specied on the command line will be applied and the program will exit. By default, monaural audio data is recorded at 8 kHz and encoded in -law format. If the audio device supports additional congurations, the -c, -s, and -e options may be used to specify the data format. The output le is prexed by an audio le header that identies the format of the data encoded in the le. Recording begins immediately and continues until a SIGINT signal (for example, Ctrl-C) is received. If the -t option is specied, audiorecord stops when the specied quantity of data has been recorded. If the audio device is unavailable (that is, another process currently has read access), audiorecord prints an error message and exits immediately. OPTIONS The following options are supported: -a Append: Appends the data on the end of the named audio le. The audio device must support the audio data format of the existing le. -f Force: When the -a ag is specied, the sample rate of the audio device must match the sample rate at which the original le was recorded. If the -f ag is also specied, sample rate differences are ignored, with a warning message printed on the standard error. -v vol Volume: The recording gain is set to the specied value before recording begins, and is reset to its previous level when audiorecord exits. The vol argument is an integer value between 0 and 100, inclusive. If this argument is not specied, the input volume will remain at the level most recently set by any process. -b bal Balance: The recording balance is set to the specied value before recording begins, and is reset to its previous level when audiorecord exits. The bal argument is an integer value between -100 and 100, inclusive. A value of -100 indicates left balance, 0 middle, and 100 right. If this argument is not specied, the input balance will remain at the level most recently set by any process. -m monvol Monitor Volume: The input monitor volume is set to the specied value before recording begins, and is reset to its previous level when audiorecord exits. The monval argument is an integer value between 0 and 100, inclusive. A non-zero valueUser Commands 83

DESCRIPTION

audiorecord(1)allows a directly connected input source to be heard on the output speaker while recording is in-progress. If this argument is not specied, the monitor volume will remain at the level most recently set by any process. -p mic | line | internal-cd Input Port: Selects the mic, line, or internal-cd input as the source of the audio output signal. If this argument is not specied, the input port will remain unchanged. Please note: Some systems will not support all possible input ports. If the named port does not exist, this option is ignored. -c channels Channels: Species the number of audio channels (1 or 2). The value may be specied as an integer or as the string mono or stereo. The default value is mono. -s rate Sample Rate: Species the sample rate, in samples per second. If a number is followed by the letter k, it is multiplied by 1000 (for example, 44.1k = 44100). The default sample rate is 8 kHz. -e encoding Encoding: Species the audio data encoding. This value may be one of ulaw, alaw, or linear. The default encoding is ulaw. -t time Time: The time argument species the maximum length of time to record. Time can be specied as a oating-point value, indicating the number of seconds, or in the form: hh:mm:ss.dd, where the hour and minute specications are optional. -i info Information: The information eld of the output le header is set to the string specied by the info argument. This option cannot be specied in conjunction with the -a argument. -d dev Device: The dev argument species an alternate audio device from which input should be taken. If the -d option is not specied, the AUDIODEV environment variable is consulted (see below). Otherwise, /dev/audio is used as the default audio device. -\? Help: Prints a command line usage message. OPERANDS le File Specication: The named audio le is rewritten (or appended). If no lename is present (and standard output is not a tty), or if the special lename is specied, output is directed to the the standard output.

USAGE ENVIRONMENT VARIABLES

See largefile(5) for the description of the behavior of audiorecord when encountering les greater than or equal to 2 Gbyte ( 231 bytes). AUDIODEV The full path name of the audio device to record from, if no -d argument is supplied. If the AUDIODEV variable is not set, /dev/audio is used.

84

man pages section 1: User Commands Last Revised 16 Feb 2001

audiorecord(1)ATTRIBUTES See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE

ATTRIBUTE VALUE

Architecture Availability Interface Stability

SPARC, x86 SUNWauda Evolving

SEE ALSO

audioconvert(1), audioplay(1), mixerctl(1), attributes(5), largefile(5), usb_ac(7D), audio(7I), mixer(7I)

User Commands

85

auths(1)NAME SYNOPSIS DESCRIPTION auths print authorizations granted to a user auths [ user ] The auths command prints on standard output the authorizations that you or the optionally-specied user or role have been granted. Authorizations are rights that are checked by certain privileged programs to determine whether a user may execute restricted functionality. Each user may have zero or more authorizations. Authorizations are represented by fully-qualied names, which identify the organization that created the authorization and the functionality that it controls. Following the Java convention, the hierarchical components of an authorization are separated by dots (.), starting with the reverse order Internet domain name of the creating organization, and ending with the specic function within a class of authorizations. An asterisk (*) indicates all authorizations in a class. A users authorizations are looked up in user_attr(4) and in the /etc/security/policy.conf le (see policy.conf(4)). Authorizations may be specied directly in user_attr(4) or indirectly through prof_attr(4). Authorizations may also be assigned to every user in the system directly as default authorizations or indirectly as default proles in the /etc/security/policy.conf le. EXAMPLESEXAMPLE 1 Sample output

The auths output has the following form:example% auths tester01 tester02 tester01 : com.sun.system.date,com.sun.job