coreutils.xml 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  4. <!ENTITY % general-entities SYSTEM "../general.ent">
  5. %general-entities;
  6. ]>
  7. <sect1 id="ch-system-coreutils" role="wrap">
  8. <?dbhtml filename="coreutils.html"?>
  9. <sect1info condition="script">
  10. <productname>coreutils</productname>
  11. <productnumber>&coreutils-version;</productnumber>
  12. <address>&coreutils-url;</address>
  13. </sect1info>
  14. <title>Coreutils-&coreutils-version;</title>
  15. <indexterm zone="ch-system-coreutils">
  16. <primary sortas="a-Coreutils">Coreutils</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Coreutils package contains utilities for showing and setting the
  21. basic system characteristics.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&coreutils-ch6-sbu;</seg>
  27. <seg>&coreutils-ch6-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of Coreutils</title>
  33. <para>POSIX requires that programs from Coreutils recognize character
  34. boundaries correctly even in multibyte locales. The following patch fixes
  35. this non-compliance and other internationalization-related bugs.</para>
  36. <screen><userinput remap="pre">patch -Np1 -i ../&coreutils-i18n-patch;</userinput></screen>
  37. <note>
  38. <para>In the past, many bugs were found in this patch. When reporting new
  39. bugs to Coreutils maintainers, please check first if they are reproducible
  40. without this patch.</para>
  41. </note>
  42. <!-- this has been fixed in upstream gnulib, when a new version of
  43. coreutils is released, please check #4055 to see if the change has been
  44. picked up in this package -->
  45. <para>Suppress a test which on some machines can loop forever:</para>
  46. <screen><userinput remap="pre">sed -i '/test.lock/s/^/#/' gnulib-tests/gnulib.mk</userinput></screen>
  47. <para>Now prepare Coreutils for compilation:</para>
  48. <screen><userinput remap="configure">autoreconf -fiv
  49. FORCE_UNSAFE_CONFIGURE=1 ./configure \
  50. --prefix=/usr \
  51. --enable-no-install-program=kill,uptime</userinput></screen>
  52. <variablelist>
  53. <title>The meaning of the configure options:</title>
  54. <varlistentry>
  55. <term><command>autoreconf</command></term>
  56. <listitem>
  57. <para>This command updates generated configuration files
  58. consistent with the latest version of automake.
  59. </para>
  60. </listitem>
  61. </varlistentry>
  62. <varlistentry>
  63. <term><envar>FORCE_UNSAFE_CONFIGURE=1</envar></term>
  64. <listitem>
  65. <para>This environment variable allows the package to be
  66. built as the root user.
  67. </para>
  68. </listitem>
  69. </varlistentry>
  70. <varlistentry>
  71. <term><parameter>--enable-no-install-program=kill,uptime</parameter></term>
  72. <listitem>
  73. <para>The purpose of this switch is to prevent Coreutils from
  74. installing binaries that will be installed by other packages later.
  75. </para>
  76. </listitem>
  77. </varlistentry>
  78. </variablelist>
  79. <para>Compile the package:</para>
  80. <screen><userinput remap="make">make</userinput></screen>
  81. <para>Skip down to <quote>Install the
  82. package</quote> if not running the test suite.</para>
  83. <para>Now the test suite is ready to be run. First, run the tests that are
  84. meant to be run as user <systemitem class="username">root</systemitem>:</para>
  85. <screen><userinput remap="test">make NON_ROOT_USERNAME=tester check-root</userinput></screen>
  86. <para>We're going to run the remainder of the tests as the
  87. <systemitem class="username">tester</systemitem> user. Certain tests,
  88. however, require that the user be a member of more than one group. So that
  89. these tests are not skipped we'll add a temporary group and make the
  90. user <systemitem class="username">tester</systemitem> a part of it:</para>
  91. <screen><userinput remap="test">echo "dummy:x:102:tester" &gt;&gt; /etc/group</userinput></screen>
  92. <para>Fix some of the permissions so that the non-root user can compile and
  93. run the tests:</para>
  94. <screen><userinput remap="test">chown -Rv tester . </userinput></screen>
  95. <para>Now run the tests:</para>
  96. <screen><userinput remap="test">su tester -c "PATH=$PATH make RUN_EXPENSIVE_TESTS=yes check"</userinput></screen>
  97. <!--
  98. <para>The test program test-getlogin is known to fail in a
  99. partially built system environment like the chroot environment here, but
  100. passes if run at the end of this chapter. The test program tty.sh is
  101. also known to fail.</para>
  102. -->
  103. <para>Remove the temporary group:</para>
  104. <screen><userinput remap="test">sed -i '/dummy/d' /etc/group</userinput></screen>
  105. <para>Install the package:</para>
  106. <screen><userinput remap="install">make install</userinput></screen>
  107. <para>Move programs to the locations specified by the FHS:</para>
  108. <screen><userinput remap="install">mv -v /usr/bin/{cat,chgrp,chmod,chown,cp,date,dd,df,echo} /bin
  109. mv -v /usr/bin/{false,ln,ls,mkdir,mknod,mv,pwd,rm} /bin
  110. mv -v /usr/bin/{rmdir,stty,sync,true,uname} /bin
  111. mv -v /usr/bin/chroot /usr/sbin
  112. mv -v /usr/share/man/man1/chroot.1 /usr/share/man/man8/chroot.8
  113. sed -i s/\"1\"/\"8\"/1 /usr/share/man/man8/chroot.8</userinput></screen>
  114. <para revision="sysv">Some of the scripts in the LFS-Bootscripts package
  115. depend on <command>head</command>, <command>nice</command>,
  116. <command>sleep</command>, and <command>touch</command>. As <filename
  117. class="directory">/usr</filename> may not be available during the early and
  118. late stages of booting, those binaries need to be on the root partition to
  119. maintain FHS compliance:</para>
  120. <screen><userinput remap="install">mv -v /usr/bin/{head,nice,sleep,touch} /bin</userinput></screen>
  121. </sect2>
  122. <sect2 id="contents-coreutils" role="content">
  123. <title>Contents of Coreutils</title>
  124. <segmentedlist>
  125. <segtitle>Installed programs</segtitle>
  126. <segtitle>Installed library</segtitle>
  127. <segtitle>Installed directory</segtitle>
  128. <seglistitem>
  129. <seg>[, b2sum, base32, base64, basename, basenc, cat, chcon, chgrp, chmod, chown,
  130. chroot, cksum, comm, cp, csplit, cut, date, dd, df, dir, dircolors,
  131. dirname, du, echo, env, expand, expr, factor, false, fmt, fold, groups,
  132. head, hostid, id, install, join, link, ln, logname, ls, md5sum, mkdir,
  133. mkfifo, mknod, mktemp, mv, nice, nl, nohup, nproc, numfmt, od, paste,
  134. pathchk, pinky, pr, printenv, printf, ptx, pwd, readlink, realpath, rm,
  135. rmdir, runcon, seq, sha1sum, sha224sum, sha256sum, sha384sum,
  136. sha512sum, shred, shuf, sleep, sort, split, stat, stdbuf, stty, sum,
  137. sync, tac, tail, tee, test, timeout, touch, tr, true, truncate, tsort,
  138. tty, uname, unexpand, uniq, unlink, users, vdir, wc, who, whoami, and
  139. yes</seg>
  140. <seg>libstdbuf.so (in /usr/libexec/coreutils)</seg>
  141. <seg>/usr/libexec/coreutils</seg>
  142. </seglistitem>
  143. </segmentedlist>
  144. <variablelist>
  145. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  146. <?dbfo list-presentation="list"?>
  147. <?dbhtml list-presentation="table"?>
  148. <varlistentry id="base32">
  149. <term><command>base32</command></term>
  150. <listitem>
  151. <para>Encodes and decodes data according to the base32 specification
  152. (RFC 4648)</para>
  153. <indexterm zone="ch-system-coreutils base64">
  154. <primary sortas="b-base64">base64</primary>
  155. </indexterm>
  156. </listitem>
  157. </varlistentry>
  158. <varlistentry id="base64">
  159. <term><command>base64</command></term>
  160. <listitem>
  161. <para>Encodes and decodes data according to the base64 specification
  162. (RFC 4648)</para>
  163. <indexterm zone="ch-system-coreutils base64">
  164. <primary sortas="b-base64">base64</primary>
  165. </indexterm>
  166. </listitem>
  167. </varlistentry>
  168. <varlistentry id="b2sum">
  169. <term><command>b2sum</command></term>
  170. <listitem>
  171. <para>Prints or checks BLAKE2 (512-bit) checksums</para>
  172. <indexterm zone="ch-system-coreutils b2sum">
  173. <primary sortas="b-b2sum">b2sum</primary>
  174. </indexterm>
  175. </listitem>
  176. </varlistentry>
  177. <varlistentry id="basename">
  178. <term><command>basename</command></term>
  179. <listitem>
  180. <para>Strips any path and a given suffix from a file name</para>
  181. <indexterm zone="ch-system-coreutils basename">
  182. <primary sortas="b-basename">basename</primary>
  183. </indexterm>
  184. </listitem>
  185. </varlistentry>
  186. <varlistentry id="basenc">
  187. <term><command>basenc</command></term>
  188. <listitem>
  189. <para>Encodes or decodes data using various algorithms</para>
  190. <indexterm zone="ch-system-coreutils basenc">
  191. <primary sortas="b-basenc">basenc</primary>
  192. </indexterm>
  193. </listitem>
  194. </varlistentry>
  195. <varlistentry id="cat">
  196. <term><command>cat</command></term>
  197. <listitem>
  198. <para>Concatenates files to standard output</para>
  199. <indexterm zone="ch-system-coreutils cat">
  200. <primary sortas="b-cat">cat</primary>
  201. </indexterm>
  202. </listitem>
  203. </varlistentry>
  204. <varlistentry id="chcon">
  205. <term><command>chcon</command></term>
  206. <listitem>
  207. <para>Changes security context for files and directories</para>
  208. <indexterm zone="ch-system-coreutils chcon">
  209. <primary sortas="b-chcon">chcon</primary>
  210. </indexterm>
  211. </listitem>
  212. </varlistentry>
  213. <varlistentry id="chgrp">
  214. <term><command>chgrp</command></term>
  215. <listitem>
  216. <para>Changes the group ownership of files and directories</para>
  217. <indexterm zone="ch-system-coreutils chgrp">
  218. <primary sortas="b-chgrp">chgrp</primary>
  219. </indexterm>
  220. </listitem>
  221. </varlistentry>
  222. <varlistentry id="chmod">
  223. <term><command>chmod</command></term>
  224. <listitem>
  225. <para>Changes the permissions of each file to the given mode; the mode
  226. can be either a symbolic representation of the changes to make or an
  227. octal number representing the new permissions</para>
  228. <indexterm zone="ch-system-coreutils chmod">
  229. <primary sortas="b-chmod">chmod</primary>
  230. </indexterm>
  231. </listitem>
  232. </varlistentry>
  233. <varlistentry id="chown">
  234. <term><command>chown</command></term>
  235. <listitem>
  236. <para>Changes the user and/or group ownership of files and
  237. directories</para>
  238. <indexterm zone="ch-system-coreutils chown">
  239. <primary sortas="b-chown">chown</primary>
  240. </indexterm>
  241. </listitem>
  242. </varlistentry>
  243. <varlistentry id="chroot">
  244. <term><command>chroot</command></term>
  245. <listitem>
  246. <para>Runs a command with the specified directory as the
  247. <filename class="directory">/</filename> directory</para>
  248. <indexterm zone="ch-system-coreutils chroot">
  249. <primary sortas="b-chroot">chroot</primary>
  250. </indexterm>
  251. </listitem>
  252. </varlistentry>
  253. <varlistentry id="cksum">
  254. <term><command>cksum</command></term>
  255. <listitem>
  256. <para>Prints the Cyclic Redundancy Check (CRC) checksum and the byte
  257. counts of each specified file</para>
  258. <indexterm zone="ch-system-coreutils cksum">
  259. <primary sortas="b-cksum">cksum</primary>
  260. </indexterm>
  261. </listitem>
  262. </varlistentry>
  263. <varlistentry id="comm">
  264. <term><command>comm</command></term>
  265. <listitem>
  266. <para>Compares two sorted files, outputting in three columns the lines
  267. that are unique and the lines that are common</para>
  268. <indexterm zone="ch-system-coreutils comm">
  269. <primary sortas="b-comm">comm</primary>
  270. </indexterm>
  271. </listitem>
  272. </varlistentry>
  273. <varlistentry id="cp">
  274. <term><command>cp</command></term>
  275. <listitem>
  276. <para>Copies files</para>
  277. <indexterm zone="ch-system-coreutils cp">
  278. <primary sortas="b-cp">cp</primary>
  279. </indexterm>
  280. </listitem>
  281. </varlistentry>
  282. <varlistentry id="csplit">
  283. <term><command>csplit</command></term>
  284. <listitem>
  285. <para>Splits a given file into several new files, separating them
  286. according to given patterns or line numbers and outputting the byte
  287. count of each new file</para>
  288. <indexterm zone="ch-system-coreutils csplit">
  289. <primary sortas="b-csplit">csplit</primary>
  290. </indexterm>
  291. </listitem>
  292. </varlistentry>
  293. <varlistentry id="cut">
  294. <term><command>cut</command></term>
  295. <listitem>
  296. <para>Prints sections of lines, selecting the parts according to given
  297. fields or positions</para>
  298. <indexterm zone="ch-system-coreutils cut">
  299. <primary sortas="b-cut">cut</primary>
  300. </indexterm>
  301. </listitem>
  302. </varlistentry>
  303. <varlistentry id="date">
  304. <term><command>date</command></term>
  305. <listitem>
  306. <para>Displays the current time in the given format, or sets the
  307. system date</para>
  308. <indexterm zone="ch-system-coreutils date">
  309. <primary sortas="b-date">date</primary>
  310. </indexterm>
  311. </listitem>
  312. </varlistentry>
  313. <varlistentry id="dd">
  314. <term><command>dd</command> </term>
  315. <listitem>
  316. <para>Copies a file using the given block size and count, while
  317. optionally performing conversions on it</para>
  318. <indexterm zone="ch-system-coreutils dd">
  319. <primary sortas="b-dd">dd</primary>
  320. </indexterm>
  321. </listitem>
  322. </varlistentry>
  323. <varlistentry id="df">
  324. <term><command>df</command></term>
  325. <listitem>
  326. <para>Reports the amount of disk space available (and used) on all
  327. mounted file systems, or only on the file systems holding the selected
  328. files</para>
  329. <indexterm zone="ch-system-coreutils df">
  330. <primary sortas="b-df">df</primary>
  331. </indexterm>
  332. </listitem>
  333. </varlistentry>
  334. <varlistentry id="dir">
  335. <term><command>dir</command></term>
  336. <listitem>
  337. <para>Lists the contents of each given directory (the same as
  338. the <command>ls</command> command)</para>
  339. <indexterm zone="ch-system-coreutils dir">
  340. <primary sortas="b-dir">dir</primary>
  341. </indexterm>
  342. </listitem>
  343. </varlistentry>
  344. <varlistentry id="dircolors">
  345. <term><command>dircolors</command></term>
  346. <listitem>
  347. <para>Outputs commands to set the <envar>LS_COLOR</envar>
  348. environment variable to change the color scheme used by
  349. <command>ls</command></para>
  350. <indexterm zone="ch-system-coreutils dircolors">
  351. <primary sortas="b-dircolors">dircolors</primary>
  352. </indexterm>
  353. </listitem>
  354. </varlistentry>
  355. <varlistentry id="dirname">
  356. <term><command>dirname</command></term>
  357. <listitem>
  358. <para>Strips the non-directory suffix from a file name</para>
  359. <indexterm zone="ch-system-coreutils dirname">
  360. <primary sortas="b-dirname">dirname</primary>
  361. </indexterm>
  362. </listitem>
  363. </varlistentry>
  364. <varlistentry id="du">
  365. <term><command>du</command></term>
  366. <listitem>
  367. <para>Reports the amount of disk space used by the current directory,
  368. by each of the given directories (including all subdirectories) or by
  369. each of the given files</para>
  370. <indexterm zone="ch-system-coreutils du">
  371. <primary sortas="b-du">du</primary>
  372. </indexterm>
  373. </listitem>
  374. </varlistentry>
  375. <varlistentry id="echo">
  376. <term><command>echo</command></term>
  377. <listitem>
  378. <para>Displays the given strings</para>
  379. <indexterm zone="ch-system-coreutils echo">
  380. <primary sortas="b-echo">echo</primary>
  381. </indexterm>
  382. </listitem>
  383. </varlistentry>
  384. <varlistentry id="env">
  385. <term><command>env</command></term>
  386. <listitem>
  387. <para>Runs a command in a modified environment</para>
  388. <indexterm zone="ch-system-coreutils env">
  389. <primary sortas="b-env">env</primary>
  390. </indexterm>
  391. </listitem>
  392. </varlistentry>
  393. <varlistentry id="expand">
  394. <term><command>expand</command></term>
  395. <listitem>
  396. <para>Converts tabs to spaces</para>
  397. <indexterm zone="ch-system-coreutils expand">
  398. <primary sortas="b-expand">expand</primary>
  399. </indexterm>
  400. </listitem>
  401. </varlistentry>
  402. <varlistentry id="expr">
  403. <term><command>expr</command></term>
  404. <listitem>
  405. <para>Evaluates expressions</para>
  406. <indexterm zone="ch-system-coreutils expr">
  407. <primary sortas="b-expr">expr</primary>
  408. </indexterm>
  409. </listitem>
  410. </varlistentry>
  411. <varlistentry id="factor">
  412. <term><command>factor</command></term>
  413. <listitem>
  414. <para>Prints the prime factors of all specified integer numbers</para>
  415. <indexterm zone="ch-system-coreutils factor">
  416. <primary sortas="b-factor">factor</primary>
  417. </indexterm>
  418. </listitem>
  419. </varlistentry>
  420. <varlistentry id="false">
  421. <term><command>false</command></term>
  422. <listitem>
  423. <para>Does nothing, unsuccessfully; it always exits with a status code
  424. indicating failure</para>
  425. <indexterm zone="ch-system-coreutils false">
  426. <primary sortas="b-false">false</primary>
  427. </indexterm>
  428. </listitem>
  429. </varlistentry>
  430. <varlistentry id="fmt">
  431. <term><command>fmt</command></term>
  432. <listitem>
  433. <para>Reformats the paragraphs in the given files</para>
  434. <indexterm zone="ch-system-coreutils fmt">
  435. <primary sortas="b-fmt">fmt</primary>
  436. </indexterm>
  437. </listitem>
  438. </varlistentry>
  439. <varlistentry id="fold">
  440. <term><command>fold</command></term>
  441. <listitem>
  442. <para>Wraps the lines in the given files</para>
  443. <indexterm zone="ch-system-coreutils fold">
  444. <primary sortas="b-fold">fold</primary>
  445. </indexterm>
  446. </listitem>
  447. </varlistentry>
  448. <varlistentry id="groups">
  449. <term><command>groups</command></term>
  450. <listitem>
  451. <para>Reports a user's group memberships</para>
  452. <indexterm zone="ch-system-coreutils groups">
  453. <primary sortas="b-groups">groups</primary>
  454. </indexterm>
  455. </listitem>
  456. </varlistentry>
  457. <varlistentry id="head">
  458. <term><command>head</command></term>
  459. <listitem>
  460. <para>Prints the first ten lines (or the given number of lines)
  461. of each given file</para>
  462. <indexterm zone="ch-system-coreutils head">
  463. <primary sortas="b-head">head</primary>
  464. </indexterm>
  465. </listitem>
  466. </varlistentry>
  467. <varlistentry id="hostid">
  468. <term><command>hostid</command></term>
  469. <listitem>
  470. <para>Reports the numeric identifier (in hexadecimal) of the host</para>
  471. <indexterm zone="ch-system-coreutils hostid">
  472. <primary sortas="b-hostid">hostid</primary>
  473. </indexterm>
  474. </listitem>
  475. </varlistentry>
  476. <varlistentry id="id">
  477. <term><command>id</command></term>
  478. <listitem>
  479. <para>Reports the effective user ID, group ID, and group memberships
  480. of the current user or specified user</para>
  481. <indexterm zone="ch-system-coreutils id">
  482. <primary sortas="b-id">id</primary>
  483. </indexterm>
  484. </listitem>
  485. </varlistentry>
  486. <varlistentry id="install">
  487. <term><command>install</command> </term>
  488. <listitem>
  489. <para>Copies files while setting their permission modes and, if
  490. possible, their owner and group</para>
  491. <indexterm zone="ch-system-coreutils install">
  492. <primary sortas="b-install">install</primary>
  493. </indexterm>
  494. </listitem>
  495. </varlistentry>
  496. <varlistentry id="join">
  497. <term><command>join</command></term>
  498. <listitem>
  499. <para>Joins the lines that have identical join fields from two
  500. separate files</para>
  501. <indexterm zone="ch-system-coreutils join">
  502. <primary sortas="b-join">join</primary>
  503. </indexterm>
  504. </listitem>
  505. </varlistentry>
  506. <varlistentry id="link">
  507. <term><command>link</command></term>
  508. <listitem>
  509. <para>Creates a hard link with the given name to a file</para>
  510. <indexterm zone="ch-system-coreutils link">
  511. <primary sortas="b-link">link</primary>
  512. </indexterm>
  513. </listitem>
  514. </varlistentry>
  515. <varlistentry id="ln">
  516. <term><command>ln</command></term>
  517. <listitem>
  518. <para>Makes hard links or soft (symbolic) links between files</para>
  519. <indexterm zone="ch-system-coreutils ln">
  520. <primary sortas="b-ln">ln</primary>
  521. </indexterm>
  522. </listitem>
  523. </varlistentry>
  524. <varlistentry id="logname">
  525. <term><command>logname</command></term>
  526. <listitem>
  527. <para>Reports the current user's login name</para>
  528. <indexterm zone="ch-system-coreutils logname">
  529. <primary sortas="b-logname">logname</primary>
  530. </indexterm>
  531. </listitem>
  532. </varlistentry>
  533. <varlistentry id="ls">
  534. <term><command>ls</command></term>
  535. <listitem>
  536. <para>Lists the contents of each given directory</para>
  537. <indexterm zone="ch-system-coreutils ls">
  538. <primary sortas="b-ls">ls</primary>
  539. </indexterm>
  540. </listitem>
  541. </varlistentry>
  542. <varlistentry id="md5sum">
  543. <term><command>md5sum</command></term>
  544. <listitem>
  545. <para>Reports or checks Message Digest 5 (MD5) checksums</para>
  546. <indexterm zone="ch-system-coreutils md5sum">
  547. <primary sortas="b-md5sum">md5sum</primary>
  548. </indexterm>
  549. </listitem>
  550. </varlistentry>
  551. <varlistentry id="mkdir">
  552. <term><command>mkdir</command></term>
  553. <listitem>
  554. <para>Creates directories with the given names</para>
  555. <indexterm zone="ch-system-coreutils mkdir">
  556. <primary sortas="b-mkdir">mkdir</primary>
  557. </indexterm>
  558. </listitem>
  559. </varlistentry>
  560. <varlistentry id="mkfifo">
  561. <term><command>mkfifo</command></term>
  562. <listitem>
  563. <para>Creates First-In, First-Outs (FIFOs), a "named
  564. pipe" in UNIX parlance, with the given names</para>
  565. <indexterm zone="ch-system-coreutils mkfifo">
  566. <primary sortas="b-mkfifo">mkfifo</primary>
  567. </indexterm>
  568. </listitem>
  569. </varlistentry>
  570. <varlistentry id="mknod">
  571. <term><command>mknod</command></term>
  572. <listitem>
  573. <para>Creates device nodes with the given names; a device node is a
  574. character special file, a block special file, or a FIFO</para>
  575. <indexterm zone="ch-system-coreutils mknod">
  576. <primary sortas="b-mknod">mknod</primary>
  577. </indexterm>
  578. </listitem>
  579. </varlistentry>
  580. <varlistentry id="mktemp">
  581. <term><command>mktemp</command></term>
  582. <listitem>
  583. <para>Creates temporary files in a secure manner; it is used in scripts</para>
  584. <indexterm zone="ch-system-coreutils mktemp">
  585. <primary sortas="b-mktemp">mktemp</primary>
  586. </indexterm>
  587. </listitem>
  588. </varlistentry>
  589. <varlistentry id="mv">
  590. <term><command>mv</command></term>
  591. <listitem>
  592. <para>Moves or renames files or directories</para>
  593. <indexterm zone="ch-system-coreutils mv">
  594. <primary sortas="b-mv">mv</primary>
  595. </indexterm>
  596. </listitem>
  597. </varlistentry>
  598. <varlistentry id="nice">
  599. <term><command>nice</command></term>
  600. <listitem>
  601. <para>Runs a program with modified scheduling priority</para>
  602. <indexterm zone="ch-system-coreutils nice">
  603. <primary sortas="b-nice">nice</primary>
  604. </indexterm>
  605. </listitem>
  606. </varlistentry>
  607. <varlistentry id="nl">
  608. <term><command>nl</command></term>
  609. <listitem>
  610. <para>Numbers the lines from the given files</para>
  611. <indexterm zone="ch-system-coreutils nl">
  612. <primary sortas="b-nl">nl</primary>
  613. </indexterm>
  614. </listitem>
  615. </varlistentry>
  616. <varlistentry id="nohup">
  617. <term><command>nohup</command></term>
  618. <listitem>
  619. <para>Runs a command immune to hangups, with its output redirected to
  620. a log file</para>
  621. <indexterm zone="ch-system-coreutils nohup">
  622. <primary sortas="b-nohup">nohup</primary>
  623. </indexterm>
  624. </listitem>
  625. </varlistentry>
  626. <varlistentry id="nproc">
  627. <term><command>nproc</command></term>
  628. <listitem>
  629. <para>Prints the number of processing units available to a
  630. process</para>
  631. <indexterm zone="ch-system-coreutils nproc">
  632. <primary sortas="b-nproc">nproc</primary>
  633. </indexterm>
  634. </listitem>
  635. </varlistentry>
  636. <varlistentry id="numfmt">
  637. <term><command>numfmt</command></term>
  638. <listitem>
  639. <para>Converts numbers to or from human-readable strings</para>
  640. <indexterm zone="ch-system-coreutils numfmt">
  641. <primary sortas="b-numfmt">numfmt</primary>
  642. </indexterm>
  643. </listitem>
  644. </varlistentry>
  645. <varlistentry id="od">
  646. <term><command>od</command></term>
  647. <listitem>
  648. <para>Dumps files in octal and other formats</para>
  649. <indexterm zone="ch-system-coreutils od">
  650. <primary sortas="b-od">od</primary>
  651. </indexterm>
  652. </listitem>
  653. </varlistentry>
  654. <varlistentry id="paste">
  655. <term><command>paste</command></term>
  656. <listitem>
  657. <para>Merges the given files, joining sequentially corresponding lines
  658. side by side, separated by tab characters</para>
  659. <indexterm zone="ch-system-coreutils paste">
  660. <primary sortas="b-paste">paste</primary>
  661. </indexterm>
  662. </listitem>
  663. </varlistentry>
  664. <varlistentry id="pathchk">
  665. <term><command>pathchk</command></term>
  666. <listitem>
  667. <para>Checks if file names are valid or portable</para>
  668. <indexterm zone="ch-system-coreutils pathchk">
  669. <primary sortas="b-pathchk">pathchk</primary>
  670. </indexterm>
  671. </listitem>
  672. </varlistentry>
  673. <varlistentry id="pinky">
  674. <term><command>pinky</command></term>
  675. <listitem>
  676. <para>Is a lightweight finger client; it reports some information
  677. about the given users</para>
  678. <indexterm zone="ch-system-coreutils pinky">
  679. <primary sortas="b-pinky">pinky</primary>
  680. </indexterm>
  681. </listitem>
  682. </varlistentry>
  683. <varlistentry id="pr">
  684. <term><command>pr</command></term>
  685. <listitem>
  686. <para>Paginates and columnates files for printing</para>
  687. <indexterm zone="ch-system-coreutils pr">
  688. <primary sortas="b-pr">pr</primary>
  689. </indexterm>
  690. </listitem>
  691. </varlistentry>
  692. <varlistentry id="printenv">
  693. <term><command>printenv</command></term>
  694. <listitem>
  695. <para>Prints the environment</para>
  696. <indexterm zone="ch-system-coreutils printenv">
  697. <primary sortas="b-printenv">printenv</primary>
  698. </indexterm>
  699. </listitem>
  700. </varlistentry>
  701. <varlistentry id="printf">
  702. <term><command>printf</command></term>
  703. <listitem>
  704. <para>Prints the given arguments according to the given format, much
  705. like the C printf function</para>
  706. <indexterm zone="ch-system-coreutils printf">
  707. <primary sortas="b-printf">printf</primary>
  708. </indexterm>
  709. </listitem>
  710. </varlistentry>
  711. <varlistentry id="ptx">
  712. <term><command>ptx</command></term>
  713. <listitem>
  714. <para>Produces a permuted index from the contents of the given files,
  715. with each keyword in its context</para>
  716. <indexterm zone="ch-system-coreutils ptx">
  717. <primary sortas="b-ptx">ptx</primary>
  718. </indexterm>
  719. </listitem>
  720. </varlistentry>
  721. <varlistentry id="pwd">
  722. <term><command>pwd</command></term>
  723. <listitem>
  724. <para>Reports the name of the current working directory</para>
  725. <indexterm zone="ch-system-coreutils pwd">
  726. <primary sortas="b-pwd">pwd</primary>
  727. </indexterm>
  728. </listitem>
  729. </varlistentry>
  730. <varlistentry id="readlink">
  731. <term><command>readlink</command></term>
  732. <listitem>
  733. <para>Reports the value of the given symbolic link</para>
  734. <indexterm zone="ch-system-coreutils readlink">
  735. <primary sortas="b-readlink">readlink</primary>
  736. </indexterm>
  737. </listitem>
  738. </varlistentry>
  739. <varlistentry id="realpath">
  740. <term><command>realpath</command></term>
  741. <listitem>
  742. <para>Prints the resolved path</para>
  743. <indexterm zone="ch-system-coreutils realpath">
  744. <primary sortas="b-realpath">realpath</primary>
  745. </indexterm>
  746. </listitem>
  747. </varlistentry>
  748. <varlistentry id="rm">
  749. <term><command>rm</command></term>
  750. <listitem>
  751. <para>Removes files or directories</para>
  752. <indexterm zone="ch-system-coreutils rm">
  753. <primary sortas="b-rm">rm</primary>
  754. </indexterm>
  755. </listitem>
  756. </varlistentry>
  757. <varlistentry id="rmdir">
  758. <term><command>rmdir</command></term>
  759. <listitem>
  760. <para>Removes directories if they are empty</para>
  761. <indexterm zone="ch-system-coreutils rmdir">
  762. <primary sortas="b-rmdir">rmdir</primary>
  763. </indexterm>
  764. </listitem>
  765. </varlistentry>
  766. <varlistentry id="runcon">
  767. <term><command>runcon</command></term>
  768. <listitem>
  769. <para>Runs a command with specified security context</para>
  770. <indexterm zone="ch-system-coreutils runcon">
  771. <primary sortas="b-runcon">runcon</primary>
  772. </indexterm>
  773. </listitem>
  774. </varlistentry>
  775. <varlistentry id="seq">
  776. <term><command>seq</command></term>
  777. <listitem>
  778. <para>Prints a sequence of numbers within a given range and with a
  779. given increment</para>
  780. <indexterm zone="ch-system-coreutils seq">
  781. <primary sortas="b-seq">seq</primary>
  782. </indexterm>
  783. </listitem>
  784. </varlistentry>
  785. <varlistentry id="sha1sum">
  786. <term><command>sha1sum</command></term>
  787. <listitem>
  788. <para>Prints or checks 160-bit Secure Hash Algorithm 1 (SHA1)
  789. checksums</para>
  790. <indexterm zone="ch-system-coreutils sha1sum">
  791. <primary sortas="b-sha1sum">sha1sum</primary>
  792. </indexterm>
  793. </listitem>
  794. </varlistentry>
  795. <varlistentry id="sha224sum">
  796. <term><command>sha224sum</command></term>
  797. <listitem>
  798. <para>Prints or checks 224-bit Secure Hash Algorithm checksums</para>
  799. <indexterm zone="ch-system-coreutils sha224sum">
  800. <primary sortas="b-sha224sum">sha224sum</primary>
  801. </indexterm>
  802. </listitem>
  803. </varlistentry>
  804. <varlistentry id="sha256sum">
  805. <term><command>sha256sum</command></term>
  806. <listitem>
  807. <para>Prints or checks 256-bit Secure Hash Algorithm checksums</para>
  808. <indexterm zone="ch-system-coreutils sha256sum">
  809. <primary sortas="b-sha256sum">sha256sum</primary>
  810. </indexterm>
  811. </listitem>
  812. </varlistentry>
  813. <varlistentry id="sha384sum">
  814. <term><command>sha384sum</command></term>
  815. <listitem>
  816. <para>Prints or checks 384-bit Secure Hash Algorithm checksums</para>
  817. <indexterm zone="ch-system-coreutils sha384sum">
  818. <primary sortas="b-sha384sum">sha384sum</primary>
  819. </indexterm>
  820. </listitem>
  821. </varlistentry>
  822. <varlistentry id="sha512sum">
  823. <term><command>sha512sum</command></term>
  824. <listitem>
  825. <para>Prints or checks 512-bit Secure Hash Algorithm checksums</para>
  826. <indexterm zone="ch-system-coreutils sha512sum">
  827. <primary sortas="b-sha512sum">sha512sum</primary>
  828. </indexterm>
  829. </listitem>
  830. </varlistentry>
  831. <varlistentry id="shred">
  832. <term><command>shred</command></term>
  833. <listitem>
  834. <para>Overwrites the given files repeatedly with complex patterns,
  835. making it difficult to recover the data</para>
  836. <indexterm zone="ch-system-coreutils shred">
  837. <primary sortas="b-shred">shred</primary>
  838. </indexterm>
  839. </listitem>
  840. </varlistentry>
  841. <varlistentry id="shuf">
  842. <term><command>shuf</command></term>
  843. <listitem>
  844. <para>Shuffles lines of text</para>
  845. <indexterm zone="ch-system-coreutils shuf">
  846. <primary sortas="b-shuf">shuf</primary>
  847. </indexterm>
  848. </listitem>
  849. </varlistentry>
  850. <varlistentry id="sleep">
  851. <term><command>sleep</command></term>
  852. <listitem>
  853. <para>Pauses for the given amount of time</para>
  854. <indexterm zone="ch-system-coreutils sleep">
  855. <primary sortas="b-sleep">sleep</primary>
  856. </indexterm>
  857. </listitem>
  858. </varlistentry>
  859. <varlistentry id="sort">
  860. <term><command>sort</command></term>
  861. <listitem>
  862. <para>Sorts the lines from the given files</para>
  863. <indexterm zone="ch-system-coreutils sort">
  864. <primary sortas="b-sort">sort</primary>
  865. </indexterm>
  866. </listitem>
  867. </varlistentry>
  868. <varlistentry id="split">
  869. <term><command>split</command></term>
  870. <listitem>
  871. <para>Splits the given file into pieces, by size or by number of
  872. lines</para>
  873. <indexterm zone="ch-system-coreutils split">
  874. <primary sortas="b-split">split</primary>
  875. </indexterm>
  876. </listitem>
  877. </varlistentry>
  878. <varlistentry id="stat">
  879. <term><command>stat</command></term>
  880. <listitem>
  881. <para>Displays file or filesystem status</para>
  882. <indexterm zone="ch-system-coreutils stat">
  883. <primary sortas="b-stat">stat</primary>
  884. </indexterm>
  885. </listitem>
  886. </varlistentry>
  887. <varlistentry id="stdbuf">
  888. <term><command>stdbuf</command></term>
  889. <listitem>
  890. <para>Runs commands with altered buffering operations for its standard
  891. streams</para>
  892. <indexterm zone="ch-system-coreutils stdbuf">
  893. <primary sortas="b-stdbuf">stdbuf</primary>
  894. </indexterm>
  895. </listitem>
  896. </varlistentry>
  897. <varlistentry id="stty">
  898. <term><command>stty</command></term>
  899. <listitem>
  900. <para>Sets or reports terminal line settings</para>
  901. <indexterm zone="ch-system-coreutils stty">
  902. <primary sortas="b-stty">stty</primary>
  903. </indexterm>
  904. </listitem>
  905. </varlistentry>
  906. <varlistentry id="sum">
  907. <term><command>sum</command></term>
  908. <listitem>
  909. <para>Prints checksum and block counts for each given file</para>
  910. <indexterm zone="ch-system-coreutils sum">
  911. <primary sortas="b-sum">sum</primary>
  912. </indexterm>
  913. </listitem>
  914. </varlistentry>
  915. <varlistentry id="sync">
  916. <term><command>sync</command></term>
  917. <listitem>
  918. <para>Flushes file system buffers; it forces changed blocks to disk
  919. and updates the super block</para>
  920. <indexterm zone="ch-system-coreutils sync">
  921. <primary sortas="b-sync">sync</primary>
  922. </indexterm>
  923. </listitem>
  924. </varlistentry>
  925. <varlistentry id="tac">
  926. <term><command>tac</command></term>
  927. <listitem>
  928. <para>Concatenates the given files in reverse</para>
  929. <indexterm zone="ch-system-coreutils tac">
  930. <primary sortas="b-tac">tac</primary>
  931. </indexterm>
  932. </listitem>
  933. </varlistentry>
  934. <varlistentry id="tail">
  935. <term><command>tail</command></term>
  936. <listitem>
  937. <para>Prints the last ten lines (or the given number of lines) of each
  938. given file</para>
  939. <indexterm zone="ch-system-coreutils tail">
  940. <primary sortas="b-tail">tail</primary>
  941. </indexterm>
  942. </listitem>
  943. </varlistentry>
  944. <varlistentry id="tee">
  945. <term><command>tee</command></term>
  946. <listitem>
  947. <para>Reads from standard input while writing both to standard output
  948. and to the given files</para>
  949. <indexterm zone="ch-system-coreutils tee">
  950. <primary sortas="b-tee">tee</primary>
  951. </indexterm>
  952. </listitem>
  953. </varlistentry>
  954. <varlistentry id="test">
  955. <term><command>test</command></term>
  956. <listitem>
  957. <para>Compares values and checks file types</para>
  958. <indexterm zone="ch-system-coreutils test">
  959. <primary sortas="b-test">test</primary>
  960. </indexterm>
  961. </listitem>
  962. </varlistentry>
  963. <varlistentry id="timeout">
  964. <term><command>timeout</command></term>
  965. <listitem>
  966. <para>Runs a command with a time limit</para>
  967. <indexterm zone="ch-system-coreutils timeout">
  968. <primary sortas="b-timeout">timeout</primary>
  969. </indexterm>
  970. </listitem>
  971. </varlistentry>
  972. <varlistentry id="touch">
  973. <term><command>touch</command></term>
  974. <listitem>
  975. <para>Changes file timestamps, setting the access and modification
  976. times of the given files to the current time; files that do not exist
  977. are created with zero length</para>
  978. <indexterm zone="ch-system-coreutils touch">
  979. <primary sortas="b-touch">touch</primary>
  980. </indexterm>
  981. </listitem>
  982. </varlistentry>
  983. <varlistentry id="tr">
  984. <term><command>tr</command></term>
  985. <listitem>
  986. <para>Translates, squeezes, and deletes the given characters from
  987. standard input</para>
  988. <indexterm zone="ch-system-coreutils tr">
  989. <primary sortas="b-tr">tr</primary>
  990. </indexterm>
  991. </listitem>
  992. </varlistentry>
  993. <varlistentry id="true">
  994. <term><command>true</command></term>
  995. <listitem>
  996. <para>Does nothing, successfully; it always exits with a status code
  997. indicating success</para>
  998. <indexterm zone="ch-system-coreutils true">
  999. <primary sortas="b-true">true</primary>
  1000. </indexterm>
  1001. </listitem>
  1002. </varlistentry>
  1003. <varlistentry id="truncate">
  1004. <term><command>truncate</command></term>
  1005. <listitem>
  1006. <para>Shrinks or expands a file to the specified size</para>
  1007. <indexterm zone="ch-system-coreutils truncate">
  1008. <primary sortas="b-truncate">truncate</primary>
  1009. </indexterm>
  1010. </listitem>
  1011. </varlistentry>
  1012. <varlistentry id="tsort">
  1013. <term><command>tsort</command></term>
  1014. <listitem>
  1015. <para>Performs a topological sort; it writes a completely ordered list
  1016. according to the partial ordering in a given file</para>
  1017. <indexterm zone="ch-system-coreutils tsort">
  1018. <primary sortas="b-tsort">tsort</primary>
  1019. </indexterm>
  1020. </listitem>
  1021. </varlistentry>
  1022. <varlistentry id="tty">
  1023. <term><command>tty</command></term>
  1024. <listitem>
  1025. <para>Reports the file name of the terminal connected to standard
  1026. input</para>
  1027. <indexterm zone="ch-system-coreutils tty">
  1028. <primary sortas="b-tty">tty</primary>
  1029. </indexterm>
  1030. </listitem>
  1031. </varlistentry>
  1032. <varlistentry id="uname">
  1033. <term><command>uname</command></term>
  1034. <listitem>
  1035. <para>Reports system information</para>
  1036. <indexterm zone="ch-system-coreutils uname">
  1037. <primary sortas="b-uname">uname</primary>
  1038. </indexterm>
  1039. </listitem>
  1040. </varlistentry>
  1041. <varlistentry id="unexpand">
  1042. <term><command>unexpand</command></term>
  1043. <listitem>
  1044. <para>Converts spaces to tabs</para>
  1045. <indexterm zone="ch-system-coreutils unexpand">
  1046. <primary sortas="b-unexpand">unexpand</primary>
  1047. </indexterm>
  1048. </listitem>
  1049. </varlistentry>
  1050. <varlistentry id="uniq">
  1051. <term><command>uniq</command></term>
  1052. <listitem>
  1053. <para>Discards all but one of successive identical lines</para>
  1054. <indexterm zone="ch-system-coreutils uniq">
  1055. <primary sortas="b-uniq">uniq</primary>
  1056. </indexterm>
  1057. </listitem>
  1058. </varlistentry>
  1059. <varlistentry id="unlink">
  1060. <term><command>unlink</command></term>
  1061. <listitem>
  1062. <para>Removes the given file</para>
  1063. <indexterm zone="ch-system-coreutils unlink">
  1064. <primary sortas="b-unlink">unlink</primary>
  1065. </indexterm>
  1066. </listitem>
  1067. </varlistentry>
  1068. <varlistentry id="users">
  1069. <term><command>users</command></term>
  1070. <listitem>
  1071. <para>Reports the names of the users currently logged on</para>
  1072. <indexterm zone="ch-system-coreutils users">
  1073. <primary sortas="b-users">users</primary>
  1074. </indexterm>
  1075. </listitem>
  1076. </varlistentry>
  1077. <varlistentry id="vdir">
  1078. <term><command>vdir</command></term>
  1079. <listitem>
  1080. <para>Is the same as <command>ls -l</command></para>
  1081. <indexterm zone="ch-system-coreutils vdir">
  1082. <primary sortas="b-vdir">vdir</primary>
  1083. </indexterm>
  1084. </listitem>
  1085. </varlistentry>
  1086. <varlistentry id="wc">
  1087. <term><command>wc</command></term>
  1088. <listitem>
  1089. <para>Reports the number of lines, words, and bytes for each given
  1090. file, as well as a total line when more than one file is given</para>
  1091. <indexterm zone="ch-system-coreutils wc">
  1092. <primary sortas="b-wc">wc</primary>
  1093. </indexterm>
  1094. </listitem>
  1095. </varlistentry>
  1096. <varlistentry id="who">
  1097. <term><command>who</command></term>
  1098. <listitem>
  1099. <para>Reports who is logged on</para>
  1100. <indexterm zone="ch-system-coreutils who">
  1101. <primary sortas="b-who">who</primary>
  1102. </indexterm>
  1103. </listitem>
  1104. </varlistentry>
  1105. <varlistentry id="whoami">
  1106. <term><command>whoami</command></term>
  1107. <listitem>
  1108. <para>Reports the user name associated with the current effective
  1109. user ID</para>
  1110. <indexterm zone="ch-system-coreutils whoami">
  1111. <primary sortas="b-whoami">whoami</primary>
  1112. </indexterm>
  1113. </listitem>
  1114. </varlistentry>
  1115. <varlistentry id="yes">
  1116. <term><command>yes</command></term>
  1117. <listitem>
  1118. <para>Repeatedly outputs <quote>y</quote> or a given string until
  1119. killed</para>
  1120. <indexterm zone="ch-system-coreutils yes">
  1121. <primary sortas="b-yes">yes</primary>
  1122. </indexterm>
  1123. </listitem>
  1124. </varlistentry>
  1125. <varlistentry id="libstdbuf">
  1126. <term><filename class="libraryfile">libstdbuf</filename></term>
  1127. <listitem>
  1128. <para>Library used by <command>stdbuf</command></para>
  1129. <indexterm zone="ch-system-coreutils libstdbuf">
  1130. <primary sortas="c-libstdbuf">libstdbuf</primary>
  1131. </indexterm>
  1132. </listitem>
  1133. </varlistentry>
  1134. </variablelist>
  1135. </sect2>
  1136. </sect1>