xref: /freebsd/share/man/man1/intro.1 (revision cc0af6d5a6c2b10b8655945abdd4ab110cb11998)

.\"-
.\" SPDX-License-Identifier: BSD-3-Clause
.\"
.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd April 12, 2024
.Dt INTRO 1
.Os
.Sh NAME
.Nm intro
.Nd introduction to general commands (tools and utilities)
.Sh DESCRIPTION
Section one of the manual contains most of the commands
which comprise the
.Fx
user environment.
Some of the commands included with the system in section one are
text editors, command shell interpreters,
searching and sorting tools,
file manipulation commands,
system status commands,
remote file copy commands, mail commands,
compilers and compiler tools,
formatted output tools,
and line printer commands.
.Pp
Tens of thousands of additional commands are available to be installed
with
.Xr pkg 8 ,
or compiled with the
.Xr ports 7
collection.
Some of which include web browsers, office suites, calendars,
conferencing utilities, integrated development environments,
media players, audio and video processing suites, etc.
.Pp
All commands set a status value upon exit which may be tested
to see if the command completed normally.
Traditionally, the value 0 signifies successful
completion of the command, while a value >0 indicates an error.
Some commands attempt to describe the nature of the failure by using
exit codes as defined in
.Xr sysexits 3 ,
while others simply set the status to an arbitrary value >0
.Pq typically 1 .
.Sh FILES
.Bl -tag -width "/usr/local/bin/tab" -compact
.It Pa /bin/
Commands fundamental to single- and multi-user modes.
.It Pa /usr/bin/
General commands included with the base system.
.It Pa /usr/local/bin/
Locally installed commands from
.Xr pkg 8 or
.Xr ports 7 .
.El
.Sh SEE ALSO
.Xr apropos 1 ,
.Xr man 1 ,
.Xr which 1 ,
.Xr intro 2 ,
.Xr intro 3 ,
.Xr sysexits 3 ,
.Xr intro 4 ,
.Xr intro 5 ,
.Xr intro 6 ,
.Xr intro 7 ,
.Xr ports 7 ,
.Xr security 7 ,
.Xr intro 8 ,
.Xr pkg 8 ,
.Xr intro 9
.Pp
Tutorials in the
.%T "UNIX User's Manual Supplementary Documents" .
.Sh HISTORY
The
.Nm Ns Pq 1
manual page first appeared in
.At v6 .