xref: /freebsd/share/man/man1/builtin.1 (revision e7be843b4a162e68651d3911f0357ed464915629)
1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 1999 Sheldon Hearn
5.\"
6.\" All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.Dd March 29, 2025
30.Dt BUILTIN 1
31.Os
32.Sh NAME
33.Nm builtin ,
34.Nm keybinds
35.Nd index of FreeBSD shell built-in commands
36.Sh SYNOPSIS
37See the manual for your shell for operation details.
38.Sh DESCRIPTION
39This page provides an index of
40.Nm
41commands, keywords, and keyboard bindings provided by
42.Xr csh 1
43and
44.Xr sh 1 ,
45the command line interpreters which comprise the
46.Bx
47user environment.
48.Ss Commands
49Below is a table which lists
50.Nm
51commands and keywords,
52whether they exist as standalone utilities,
53and the standard shells that provide them.
54.Bl -column "uncomplete" "Standalone" "csh(1)" "sh(1)" -offset indent
55.It Em Command Ta Em Standalone Ta Xr csh 1 Ta Xr sh 1
56.It Ic \&! Ta \&No Ta \&No Ta Yes
57.It Ic % Ta \&No Ta Yes Ta \&No
58.It Ic \&. Ta \&No Ta \&No Ta Yes
59.It Ic \&: Ta \&No Ta Yes Ta Yes
60.It Ic @ Ta \&No Ta Yes Ta \&No
61.It Ic \&[ Ta Yes Ta \&No Ta Yes
62.It Ic { Ta \&No Ta \&No Ta Yes
63.It Ic } Ta \&No Ta \&No Ta Yes
64.It Ic alias Ta No* Ta Yes Ta Yes
65.It Ic alloc Ta \&No Ta Yes Ta \&No
66.It Ic bg Ta No* Ta Yes Ta Yes
67.It Ic bind Ta \&No Ta \&No Ta Yes
68.It Ic bindkey Ta \&No Ta Yes Ta \&No
69.It Ic break Ta \&No Ta Yes Ta Yes
70.It Ic breaksw Ta \&No Ta Yes Ta \&No
71.It Ic builtin Ta \&No Ta \&No Ta Yes
72.It Ic builtins Ta \&No Ta Yes Ta \&No
73.It Ic case Ta \&No Ta Yes Ta Yes
74.It Ic cd Ta No* Ta Yes Ta Yes
75.It Ic chdir Ta \&No Ta Yes Ta Yes
76.It Ic command Ta No* Ta \&No Ta Yes
77.It Ic complete Ta \&No Ta Yes Ta \&No
78.It Ic continue Ta \&No Ta Yes Ta Yes
79.It Ic default Ta \&No Ta Yes Ta \&No
80.It Ic dirs Ta \&No Ta Yes Ta \&No
81.It Ic do Ta \&No Ta \&No Ta Yes
82.It Ic done Ta \&No Ta \&No Ta Yes
83.It Ic echo Ta Yes Ta Yes Ta Yes
84.It Ic echotc Ta \&No Ta Yes Ta \&No
85.It Ic elif Ta \&No Ta \&No Ta Yes
86.It Ic else Ta \&No Ta Yes Ta Yes
87.It Ic end Ta \&No Ta Yes Ta \&No
88.It Ic endif Ta \&No Ta Yes Ta \&No
89.It Ic endsw Ta \&No Ta Yes Ta \&No
90.It Ic esac Ta \&No Ta \&No Ta Yes
91.It Ic eval Ta \&No Ta Yes Ta Yes
92.It Ic exec Ta \&No Ta Yes Ta Yes
93.It Ic exit Ta \&No Ta Yes Ta Yes
94.It Ic export Ta \&No Ta \&No Ta Yes
95.It Ic false Ta Yes Ta \&No Ta Yes
96.It Ic fc Ta No* Ta \&No Ta Yes
97.It Ic fg Ta No* Ta Yes Ta Yes
98.It Ic filetest Ta \&No Ta Yes Ta \&No
99.It Ic fi Ta \&No Ta \&No Ta Yes
100.It Ic for Ta \&No Ta \&No Ta Yes
101.It Ic foreach Ta \&No Ta Yes Ta \&No
102.It Ic getopts Ta No* Ta \&No Ta Yes
103.It Ic glob Ta \&No Ta Yes Ta \&No
104.It Ic goto Ta \&No Ta Yes Ta \&No
105.It Ic hash Ta No* Ta \&No Ta Yes
106.It Ic hashstat Ta \&No Ta Yes Ta \&No
107.It Ic history Ta \&No Ta Yes Ta \&No
108.It Ic hup Ta \&No Ta Yes Ta \&No
109.It Ic if Ta \&No Ta Yes Ta Yes
110.It Ic jobid Ta \&No Ta \&No Ta Yes
111.It Ic jobs Ta No* Ta Yes Ta Yes
112.It Ic kill Ta Yes Ta Yes Ta Yes
113.It Ic limit Ta \&No Ta Yes Ta \&No
114.It Ic local Ta \&No Ta \&No Ta Yes
115.It Ic log Ta \&No Ta Yes Ta \&No
116.It Ic login Ta Yes Ta Yes Ta \&No
117.It Ic logout Ta \&No Ta Yes Ta \&No
118.It Ic ls-F Ta \&No Ta Yes Ta \&No
119.It Ic nice Ta Yes Ta Yes Ta \&No
120.It Ic nohup Ta Yes Ta Yes Ta \&No
121.It Ic notify Ta \&No Ta Yes Ta \&No
122.It Ic onintr Ta \&No Ta Yes Ta \&No
123.It Ic popd Ta \&No Ta Yes Ta \&No
124.It Ic printenv Ta Yes Ta Yes Ta \&No
125.It Ic printf Ta Yes Ta \&No Ta Yes
126.It Ic pushd Ta \&No Ta Yes Ta \&No
127.It Ic pwd Ta Yes Ta \&No Ta Yes
128.It Ic read Ta No* Ta \&No Ta Yes
129.It Ic readonly Ta \&No Ta \&No Ta Yes
130.It Ic rehash Ta \&No Ta Yes Ta \&No
131.It Ic repeat Ta \&No Ta Yes Ta \&No
132.It Ic return Ta \&No Ta \&No Ta Yes
133.It Ic sched Ta \&No Ta Yes Ta \&No
134.It Ic set Ta \&No Ta Yes Ta Yes
135.It Ic setenv Ta \&No Ta Yes Ta \&No
136.It Ic settc Ta \&No Ta Yes Ta \&No
137.It Ic setty Ta \&No Ta Yes Ta \&No
138.It Ic setvar Ta \&No Ta \&No Ta Yes
139.It Ic shift Ta \&No Ta Yes Ta Yes
140.It Ic source Ta \&No Ta Yes Ta \&No
141.It Ic stop Ta \&No Ta Yes Ta \&No
142.It Ic suspend Ta \&No Ta Yes Ta \&No
143.It Ic switch Ta \&No Ta Yes Ta \&No
144.It Ic telltc Ta \&No Ta Yes Ta \&No
145.It Ic test Ta Yes Ta \&No Ta Yes
146.It Ic then Ta \&No Ta \&No Ta Yes
147.It Ic time Ta Yes Ta Yes Ta \&No
148.It Ic times Ta \&No Ta \&No Ta Yes
149.It Ic trap Ta \&No Ta \&No Ta Yes
150.It Ic true Ta Yes Ta \&No Ta Yes
151.It Ic type Ta No* Ta \&No Ta Yes
152.It Ic ulimit Ta No* Ta \&No Ta Yes
153.It Ic umask Ta No* Ta Yes Ta Yes
154.It Ic unalias Ta No* Ta Yes Ta Yes
155.It Ic uncomplete Ta \&No Ta Yes Ta \&No
156.It Ic unhash Ta \&No Ta Yes Ta \&No
157.It Ic unlimit Ta \&No Ta Yes Ta \&No
158.It Ic unset Ta \&No Ta Yes Ta Yes
159.It Ic unsetenv Ta \&No Ta Yes Ta \&No
160.It Ic until Ta \&No Ta \&No Ta Yes
161.It Ic wait Ta No* Ta Yes Ta Yes
162.It Ic where Ta \&No Ta Yes Ta \&No
163.It Ic which Ta Yes Ta Yes Ta \&No
164.It Ic while Ta \&No Ta Yes Ta Yes
165.El
166.Pp
167\&No*: Commands marked
168.Ql No*
169exist externally, but are implemented as scripts using a
170.Nm
171command of the same name.
172.Ss Keybinds
173The command line environment also provides the following
174default keyboard bindings:
175.Bl -column "Process Info (SIGINFO)" "^M | ^J" "^M | ^J" -offset indent
176.It Em Signal Ta Xr csh 1 Ta Xr sh 1
177.It Ic Backspace Ta ^H Ta ^H
178.It Ic Carriage Return Ta ^M | ^J Ta ^M | ^J
179.It Ic Tab Ta ^I Ta ^I
180.It Ic Beginning of Line Ta ^A Ta ^A
181.It Ic End of Line Ta ^E Ta ^E
182.It Ic Cursor Forward Ta ^F Ta ^F
183.It Ic Cursor Backward Ta ^B Ta ^B
184.It Ic Clear Screen Ta ^L Ta ^L
185.It Ic Cut Line Ta ^U Ta ^U
186.It Ic Cut Word Backwards Ta ^W Ta ^W
187.It Ic Cut Rest of Line Ta ^K Ta ^K
188.It Ic Paste Last Cut Ta ^Y Ta ^Y
189.It Ic Typo Ta ^T Ta ^T
190.It End of File Po Ic EOF Pc Ta ^D Ta ^D
191.It Interupt Po Ic SIGINT Pc Ta ^C Ta ^C
192.It Process info Po Ic SIGINFO Pc Ta ^T Ta ^T
193.It Ic Search History Ta \&No Ta ^R
194.It Ic Exit Search History Ta \&No Ta ^G
195.It Ic Previous Command Ta ^P Ta ^P
196.It Ic Next Command Ta ^N Ta ^N
197.It Ic Print Next Character Ta ^V Ta ^V
198.It Ic Pause Job Ta ^S Ta ^S
199.It Ic Resume Job Ta ^Q Ta ^Q
200.It Suspend Job Ic (SIGTSTP) Ta ^Z Ta ^Z
201.It Ic Scrollback Mode Ta ScrLk* Ta ScrLk*
202.El
203.Pp
204\&*: Bindings marked
205.Ql *
206are provided by
207.Xr vt 4 ,
208the console driver.
209.Sh SEE ALSO
210.Xr csh 1 ,
211.Xr echo 1 ,
212.Xr false 1 ,
213.Xr kill 1 ,
214.Xr login 1 ,
215.Xr nice 1 ,
216.Xr nohup 1 ,
217.Xr printenv 1 ,
218.Xr printf 1 ,
219.Xr pwd 1 ,
220.Xr sh 1 ,
221.Xr test 1 ,
222.Xr time 1 ,
223.Xr true 1 ,
224.Xr which 1
225.Sh HISTORY
226The
227.Nm
228manual page first appeared in
229.Fx 3.4 .
230.Sh AUTHORS
231.An -nosplit
232This manual page was written by
233.An Alexander Ziaee Aq Mt ziaee@FreeBSD.org
234from an earlier version by
235.An Sheldon Hearn Aq Mt sheldonh@FreeBSD.org .
236.Sh CAVEATS
237While
238.Nm
239commands may exist in more than one shell or standalone,
240each may be implemented differently.
241.Pp
242Standalone utilities and their manuals must be called by their path
243from a shell with a
244.Nm
245command of the same name.
246