From owner-freebsd-doc@FreeBSD.ORG Sun Aug 8 22:00:23 2010 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id D20D31065674 for ; Sun, 8 Aug 2010 22:00:23 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 92D2D8FC15 for ; Sun, 8 Aug 2010 22:00:23 +0000 (UTC) Received: from freefall.freebsd.org (localhost [127.0.0.1]) by freefall.freebsd.org (8.14.4/8.14.4) with ESMTP id o78M0N46037775 for ; Sun, 8 Aug 2010 22:00:23 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.4/8.14.4/Submit) id o78M0N0m037765; Sun, 8 Aug 2010 22:00:23 GMT (envelope-from gnats) Resent-Date: Sun, 8 Aug 2010 22:00:23 GMT Resent-Message-Id: <201008082200.o78M0N0m037765@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Glen Barber Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 36E961065670 for ; Sun, 8 Aug 2010 21:58:42 +0000 (UTC) (envelope-from nobody@FreeBSD.org) Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21]) by mx1.freebsd.org (Postfix) with ESMTP id 2367C8FC17 for ; Sun, 8 Aug 2010 21:58:42 +0000 (UTC) Received: from www.freebsd.org (localhost [127.0.0.1]) by www.freebsd.org (8.14.3/8.14.3) with ESMTP id o78LwgVH081542 for ; Sun, 8 Aug 2010 21:58:42 GMT (envelope-from nobody@www.freebsd.org) Received: (from nobody@localhost) by www.freebsd.org (8.14.3/8.14.3/Submit) id o78Lwffb081540; Sun, 8 Aug 2010 21:58:41 GMT (envelope-from nobody) Message-Id: <201008082158.o78Lwffb081540@www.freebsd.org> Date: Sun, 8 Aug 2010 21:58:41 GMT From: Glen Barber To: freebsd-gnats-submit@FreeBSD.org X-Send-Pr-Version: www-3.1 Cc: Subject: docs/149447: [patch][handbook] Chapter 3 UNIX Basics: Replace instances of "FreeBSD" with "&os; " X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 08 Aug 2010 22:00:23 -0000 >Number: 149447 >Category: docs >Synopsis: [patch][handbook] Chapter 3 UNIX Basics: Replace instances of "FreeBSD" with "&os;" >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Sun Aug 08 22:00:23 UTC 2010 >Closed-Date: >Last-Modified: >Originator: Glen Barber >Release: 8.1-PRERELEASE >Organization: >Environment: FreeBSD orion 8.1-PRERELEASE FreeBSD 8.1-PRERELEASE #3 r210428: Sat Jul 24 13:37:37 EDT 2010 root@orion:/usr/obj/usr/src/sys/ORION amd64 >Description: In feedback received for a previously submitted patch, it was mentioned I should use "&os;" in place of "FreeBSD" in SGML documents. I found many instances of "FreeBSD" where "&os;" should probably be used. The attached patch, generated against revision 1.157 of doc/en_US.ISO8859-1/books/handbook/basics/chapter.sgml, makes this change where applicable. >How-To-Repeat: >Fix: Patch attached with submission follows: --- basics/chapter.sgml.orig 2010-08-08 17:00:16.293104983 -0400 +++ basics/chapter.sgml 2010-08-08 17:11:59.522927488 -0400 @@ -22,10 +22,10 @@ Synopsis The following chapter will cover the basic commands and - functionality of the FreeBSD operating system. Much of this + functionality of the &os; operating system. Much of this material is relevant for any &unix;-like operating system. Feel free to skim over this chapter if you are familiar with the - material. If you are new to FreeBSD, then you will definitely + material. If you are new to &os;, then you will definitely want to read through this chapter carefully. After reading this chapter, you will know: @@ -33,7 +33,7 @@ How to use the virtual consoles of - FreeBSD. + &os;. How &unix; file permissions work along with @@ -76,17 +76,17 @@ virtual consoles terminals - FreeBSD can be used in various ways. One of them is typing commands + &os; can be used in various ways. One of them is typing commands to a text terminal. A lot of the flexibility and power of a &unix; - operating system is readily available at your hands when using FreeBSD + operating system is readily available at your hands when using &os; this way. This section describes what terminals and - consoles are, and how you can use them in FreeBSD. + consoles are, and how you can use them in &os;. The Console console - If you have not configured FreeBSD to automatically start a + If you have not configured &os; to automatically start a graphical environment during startup, the system will present you with a login prompt after it boots, right after the startup scripts finish running. You will see something similar to: @@ -108,11 +108,11 @@ FreeBSD/i386 (pc3.example.org) (ttyv0) This line contains some bits of information about the system you - have just booted. You are looking at a FreeBSD + have just booted. You are looking at a &os; console, running on an Intel or compatible processor of the x86 architecture This is what i386 means. Note that even if - you are not running FreeBSD on an Intel 386 CPU, this is going to + you are not running &os; on an Intel 386 CPU, this is going to be i386. It is not the type of your processor, but the processor architecture that is shown here. @@ -126,32 +126,32 @@ login: This is the part where you are supposed to type in your - username to log into FreeBSD. The next section + username to log into &os;. The next section describes how you can do this. - Logging into FreeBSD + Logging into &os; - FreeBSD is a multiuser, multiprocessing system. This is + &os; is a multiuser, multiprocessing system. This is the formal description that is usually given to a system that can be used by many different people, who simultaneously run a lot of programs on a single machine. Every multiuser system needs some way to distinguish one - user from the rest. In FreeBSD (and all the + user from the rest. In &os; (and all the &unix;-like operating systems), this is accomplished by requiring that every user must log into the system before being able to run programs. Every user has a unique name (the username) and a personal, secret key (the - password). FreeBSD will ask for these two before + password). &os; will ask for these two before allowing a user to run any programs. startup scripts - Right after FreeBSD boots and finishes running its startup + Right after &os; boots and finishes running its startup scripts Startup scripts are programs that are run automatically by - FreeBSD when booting. Their main function is to set things up for + &os; when booting. Their main function is to set things up for everything else to run, and start any services that you have configured to run in the background doing useful things. , it will present you with a prompt and ask for a valid @@ -173,35 +173,35 @@ it to say that it is done for security reasons. If you have typed your password correctly, you should by now be - logged into FreeBSD and ready to try out all the available + logged into &os; and ready to try out all the available commands. You should see the MOTD or message of the day followed by a command prompt (a #, $, or % character). This - indicates you have successfully logged into FreeBSD. + indicates you have successfully logged into &os;. Multiple Consoles - Running &unix; commands in one console is fine, but FreeBSD can + Running &unix; commands in one console is fine, but &os; can run many programs at once. Having one console where commands can be - typed would be a bit of a waste when an operating system like FreeBSD + typed would be a bit of a waste when an operating system like &os; can run dozens of programs at the same time. This is where virtual consoles can be very helpful. - FreeBSD can be configured to present you with many different + &os; can be configured to present you with many different virtual consoles. You can switch from one of them to any other virtual console by pressing a couple of keys on your keyboard. Each - console has its own different output channel, and FreeBSD takes care + console has its own different output channel, and &os; takes care of properly redirecting keyboard input and monitor output as you switch from one virtual console to the next. - Special key combinations have been reserved by FreeBSD for + Special key combinations have been reserved by &os; for switching consoles A fairly technical and accurate description of all the details - of the FreeBSD console and keyboard drivers can be found in the + of the &os; console and keyboard drivers can be found in the manual pages of &man.syscons.4;, &man.atkbd.4;, &man.vidcontrol.1; and &man.kbdcontrol.1;. We will not expand on the details here, but the interested reader can always consult the manual pages for @@ -211,13 +211,13 @@ AltF1, AltF2, through AltF8 to switch - to a different virtual console in FreeBSD. + to a different virtual console in &os;. - As you are switching from one console to the next, FreeBSD takes + As you are switching from one console to the next, &os; takes care of saving and restoring the screen output. The result is an illusion of having multiple virtual screens and keyboards that you can use to type commands for - FreeBSD to run. The programs that you launch on one virtual console + &os; to run. The programs that you launch on one virtual console do not stop running when that console is not visible. They continue running when you have switched to a different virtual console. @@ -225,7 +225,7 @@ The <filename>/etc/ttys</filename> File - The default configuration of FreeBSD will start up with eight + The default configuration of &os; will start up with eight virtual consoles. This is not a hardwired setting though, and you can easily customize your installation to boot with more or fewer virtual consoles. The number and settings of the @@ -233,10 +233,10 @@ /etc/ttys file. You can use the /etc/ttys file to configure - the virtual consoles of FreeBSD. Each uncommented line in this file + the virtual consoles of &os;. Each uncommented line in this file (lines that do not start with a # character) contains settings for a single terminal or virtual console. The default - version of this file that ships with FreeBSD configures nine virtual + version of this file that ships with &os; configures nine virtual consoles, and enables eight of them. They are the lines that start with ttyv: @@ -263,7 +263,7 @@ A detailed description of what single user mode is can be found in . It is worth noting - that there is only one console when you are running FreeBSD in single + that there is only one console when you are running &os; in single user mode. There are no virtual consoles available. The settings of the single user mode console can also be found in the /etc/ttys file. Look for the line that starts @@ -278,7 +278,7 @@ As the comments above the console line indicate, you can edit this line and change secure to - insecure. If you do that, when FreeBSD boots + insecure. If you do that, when &os; boots into single user mode, it will still ask for the root password. @@ -286,7 +286,7 @@ insecure. If you ever forget the root password, booting into single user mode is a bit involved. It is still possible, but it might be a bit - hard for someone who is not very comfortable with the FreeBSD + hard for someone who is not very comfortable with the &os; booting process and the programs involved. @@ -294,7 +294,7 @@ Changing Console Video Modes - The FreeBSD console default video mode may be adjusted to + The &os; console default video mode may be adjusted to 1024x768, 1280x1024, or any other size supported by your graphics chip and monitor. To use a different video mode, you first must recompile your kernel and include two additional @@ -328,9 +328,9 @@ Permissions UNIX - FreeBSD, being a direct descendant of BSD &unix;, is based on + &os;, being a direct descendant of BSD &unix;, is based on several key &unix; concepts. The first and - most pronounced is that FreeBSD is a multi-user operating system. + most pronounced is that &os; is a multi-user operating system. The system can handle several users all working simultaneously on completely unrelated tasks. The system is responsible for properly sharing and managing requests for hardware devices, peripherals, @@ -450,7 +450,7 @@ of the file's permission. This is all well and good, but how does the system control - permissions on devices? FreeBSD actually treats most hardware + permissions on devices? &os; actually treats most hardware devices as a file that programs can open, read, and write data to just like any other file. These special device files are stored on the /dev directory. @@ -798,7 +798,7 @@ Directory Structure directory hierarchy - The FreeBSD directory hierarchy is fundamental to obtaining + The &os; directory hierarchy is fundamental to obtaining an overall understanding of the system. The most important concept to grasp is that of the root directory, /. This directory is the first one mounted at @@ -979,7 +979,7 @@ class="directory">/usr/local/ Local executables, libraries, etc. Also used as - the default destination for the FreeBSD ports + the default destination for the &os; ports framework. Within /usr/local, the general layout sketched out by &man.hier.7; for /usr should be used. Exceptions @@ -999,7 +999,7 @@ /usr/ports/ - The FreeBSD Ports Collection (optional). + The &os; Ports Collection (optional). @@ -1074,10 +1074,10 @@ Disk Organization - The smallest unit of organization that FreeBSD uses to find files + The smallest unit of organization that &os; uses to find files is the filename. Filenames are case-sensitive, which means that readme.txt and README.TXT - are two separate files. FreeBSD does not use the extension + are two separate files. &os; does not use the extension (.txt) of a file to determine whether the file is a program, or a document, or some other form of data. @@ -1106,15 +1106,15 @@ \ to separate file and directory names, while &macos; uses :. - FreeBSD does not use drive letters, or other drive names in the + &os; does not use drive letters, or other drive names in the path. You would not write c:/foo/bar/readme.txt - on FreeBSD. + on &os;. Instead, one file system is designated the root file system. The root file system's root directory is referred to as /. Every other file system is then mounted under the root file system. No matter - how many disks you have on your FreeBSD system, every directory + how many disks you have on your &os; system, every directory appears to be part of the same disk. Suppose you have three file systems, called A, @@ -1255,7 +1255,7 @@ identical, to the join command. This is not normally something you need to concern yourself with. - Typically you create file systems when installing FreeBSD and decide + Typically you create file systems when installing &os; and decide where to mount them, and then never change them unless you add a new disk. @@ -1280,7 +1280,7 @@ - FreeBSD automatically optimizes the layout of files on a + &os; automatically optimizes the layout of files on a file system, depending on how the file system is being used. So a file system that contains many small files that are written frequently will have a different optimization to one that contains @@ -1289,7 +1289,7 @@ - FreeBSD's file systems are very robust should you lose power. + &os;'s file systems are very robust should you lose power. However, a power loss at a critical point could still damage the structure of the file system. By splitting your data over multiple file systems it is more likely that the system will still come up, @@ -1302,13 +1302,13 @@ File systems are a fixed size. If you create a file system when - you install FreeBSD and give it a specific size, you may later + you install &os; and give it a specific size, you may later discover that you need to make the partition bigger. This is not easily accomplished without backing up, recreating the file system with the new size, and then restoring the backed up data. - FreeBSD features the &man.growfs.8; + &os; features the &man.growfs.8; command, which makes it possible to increase the size of file system on the fly, removing this limitation. @@ -1324,11 +1324,11 @@ typical mount point in the file system hierarchy, or the letter of the partition they are contained in. - FreeBSD also uses disk space for swap - space. Swap space provides FreeBSD with + &os; also uses disk space for swap + space. Swap space provides &os; with virtual memory. This allows your computer to behave as though it has much more memory than it actually does. When - FreeBSD runs out of memory it moves some of the data that is not + &os; runs out of memory it moves some of the data that is not currently being used to the swap space, and moves it back in (moving something else out) when it needs it. @@ -1383,9 +1383,9 @@ Each partition-that-contains-a-file-system is stored in what - FreeBSD calls a slice. Slice is FreeBSD's term + &os; calls a slice. Slice is &os;'s term for what the common call partitions, and again, this is because of - FreeBSD's &unix; background. Slices are numbered, starting at 1, + &os;'s &unix; background. Slices are numbered, starting at 1, through to 4. slices @@ -1419,7 +1419,7 @@ 0. Common codes that you will see are listed in . - When referring to a partition FreeBSD requires that you also name + When referring to a partition &os; requires that you also name the slice and disk that contains the partition, and when referring to a slice you must also refer to the disk name. Thus, you refer to a partition by listing @@ -1430,9 +1430,9 @@ shows a conceptual model of the disk layout that should help make things clearer. - In order to install FreeBSD you must first configure the disk + In order to install &os; you must first configure the disk slices, then create partitions within the slice you will use for - FreeBSD, and then create a file system (or swap space) in each + &os;, and then create a file system (or swap space) in each partition, and decide where that file system will be mounted. @@ -1524,11 +1524,11 @@ Conceptual Model of a Disk - This diagram shows FreeBSD's view of the first IDE disk attached + This diagram shows &os;'s view of the first IDE disk attached to the system. Assume that the disk is 4 GB in size, and contains two 2 GB slices (&ms-dos; partitions). The first slice contains a &ms-dos; disk, C:, and the second slice contains a - FreeBSD installation. This example FreeBSD installation has three + &os; installation. This example &os; installation has three data partitions, and a swap partition. The three partitions will each hold a file system. Partition @@ -1640,7 +1640,7 @@ fstype The file system type to pass to - &man.mount.8;. The default FreeBSD file system is + &man.mount.8;. The default &os; file system is ufs. @@ -1847,7 +1847,7 @@ Processes - FreeBSD is a multi-tasking operating system. This means that it + &os; is a multi-tasking operating system. This means that it seems as though more than one program is running at once. Each program running at any one time is called a process. Every command you run will start at least one new process, and there are @@ -1866,7 +1866,7 @@ parent process. The exception to this is a special process called &man.init.8;. init is always the first process, so its PID is always 1. init is started - automatically by the kernel when FreeBSD starts. + automatically by the kernel when &os; starts. Two commands are particularly useful to see the processes on the system, &man.ps.1; and &man.top.1;. The ps command is used to @@ -2010,9 +2010,9 @@ root user, who can send signals to everyone's processes. - FreeBSD will also send applications signals in some cases. If an + &os; will also send applications signals in some cases. If an application is badly written, and tries to access memory that it is not - supposed to, FreeBSD sends the process the Segmentation + supposed to, &os; sends the process the Segmentation Violation signal (SIGSEGV). If an application has used the &man.alarm.3; system call to be alerted after a period of time has elapsed then it will be sent the Alarm signal @@ -2030,7 +2030,7 @@ SIGKILL can not be ignored by a process. This is the I do not care what you are doing, stop right now signal. If you send SIGKILL to a process then - FreeBSD will stop that process there and then + &os; will stop that process there and then Not quite true—there are a few things that can not be interrupted. For example, if the process is trying to read from a file that is on another computer on the network, and the other @@ -2141,15 +2141,15 @@ shells command line - In FreeBSD, a lot of everyday work is done in a command line + In &os;, a lot of everyday work is done in a command line interface called a shell. A shell's main job is to take commands from the input channel and execute them. A lot of shells also have built in functions to help with everyday tasks such as file management, file globbing, command line editing, command macros, and environment - variables. FreeBSD comes with a set of shells, such as + variables. &os; comes with a set of shells, such as sh, the Bourne Shell, and tcsh, the improved C-shell. Many other shells are available - from the FreeBSD Ports Collection, such as + from the &os; Ports Collection, such as zsh and bash. Which shell do you use? It is really a matter of taste. If you @@ -2235,7 +2235,7 @@ OSTYPE - Type of operating system. e.g., FreeBSD. + Type of operating system. e.g., &os;. @@ -2349,9 +2349,9 @@ text editors editors - A lot of configuration in FreeBSD is done by editing text files. + A lot of configuration in &os; is done by editing text files. Because of this, it would be a good idea to become familiar - with a text editor. FreeBSD comes with a few as part of the base + with a text editor. &os; comes with a few as part of the base system, and many more are available in the Ports Collection. @@ -2391,10 +2391,10 @@ editors emacs - FreeBSD also comes with more powerful text editors such as + &os; also comes with more powerful text editors such as vi as part of the base system, while other editors, like Emacs and vim, - are part of the FreeBSD Ports Collection (editors/emacs and editors/vim). These editors offer much + are part of the &os; Ports Collection (editors/emacs and editors/vim). These editors offer much more functionality and power at the expense of being a little more complicated to learn. However if you plan on doing a lot of text editing, learning a more powerful editor such as @@ -2413,8 +2413,8 @@ A device is a term used mostly for hardware-related activities in a system, including disks, printers, graphics - cards, and keyboards. When FreeBSD boots, the majority - of what FreeBSD displays are devices being detected. + cards, and keyboards. When &os; boots, the majority + of what &os; displays are devices being detected. You can look through the boot messages again by viewing /var/run/dmesg.boot. @@ -2485,7 +2485,7 @@ has at least three ABIs: SVR4, Solaris, SCO) does it hold true. - FreeBSD tries to work around this problem somewhat by + &os; tries to work around this problem somewhat by providing a utility for branding a known ELF executable with information about the ABI it is compliant with. See the manual page for @@ -2493,12 +2493,12 @@ - FreeBSD comes from the classic camp and used + &os; comes from the classic camp and used the &man.a.out.5; format, a technology tried and proven through many generations of BSD releases, until the beginning of the 3.X branch. Though it was possible to build and run native - ELF binaries (and kernels) on a FreeBSD - system for some time before that, FreeBSD initially resisted the + ELF binaries (and kernels) on a &os; + system for some time before that, &os; initially resisted the push to switch to ELF as the default format. Why? Well, when the Linux camp made their painful transition to ELF, it was not so much @@ -2509,7 +2509,7 @@ ELF tools available offered a solution to the shared library problem and were generally seen as the way forward anyway, the migration cost was accepted as - necessary and the transition made. FreeBSD's shared library + necessary and the transition made. &os;'s shared library mechanism is based more closely on Sun's &sunos; style shared library mechanism and, as such, is very easy to use. @@ -2558,20 +2558,20 @@ a.out than it was to migrate to ELF. - However, as time passed, the build tools that FreeBSD + However, as time passed, the build tools that &os; derived their build tools from (the assembler and loader - especially) evolved in two parallel trees. The FreeBSD tree + especially) evolved in two parallel trees. The &os; tree added shared libraries and fixed some bugs. The GNU folks that originally wrote these programs rewrote them and added simpler support for building cross compilers, plugging in different formats at will, and so on. Since many people wanted to build cross - compilers targeting FreeBSD, they were out of luck since the - older sources that FreeBSD had for as and ld were not up to the + compilers targeting &os;, they were out of luck since the + older sources that &os; had for as and ld were not up to the task. The new GNU tools chain (binutils) does support cross compiling, ELF, shared libraries, C++ extensions, etc. In addition, many vendors are releasing ELF binaries, and it is a good thing for - FreeBSD to run them. + &os; to run them. ELF is more expressive than a.out and allows more extensibility in the base system. The @@ -2594,7 +2594,7 @@ Manual Pages manual pages - The most comprehensive documentation on FreeBSD is in the form + The most comprehensive documentation on &os; is in the form of manual pages. Nearly every program on the system comes with a short reference manual explaining the basic operation and various arguments. These manuals can be viewed with the man command. Use @@ -2696,7 +2696,7 @@ GNU Info Files Free Software Foundation - FreeBSD includes many applications and utilities produced by + &os; includes many applications and utilities produced by the Free Software Foundation (FSF). In addition to manual pages, these programs come with more extensive hypertext documents called info files which can be viewed with the >Release-Note: >Audit-Trail: >Unformatted: