- For People New to Both FreeBSD and &unix; - +

+ + For People New to Both FreeBSD and &unix; - AnneliseAnderson + + + Annelise + Anderson + +

andrsn@andrsn.stanford.edu

- + + 1997-08-15 @@ -36,13 +44,16 @@ Logging in and Getting Out Log in (when you see login:) as a user you - created during installation or as root. - (Your FreeBSD installation will already have an account for - root; who can go anywhere and do anything, including deleting - essential files, so be careful!) The symbols &prompt.user; and - &prompt.root; in the following stand for the prompt (yours may - be different), with &prompt.user; indicating an ordinary user - and &prompt.root; indicating root. + created during installation or as root. (Your FreeBSD + installation will already have an account for root; who can go anywhere and do + anything, including deleting essential files, so be careful!) + The symbols &prompt.user; and &prompt.root; in the following + stand for the prompt (yours may be different), with + &prompt.user; indicating an ordinary user and &prompt.root; + indicating root. To log out (and get a new login: prompt) type @@ -83,62 +94,71 @@ - Adding A User with Root Privileges + Adding a User with Root Privileges - If you did not create any users when you installed the system - and are thus logged in as root, you should probably create a - user now with + If you did not create any users when you installed the + system and are thus logged in as root, you should probably create + a user now with &prompt.root; adduser - The first time you use adduser, it might ask for some - defaults to save. You might want to make the default shell - &man.csh.1; instead of &man.sh.1;, if it suggests + The first time you use adduser, it might + ask for some defaults to save. You might want to make the + default shell &man.csh.1; instead of &man.sh.1;, if it suggests sh as the default. Otherwise just press enter to accept each default. These defaults are saved in /etc/adduser.conf, an editable file. - Suppose you create a user jack with - full name Jack Benimble. Give jack a - password if security (even kids around who might pound on the - keyboard) is an issue. When it asks you if you want to invite - jack into other groups, type wheel + Suppose you create a user jack with full name + Jack Benimble. Give jack a password if security + (even kids around who might pound on the keyboard) is an issue. + When it asks you if you want to invite jack into other groups, type + wheel Login group is ``jack''. Invite jack into other groups: wheel - This will make it possible to log in as - jack and use the &man.su.1; - command to become root. Then you will not get scolded any more for - logging in as root. + This will make it possible to log in as jack and use the &man.su.1; + command to become root. Then you will not get + scolded any more for logging in as root. You can quit adduser any time by typing CtrlC, - and at the end you will have a chance to approve your new user or - simply type n for no. You might want to create - a second new user so that when you edit jack's login - files, you will have a hot spare in case something goes - wrong. + and at the end you will have a chance to approve your new user + or simply type n for no. You might want to + create a second new user so that when you edit jack's login files, you will + have a hot spare in case something goes wrong. Once you have done this, use exit to get - back to a login prompt and log in as jack. - In general, it is a good idea to do as much work as possible as - an ordinary user who does not have the power—and - risk—of root. + back to a login prompt and log in as jack. In general, it is a good + idea to do as much work as possible as an ordinary user who does + not have the power—and risk—of root. If you already created a user and you want the user to be - able to su to root, you can log in as root - and edit the file /etc/group, adding jack - to the first line (the group wheel). But + able to su to root, you can log in as + root and edit the file + /etc/group, adding jack to the first line (the + group wheel). But first you need to practice &man.vi.1;, the text editor—or use the simpler text editor, &man.ee.1;, installed on recent versions of FreeBSD. - To delete a user, use the rmuser - command. + To delete a user, use rmuser. @@ -201,8 +221,9 @@ Lists hidden dot files with the others. - If you are root, the dot files show up - without the switch. + If you are root, + the dot files show up without the + switch. @@ -210,14 +231,12 @@ cd - Changes directories. cd - .. backs up one level; - note the space after cd. cd - /usr/local goes there. - cd ~ goes to the - home directory of the person logged in—e.g., - /usr/home/jack. Try cd - /cdrom, and then + Changes directories. cd .. backs + up one level; note the space after cd. + cd /usr/local goes there. cd + ~ goes to the home directory of the person + logged in—e.g., /usr/home/jack. + Try cd /cdrom, and then ls, to find out if your CDROM is mounted and working. @@ -289,11 +308,11 @@ text - The manual page for text. The - major source of documentation for &unix; systems. - man ls will tell - you all the ways to use the ls command. - Press Enter to move through text, + The manual page for text. + The major source of documentation for &unix; systems. + man ls will tell you all the ways to + use ls. Press Enter + to move through text, CtrlB to go back a page, CtrlF @@ -361,11 +380,12 @@ w. Are some of these not working very well? Both - &man.locate.1; and &man.whatis.1; depend - on a database that is rebuilt weekly. If your machine is not - going to be left on over the weekend (and running FreeBSD), you - might want to run the commands for daily, weekly, and monthly - maintenance now and then. Run them as root and, for now, give each one + &man.locate.1; and &man.whatis.1; depend on a database that is + rebuilt weekly. If your machine is not going to be left on over + the weekend (and running FreeBSD), you might want to run the + commands for daily, weekly, and monthly maintenance now and + then. Run them as root and, for now, give each one time to finish before you start the next one. @@ -391,16 +411,16 @@ Running such commands is part of system administration—and as a single user of a &unix; system, you are your own system administrator. Virtually everything you - need to be root to do is system administration. Such - responsibilities are not covered very well even in those big fat - books on &unix;, which seem to devote a lot of space to pulling - down menus in windows managers. You might want to get one of - the two leading books on systems administration, either Evi - Nemeth et.al.'s UNIX System Administration - Handbook (Prentice-Hall, 1995, ISBN - 0-13-15051-7)—the second edition with the red cover; or - Æleen Frisch's Essential System - Administration (O'Reilly & Associates, 2002, + need to be root to do + is system administration. Such responsibilities are not covered + very well even in those big fat books on &unix;, which seem to + devote a lot of space to pulling down menus in windows managers. + You might want to get one of the two leading books on systems + administration, either Evi Nemeth et.al.'s UNIX + System Administration Handbook (Prentice-Hall, + 1995, ISBN 0-13-15051-7)—the second edition with the red + cover; or Æleen Frisch's Essential System + Administration (O'Reilly & Associates, 2002, ISBN 0-596-00343-9). I used Nemeth. @@ -409,10 +429,11 @@ To configure your system, you need to edit text files. Most of them will be in the /etc directory; and - you will need to su to root to be able to - change them. You can use the easy ee, but in - the long run the text editor vi is worth - learning. There is an excellent tutorial on vi in + you will need to su to root to be able to change them. + You can use the easy ee, but in the long run + the text editor vi is worth learning. There + is an excellent tutorial on vi in /usr/src/contrib/nvi/docs/tutorial, if you have the system sources installed. @@ -436,8 +457,8 @@ &prompt.root; cp rc.conf.orig rc.conf - because the mv command preserves the - original date and owner of the file. You can now edit + because mv preserves the original date + and owner of the file. You can now edit rc.conf. If you want the original back, you would then mv rc.conf rc.conf.myedit (assuming you want to preserve your edited version) and @@ -562,37 +583,49 @@ - Ctrlb and - Ctrlf + + + Ctrl + b + + and + + Ctrl + f + + go back and forward a screen, as they do with - more and view. + more and + view. Practice with vi in your home directory by creating a new file with vi - filename and adding and + filename and adding and deleting text, saving the file, and calling it up again. vi delivers some surprises because it is - really quite complex, and sometimes you will inadvertently issue a - command that will do something you do not expect. (Some people - actually like vi—it is more powerful - than DOS EDIT—find out about the :r - command.) Use Esc one or more times to be sure - you are in command mode and proceed from there when it gives you - trouble, save often with :w, and use - :q! to get out and start over (from your last - :w) when you need to. + really quite complex, and sometimes you will inadvertently issue + a command that will do something you do not expect. (Some + people actually like vi—it is more + powerful than DOS EDIT—find out about + :r.) Use Esc one or more + times to be sure you are in command mode and proceed from there + when it gives you trouble, save often with + :w, and use :q! to get out + and start over (from your last :w) when you + need to. Now you can cd to - /etc, su to root, use - vi to edit the file - /etc/group, and add a user to wheel so the - user has root privileges. Just add a comma and the user's login - name to the end of the first line in the file, press + /etc, su to root, use vi + to edit the file /etc/group, and add a user + to wheel so the user + has root privileges. Just add a comma and the user's login name + to the end of the first line in the file, press Esc, and use :wq to write the file to disk and quit. Instantly effective. (You did not put a space after the comma, did you?) @@ -614,13 +647,17 @@ ps aux - shows processes running. ps ax is a - narrower form. + shows processes running. ps ax is + a narrower form. - rm filename + + rm + filename + + remove filename. @@ -628,11 +665,15 @@ - rm -R dir + + rm -R + dir + + - removes a directory dir and all - subdirectories—careful! + removes a directory dir and + all subdirectories—careful! @@ -653,7 +694,8 @@ passwd - to change user's password (or root's password) + to change user's password (or root's password) @@ -666,9 +708,9 @@ - Use find to locate filename in - /usr or any of its subdirectories - with + Use find to locate + filename in /usr or + any of its subdirectories with &prompt.user; find /usr -name "filename" @@ -682,10 +724,10 @@ file(s) on all mounted filesystems, including the CDROM and the DOS partition. - An excellent book that explains &unix; commands and utilities - is Abrahams & Larson, Unix for the - Impatient (2nd ed., Addison-Wesley, 1996). - There is also a lot of &unix; information on the Internet. + An excellent book that explains &unix; commands and + utilities is Abrahams & Larson, Unix for the + Impatient (2nd ed., Addison-Wesley, 1996). There + is also a lot of &unix; information on the Internet. @@ -694,15 +736,15 @@ You should now have the tools you need to get around and edit files, so you can get everything up and running. There is a great deal of information in the FreeBSD handbook (which is - probably on your hard drive) and FreeBSD's web site. A - wide variety of packages and ports are on the CDROM as well as + probably on your hard drive) and FreeBSD's web site. + A wide variety of packages and ports are on the CDROM as well as the web site. The handbook tells you more about how to use them (get the package if it exists, with pkg add packagename, where - packagename is the filename of - the package). The CDROM has lists of the packages and ports - with brief descriptions in - cdrom/packages/index, + packagename is the filename of the + package). The CDROM has lists of the packages and ports with + brief descriptions in cdrom/packages/index, cdrom/packages/index.txt, and cdrom/ports/index, with fuller descriptions in /cdrom/ports/*/*/pkg/DESCR, where the @@ -783,7 +825,7 @@ tcsh does everything csh does and more. It allows you to recall commands with the arrow keys and edit them. It has tab-key completion of filenames - (csh uses the Esc key), and + (csh uses Esc), and it lets you switch to the directory you were last in with cd -. It is also much easier to alter your prompt with tcsh. It makes life a lot @@ -798,34 +840,39 @@ - Use the chsh command to change your - shell to tcsh permanently, or type + Use chsh to change your shell to + tcsh permanently, or type tcsh at the prompt to change your shell without logging in again. - It can be dangerous to change root's shell to something + It can be dangerous to change root's shell to something other than sh or csh on - early versions of FreeBSD and many other versions of &unix;; you - may not have a working shell when the system puts you into + early versions of FreeBSD and many other versions of &unix;; + you may not have a working shell when the system puts you into single user mode. The solution is to use su - -m to become root, which will give you the - tcsh as root, because the shell is part of - the environment. You can make this permanent by adding it to - your .tcshrc file as an alias with: - alias su su -m + -m to become root, which will give you the + tcsh as root, because the shell is + part of the environment. You can make this permanent by + adding it to your .tcshrc as an alias + with: + + alias su su -m When tcsh starts up, it will read the /etc/csh.cshrc and /etc/csh.login files, as does - csh. It will also read the - .login file in your home directory and the - .cshrc file as well, unless you provide a - .tcshrc file. This you can do by simply - copying .cshrc to + csh. It will also read + .login in your home directory and + .cshrc as well, unless you provide a + .tcshrc. This you can do by simply copying + .cshrc to .tcshrc. Now that you have installed tcsh, you can @@ -833,34 +880,35 @@ for tcsh, but here is a line to put in your .tcshrc that will tell you how many commands you have typed, what time it is, and what directory you - are in. It also produces a > if you are an - ordinary user and a # if you are root, but - tsch will do that in any case: + are in. It also produces a > if you are + an ordinary user and a # if you are + root, but tsch will do + that in any case: set prompt = "%h %t %~ %# " This should go in the same place as the existing set prompt line if there is one, or under "if($?prompt) then" if not. Comment out the old line; you can always switch back to it if - you prefer it. Do not forget the spaces and quotes. You can get - the .tcshrc reread by typing + you prefer it. Do not forget the spaces and quotes. You can + get the .tcshrc reread by typing source .tcshrc. You can get a listing of other environmental variables that have been set by typing env at the prompt. The result will show you your default editor, pager, and terminal type, among possibly many others. A useful command if - you log in from a remote location and can not run a program + you log in from a remote location and cannot run a program because the terminal is not capable is setenv TERM - vt100. + vt100. Other - As root, you can unmount the CDROM with - /sbin/umount /cdrom, take it out of the - drive, insert another one, and mount it with + As root, you can + unmount the CDROM with /sbin/umount /cdrom, + take it out of the drive, insert another one, and mount it with /sbin/mount_cd9660 /dev/cd0a /cdrom assuming cd0a is the device name for your CDROM drive. The most recent versions of FreeBSD let you mount the @@ -872,22 +920,22 @@ might try playing games from the CDROM. This involves using lndir, which gets installed with the X Window System, to tell the program(s) where to find the necessary - files, because they are in the /cdrom file - system instead of in /usr and its - subdirectories, which is where they are expected to be. Read - man lndir. + files, because they are in /cdrom instead + of in /usr and its subdirectories, which is + where they are expected to be. Read man + lndir. Comments Welcome - If you use this guide I would be interested in knowing where it - was unclear and what was left out that you think should be + If you use this guide I would be interested in knowing where + it was unclear and what was left out that you think should be included, and if it was helpful. My thanks to Eugene W. Stark, professor of computer science at SUNY-Stony Brook, and John Fieber for helpful comments. Annelise Anderson, - andrsn@andrsn.stanford.edu + andrsn@andrsn.stanford.edu

From owner-svn-doc-head@freebsd.org Thu Aug 16 14:45:07 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 69AAD1069838; Thu, 16 Aug 2018 14:45:07 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 174D185CFB; Thu, 16 Aug 2018 14:45:07 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id CFE301AD29; Thu, 16 Aug 2018 14:45:06 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7GEj6tf023855; Thu, 16 Aug 2018 14:45:06 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7GEj614023854; Thu, 16 Aug 2018 14:45:06 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808161445.w7GEj614023854@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Thu, 16 Aug 2018 14:45:06 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52137 - head/en_US.ISO8859-1/articles/pam X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/articles/pam X-SVN-Commit-Revision: 52137 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Aug 2018 14:45:07 -0000 Author: bcr Date: Thu Aug 16 14:45:06 2018 New Revision: 52137 URL: https://svnweb.freebsd.org/changeset/doc/52137 Log: Cleanup of this file with regards to overlong lines, bad tag indent, and capitalization in titles as much as possible. Modified: head/en_US.ISO8859-1/articles/pam/article.xml Modified: head/en_US.ISO8859-1/articles/pam/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/pam/article.xml Thu Aug 16 13:55:09 2018 (r52136) +++ head/en_US.ISO8859-1/articles/pam/article.xml Thu Aug 16 14:45:06 2018 (r52137) @@ -34,9 +34,11 @@ - OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - SUCH DAMAGE. --> -

- Pluggable Authentication Modules - +

+ + Pluggable Authentication Modules This article describes the underlying principles and @@ -53,7 +55,13 @@ - Dag-ErlingSmørgravContributed by + + + Dag-Erling + Smørgrav + + Contributed by + @@ -99,7 +107,7 @@

- Terms and conventions + Terms and Conventions

Definitions @@ -248,27 +256,26 @@

- Usage examples + Usage Examples This section aims to illustrate the meanings of some of the terms defined above by way of a handful of simple examples.

- Client and server are one + Client and Server Are One This simple example shows alice &man.su.1;'ing to root. -&prompt.user; whoami + &prompt.user; whoami alice &prompt.user; ls -l `which su` -r-sr-xr-x 1 root wheel 10744 Dec 6 19:06 /usr/bin/su &prompt.user; su - Password: xi3kiune &prompt.root; whoami -root - +root @@ -283,7 +290,7 @@ root The authentication token is - xi3kiune. + xi3kiune. The arbitrator is root, which is @@ -293,7 +300,7 @@ root

- Client and server are separate + Client and Server Are Separate The example below shows eve try to initiate an &man.ssh.1; connection to @@ -301,7 +308,7 @@ root bob, and succeed. Bob should have chosen a better password! -&prompt.user; whoami + &prompt.user; whoami eve &prompt.user; ssh bob@login.example.com bob@login.example.com's password: god @@ -329,7 +336,7 @@ Welcome to FreeBSD! The authentication token is - god. + god. Although this is not shown in this example, the @@ -339,12 +346,12 @@ Welcome to FreeBSD!

- Sample policy + Sample Policy The following is FreeBSD's default policy for sshd: -sshd auth required pam_nologin.so no_warn + sshd auth required pam_nologin.so no_warn sshd auth required pam_unix.so no_warn try_first_pass sshd account required pam_login_access.so sshd account required pam_unix.so @@ -391,7 +398,7 @@ sshd password required pam_permit.so

Facilities and - primitives + Primitives The PAM API offers six different authentication primitives grouped in four facilities, which are described below. @@ -519,7 +526,8 @@ sshd password required pam_permit.so

- Module Versioning + Module + Versioning FreeBSD's original PAM implementation, based on Linux-PAM, did not use version numbers for PAM modules. @@ -537,15 +545,15 @@ sshd password required pam_permit.so modules. Although &solaris; PAM modules commonly have a version - number, they are not truly versioned, because the number is a - part of the module name and must be included in the + number, they are not truly versioned, because the number is + a part of the module name and must be included in the configuration.

Chains and - policies + Policies When a server initiates a PAM transaction, the PAM library tries to load a policy for the service specified in the @@ -577,8 +585,9 @@ sshd password required pam_permit.so rest of the chain is executed, but the request is ultimately denied. - This control flag was introduced by Sun in &solaris; 9 - (&sunos; 5.9), and is also supported by OpenPAM. + This control flag was introduced by Sun in &solaris; + 9 (&sunos; 5.9), and is also supported by + OpenPAM. @@ -688,11 +697,11 @@ sshd password required pam_permit.so - The server calls &man.pam.acct.mgmt.3; to verify that the - requested account is available and valid. If the password - is correct but has expired, &man.pam.acct.mgmt.3; will - return PAM_NEW_AUTHTOK_REQD instead of - PAM_SUCCESS. + The server calls &man.pam.acct.mgmt.3; to verify that + the requested account is available and valid. If the + password is correct but has expired, &man.pam.acct.mgmt.3; + will return PAM_NEW_AUTHTOK_REQD + instead of PAM_SUCCESS. @@ -741,18 +750,18 @@ sshd password required pam_permit.so PAM Configuration

- PAM policy files + PAM Policy Files

The - <filename>/etc/pam.conf</filename> file + /etc/pam.conf The traditional PAM policy file is /etc/pam.conf. This file contains all the PAM policies for your system. Each line of the file describes one step in a chain, as shown below: -login auth required pam_nologin.so no_warn + login auth required pam_nologin.so no_warn The fields are, in order: service name, facility name, control flag, module name, and module arguments. Any @@ -772,7 +781,7 @@ sshd password required pam_permit.so

The - <filename>/etc/pam.d</filename> directory + /etc/pam.d OpenPAM and Linux-PAM support an alternate configuration mechanism, which is the preferred mechanism in FreeBSD. In @@ -796,7 +805,7 @@ sshd password required pam_permit.so su and sudo services, one could do as follows: -&prompt.root; cd /etc/pam.d + &prompt.root; cd /etc/pam.d &prompt.root; ln -s su sudo This works because the service name is determined from @@ -811,27 +820,28 @@ sshd password required pam_permit.so

- The policy search - order + The Policy Search + Order As we have seen above, PAM policies can be found in a number of places. What happens if policies for the same service exist in multiple places? It is essential to understand that PAM's configuration - system is centered on chains. + system is centered on chains.

Breakdown of a - configuration line + Configuration Line - As explained in , each line in - /etc/pam.conf consists of four or more - fields: the service name, the facility name, the control flag, - the module name, and zero or more module arguments. + As explained in , each + line in /etc/pam.conf consists of four or + more fields: the service name, the facility name, the control + flag, the module name, and zero or more module + arguments. The service name is generally (though not always) the name of the application the statement applies to. If you are @@ -845,17 +855,18 @@ sshd password required pam_permit.so facility name. The facility is one of the four facility keywords - described in . + described in . Likewise, the control flag is one of the four keywords - described in , - describing how to interpret the return code from the module. - Linux-PAM supports an alternate syntax that lets you specify - the action to associate with each possible return code, but - this should be avoided as it is non-standard and closely tied - in with the way Linux-PAM dispatches service calls (which - differs greatly from the way &solaris; and OpenPAM do it.) - Unsurprisingly, OpenPAM does not support this syntax. + described in , describing + how to interpret the return code from the module. Linux-PAM + supports an alternate syntax that lets you specify the action + to associate with each possible return code, but this should + be avoided as it is non-standard and closely tied in with the + way Linux-PAM dispatches service calls (which differs greatly + from the way &solaris; and OpenPAM do it.) Unsurprisingly, + OpenPAM does not support this syntax.

@@ -882,7 +893,8 @@ sshd password required pam_permit.so the following table applies: - PAM chain execution summary + PAM Chain Execution Summary + @@ -891,10 +903,12 @@ sshd password required pam_permit.so - PAM_SUCCESS - PAM_IGNORE + PAM_SUCCESS + PAM_IGNORE other - + @@ -903,24 +917,28 @@ sshd password required pam_permit.so - fail = true; + required - - fail = true; + requisite - - fail = true; break; + sufficient if (!fail) break; - - + optional - @@ -945,22 +963,21 @@ sshd password required pam_permit.so PAM_NEW_AUTHTOK_REQD. The second exception is that &man.pam.setcred.3; treats - binding and - sufficient modules as if they were - required. + binding and sufficient + modules as if they were required. The third and final exception is that &man.pam.chauthtok.3; runs the entire chain twice (once for preliminary checks and once to actually set the password), and - in the preliminary phase it treats - binding and - sufficient modules as if they were + in the preliminary phase it treats binding + and sufficient modules as if they were required.

- FreeBSD PAM Modules + FreeBSD PAM + Modules

&man.pam.deny.8; @@ -995,29 +1012,32 @@ sshd password required pam_permit.so

- &man.pam.ftpusers.8; + &man.pam.ftpusers.8; The &man.pam.ftpusers.8; module

- &man.pam.group.8; + &man.pam.group.8; The &man.pam.group.8; module accepts or rejects applicants on the basis of their membership in a particular file group (normally wheel for &man.su.1;). It is - primarily intended for maintaining the traditional behavior - of BSD &man.su.1;, but has many other uses, such as excluding + primarily intended for maintaining the traditional behavior of + BSD &man.su.1;, but has many other uses, such as excluding certain groups of users from a particular service.

- &man.pam.guest.8; + &man.pam.guest.8; The &man.pam.guest.8; module allows guest logins using fixed login names. Various requirements can be placed on the - password, but the default behavior is to allow any password - as long as the login name is that of a guest account. The + password, but the default behavior is to allow any password as + long as the login name is that of a guest account. The &man.pam.guest.8; module can easily be used to implement anonymous FTP logins.

@@ -1035,13 +1055,15 @@ sshd password required pam_permit.so

- &man.pam.lastlog.8; + &man.pam.lastlog.8; The &man.pam.lastlog.8; module

- &man.pam.login.access.8; + &man.pam.login.access.8; The &man.pam.login.access.8; module provides an implementation of the account management primitive which @@ -1050,7 +1072,8 @@ sshd password required pam_permit.so

- &man.pam.nologin.8; + &man.pam.nologin.8; The &man.pam.nologin.8; module refuses non-root logins when /var/run/nologin exists. This file @@ -1066,14 +1089,15 @@ sshd password required pam_permit.so challenge-response mechanism where the response to each challenge is a direct function of the challenge and a passphrase, so the response can be easily computed just - in time by anyone possessing the passphrase, + in time by anyone possessing the passphrase, eliminating the need for password lists. Moreover, since &man.opie.4; never reuses a challenge that has been correctly answered, it is not vulnerable to replay attacks.

- &man.pam.opieaccess.8; + &man.pam.opieaccess.8; The &man.pam.opieaccess.8; module is a companion module to &man.pam.opie.8;. Its purpose is to enforce the restrictions @@ -1091,13 +1115,15 @@ sshd password required pam_permit.so

- &man.pam.passwdqc.8; + &man.pam.passwdqc.8; The &man.pam.passwdqc.8; module

- &man.pam.permit.8; + &man.pam.permit.8; The &man.pam.permit.8; module is one of the simplest modules available; it responds to any request with @@ -1107,19 +1133,22 @@ sshd password required pam_permit.so

- &man.pam.radius.8; + &man.pam.radius.8; The &man.pam.radius.8; module

- &man.pam.rhosts.8; + &man.pam.rhosts.8; The &man.pam.rhosts.8; module

- &man.pam.rootok.8; + &man.pam.rootok.8; The &man.pam.rootok.8; module reports success if and only if the real user id of the process calling it (which is @@ -1130,7 +1159,8 @@ sshd password required pam_permit.so

- &man.pam.securetty.8; + &man.pam.securetty.8; The &man.pam.securetty.8; module

@@ -1161,7 +1191,8 @@ sshd password required pam_permit.so

- &man.pam.tacplus.8; + &man.pam.tacplus.8; The &man.pam.tacplus.8; module

@@ -1182,9 +1213,10 @@ sshd password required pam_permit.so

- PAM Application Programming + PAM Application + Programming - This section has not yet been written. + This section has not yet been written. This section has not yet been written. + This section has not yet been written.

- Sample PAM Application + Sample PAM + Application The following is a minimal implementation of &man.su.1; using PAM. Note that it uses the OpenPAM-specific &man.openpam.ttyconv.3; conversation function, which is - prototyped in security/openpam.h. If you wish - build this application on a system with a different PAM library, - you will have to provide your own conversation function. A - robust conversation function is surprisingly difficult to - implement; the one presented in is a good - starting point, but should not be used in real-world - applications. + prototyped in security/openpam.h. If you + wish build this application on a system with a different PAM + library, you will have to provide your own conversation + function. A robust conversation function is surprisingly + difficult to implement; the one presented in is a good starting point, but + should not be used in real-world applications. - + @@ -1245,50 +1279,71 @@ sshd password required pam_permit.so simplified version of OpenPAM's &man.openpam.ttyconv.3;. It is fully functional, and should give the reader a good idea of how a conversation function should behave, but it is far too simple - for real-world use. Even if you are not using OpenPAM, feel free - to download the source code and adapt &man.openpam.ttyconv.3; to - your uses; we believe it to be as robust as a tty-oriented - conversation function can reasonably get. + for real-world use. Even if you are not using OpenPAM, feel + free to download the source code and adapt + &man.openpam.ttyconv.3; to your uses; we believe it to be as + robust as a tty-oriented conversation function can reasonably + get. - Further Reading - + + Further Reading - - This is a list of documents relevant to PAM and related - issues. It is by no means complete. - + + This is a list of documents relevant to PAM and related + issues. It is by no means complete. + Papers - - Making Login Services Independent of Authentication + + Making Login Services Independent of Authentication Technologies - SamarVipin - LaiCharlie + + + Samar + Vipin + + + + + Lai + Charlie + + Sun Microsystems - X/Open - Single Sign-on Preliminary Specification + X/Open + Single Sign-on Preliminary + Specification The Open Group 1-85912-144-6 June 1997 - - Pluggable Authentication Modules - MorganAndrewG. + + Pluggable Authentication Modules + + + Morgan + Andrew + G. + + 1999-10-06 @@ -1297,28 +1352,46 @@ sshd password required pam_permit.so User Manuals - PAM - Administration + PAM + Administration Sun Microsystems - Related Web pages + Related Web Pages - OpenPAM homepage - SmørgravDag-Erling + OpenPAM + homepage + + + Smørgrav + Dag-Erling + + ThinkSec AS - Linux-PAM homepage - MorganAndrewG. + Linux-PAM + homepage + + + Morgan + Andrew + G. + + - Solaris PAM homepage + Solaris + PAM homepage Sun Microsystems From owner-svn-doc-head@freebsd.org Thu Aug 16 14:51:55 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id F18F91069C2A; Thu, 16 Aug 2018 14:51:54 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id A4FD98621B; Thu, 16 Aug 2018 14:51:54 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 861E81AD9B; Thu, 16 Aug 2018 14:51:54 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7GEpsY0026922; Thu, 16 Aug 2018 14:51:54 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7GEpsbS026921; Thu, 16 Aug 2018 14:51:54 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808161451.w7GEpsbS026921@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Thu, 16 Aug 2018 14:51:54 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52138 - head/en_US.ISO8859-1/books/developers-handbook/kernelbuild X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/developers-handbook/kernelbuild X-SVN-Commit-Revision: 52138 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Aug 2018 14:51:55 -0000 Author: bcr Date: Thu Aug 16 14:51:54 2018 New Revision: 52138 URL: https://svnweb.freebsd.org/changeset/doc/52138 Log: Wrap the last few remaining overlong lines in this file to make textproc/igor completely happy with it. Modified: head/en_US.ISO8859-1/books/developers-handbook/kernelbuild/chapter.xml Modified: head/en_US.ISO8859-1/books/developers-handbook/kernelbuild/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/developers-handbook/kernelbuild/chapter.xml Thu Aug 16 14:45:06 2018 (r52137) +++ head/en_US.ISO8859-1/books/developers-handbook/kernelbuild/chapter.xml Thu Aug 16 14:51:54 2018 (r52138) @@ -4,25 +4,28 @@ $FreeBSD$ --> - + Building and Installing a &os; Kernel Being a kernel developer requires understanding of the kernel build process. To debug the &os; kernel it is required to be able to build one. There are two known ways to do so: - The supported procedure to build and install a kernel - is documented in the - Building and - Installing a Custom Kernel chapter of the &os; - Handbook. + The supported procedure to build and install a kernel is + documented in the Building and + Installing a Custom Kernel chapter of the &os; + Handbook. It is supposed that the reader of this chapter is familiar - with the information described in the Building and - Installing a Custom Kernel chapter of the &os; - Handbook. If this is not the case, please read through the above - mentioned chapter to understand how the build process + with the information described in the Building + and Installing a Custom Kernel chapter of the &os; + Handbook. If this is not the case, please read through the + above mentioned chapter to understand how the build process works. From owner-svn-doc-head@freebsd.org Thu Aug 16 14:55:30 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 9EAFF1069CCB; Thu, 16 Aug 2018 14:55:30 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4EF0B8641D; Thu, 16 Aug 2018 14:55:30 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 0AC961AEE2; Thu, 16 Aug 2018 14:55:30 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7GEtTXT029502; Thu, 16 Aug 2018 14:55:29 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7GEtTT9029501; Thu, 16 Aug 2018 14:55:29 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808161455.w7GEtTT9029501@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Thu, 16 Aug 2018 14:55:29 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52139 - head/en_US.ISO8859-1/books/developers-handbook/testing X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/developers-handbook/testing X-SVN-Commit-Revision: 52139 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Aug 2018 14:55:31 -0000 Author: bcr Date: Thu Aug 16 14:55:29 2018 New Revision: 52139 URL: https://svnweb.freebsd.org/changeset/doc/52139 Log: Remove the last vestiges of overlong lines from this file to make textproc/igor shut up about them. Modified: head/en_US.ISO8859-1/books/developers-handbook/testing/chapter.xml Modified: head/en_US.ISO8859-1/books/developers-handbook/testing/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/developers-handbook/testing/chapter.xml Thu Aug 16 14:51:54 2018 (r52138) +++ head/en_US.ISO8859-1/books/developers-handbook/testing/chapter.xml Thu Aug 16 14:55:29 2018 (r52139) @@ -4,7 +4,9 @@ $FreeBSD$ --> - + Regression and Performance Testing Regression tests are used to exercise a particular bit of the @@ -12,7 +14,8 @@ old bugs are not reintroduced. The &os; regression testing tools can be found in the &os; - source tree in the directory src/tools/regression. + source tree in the directory + src/tools/regression.

Micro Benchmark Checklist @@ -140,7 +143,8 @@ drive algorithms. To get real stable clock, consider stabilized clock injection. E.g., get a OCXO + PLL, inject output into clock circuits instead of motherboard xtal. - Contact &a.phk.email; for more information about this. + Contact &a.phk.email; for more information about + this. @@ -244,10 +248,11 @@ - The scripts are maintained and were developed by &a.des.email;, - and are now written in Perl, a move on from their original - incarnation as shell scripts. All scripts and configuration - files are kept in /projects/tinderbox/. + The scripts are maintained and were developed by + &a.des.email;, and are now written in Perl, a move on from their + original incarnation as shell scripts. All scripts and + configuration files are kept in /projects/tinderbox/. For more information about the tinderbox and tbmaster scripts at this stage, see their respective man pages: @@ -412,8 +417,10 @@

Official Build Servers - The official Tinderbox build servers are hosted by Sentex Data - Communications, who also host the &os; + The official Tinderbox build servers are hosted by Sentex Data + Communications, who also host the &os; Netperf Cluster. Three build servers currently exist: @@ -462,7 +469,8 @@ Official Summary Site Summaries and logs from the official build servers are - available online at http://tinderbox.FreeBSD.org, + available online at http://tinderbox.FreeBSD.org, hosted by &a.des.email; and set up as follows: From owner-svn-doc-head@freebsd.org Thu Aug 16 15:34:24 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id C567F106B000; Thu, 16 Aug 2018 15:34:23 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 7936D88C80; Thu, 16 Aug 2018 15:34:23 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 5A3FB1B5AC; Thu, 16 Aug 2018 15:34:23 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7GFYNAN050733; Thu, 16 Aug 2018 15:34:23 GMT (envelope-from gjb@FreeBSD.org) Received: (from gjb@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7GFYNSR050732; Thu, 16 Aug 2018 15:34:23 GMT (envelope-from gjb@FreeBSD.org) Message-Id: <201808161534.w7GFYNSR050732@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: gjb set sender to gjb@FreeBSD.org using -f From: Glen Barber Date: Thu, 16 Aug 2018 15:34:23 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52140 - in head/en_US.ISO8859-1/htdocs/releases: 10.4R 11.2R X-SVN-Group: doc-head X-SVN-Commit-Author: gjb X-SVN-Commit-Paths: in head/en_US.ISO8859-1/htdocs/releases: 10.4R 11.2R X-SVN-Commit-Revision: 52140 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Aug 2018 15:34:24 -0000 Author: gjb Date: Thu Aug 16 15:34:22 2018 New Revision: 52140 URL: https://svnweb.freebsd.org/changeset/doc/52140 Log: Regen after r337910. Sponsored by: The FreeBSD Foundation Modified: head/en_US.ISO8859-1/htdocs/releases/10.4R/errata.html head/en_US.ISO8859-1/htdocs/releases/11.2R/errata.html Modified: head/en_US.ISO8859-1/htdocs/releases/10.4R/errata.html ============================================================================== --- head/en_US.ISO8859-1/htdocs/releases/10.4R/errata.html Thu Aug 16 14:55:29 2018 (r52139) +++ head/en_US.ISO8859-1/htdocs/releases/10.4R/errata.html Thu Aug 16 15:34:22 2018 (r52140) @@ -1,5 +1,5 @@ -FreeBSD 10.4-RELEASE Errata

FreeBSD 10.4-RELEASE Errata

The FreeBSD Project

FreeBSD 10.4-RELEASE Errata

The FreeBSD Project

FreeBSD is a registered trademark of the FreeBSD Foundation.

Intel, Celeron, Centrino, Core, EtherExpress, i386, i486, Itanium, Pentium, and Xeon are trademarks or registered @@ -41,7 +41,10 @@ use-after-free

FreeBSD-SA-18:02.ntp	07�March�2018	Multiple vulnerabilities
FreeBSD-SA-18:04.vt	04�April�2018	Fix vt(4) console memory disclosure
FreeBSD-SA-18:05.ipsec	04�April�2018	Fix denial of service
FreeBSD-SA-18:06.debugreg	08�May�2018	Mishandling of x86 debug exceptions
FreeBSD-SA-18:08.tcp	06�August�2018	Resource exhaustion in TCP - reassembly

3.�Errata Notices

Errata	Date	Topic
FreeBSD-EN-17:09.tzdata	2�November�2017	Timezone database information + reassembly
FreeBSD-SA-18:09.l1tf	14�August�2018	L1 Terminal Fault (L1TF) Kernel Information + Disclosure
FreeBSD-SA-18:10.ip	14�August�2018	Resource exhaustion in IP fragment + reassembly
FreeBSD-SA-18:11.hostapd	14�August�2018	Unauthenticated EAPOL-Key Decryption + Vulnerability

3.�Errata Notices

Errata

Date

Topic

FreeBSD-EN-17:09.tzdata

2�November�2017

Timezone database information update

FreeBSD-EN-18:01.tzdata

07�March�2018

Timezone database information update

FreeBSD-EN-18:02.file

07�March�2018

Stack-based buffer overflow

FreeBSD-EN-18:03.tzdata

04�April�2018

Update timezone database information

FreeBSD-EN-18:04.mem

04�April�2018

Multiple small kernel memory Modified: head/en_US.ISO8859-1/htdocs/releases/11.2R/errata.html ============================================================================== --- head/en_US.ISO8859-1/htdocs/releases/11.2R/errata.html Thu Aug 16 14:55:29 2018 (r52139) +++ head/en_US.ISO8859-1/htdocs/releases/11.2R/errata.html Thu Aug 16 15:34:22 2018 (r52140) @@ -35,7 +35,10 @@ sites which keep up-to-date mirrors of this location.

Source and binary snapshots of FreeBSD 11.2-STABLE also contain up-to-date copies of this document (as of the time of the snapshot).

For a list of all FreeBSD CERT security advisories, see https://www.FreeBSD.org/security/.

2.�Security Advisories

Advisory	Date	Topic
FreeBSD-SA-18:08.tcp	06�August�2018	Resource exhaustion in TCP - reassembly

3.�Errata Notices

Errata	Date	Topic
No erratas	�	�

4.�Open Issues

FreeBSD/i386 installed on ZFS may crash during boot + reassembly

FreeBSD-SA-18:09.l1tf

14�August�2018

L1 Terminal Fault (L1TF) Kernel Information + Disclosure

FreeBSD-SA-18:10.ip

14�August�2018

Resource exhaustion in IP fragment + reassembly

FreeBSD-SA-18:11.hostapd

14�August�2018

Unauthenticated EAPOL-Key Decryption + Vulnerability

3.�Errata Notices

Errata	Date	Topic
No erratas	�	�

4.�Open Issues

FreeBSD/i386 installed on ZFS may crash during boot when the ZFS pool mount is attempted while booting an unmodified GENERIC kernel.
A system tunable has been added as of revision r286584 to make the From owner-svn-doc-head@freebsd.org Thu Aug 16 15:59:01 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id D3736106BD56; Thu, 16 Aug 2018 15:59:00 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 8994D89CE7; Thu, 16 Aug 2018 15:59:00 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4FE5A1B8E4; Thu, 16 Aug 2018 15:59:00 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7GFx0fZ061549; Thu, 16 Aug 2018 15:59:00 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7GFx0HP061548; Thu, 16 Aug 2018 15:59:00 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808161559.w7GFx0HP061548@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Thu, 16 Aug 2018 15:59:00 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52141 - head/en_US.ISO8859-1/books/developers-handbook/tools X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/developers-handbook/tools X-SVN-Commit-Revision: 52141 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Aug 2018 15:59:01 -0000 Author: bcr Date: Thu Aug 16 15:59:00 2018 New Revision: 52141 URL: https://svnweb.freebsd.org/changeset/doc/52141 Log: Cleanup this file: - wrap overlong lines - proper indentation of elements - capitalization in title tags Modified: head/en_US.ISO8859-1/books/developers-handbook/tools/chapter.xml Modified: head/en_US.ISO8859-1/books/developers-handbook/tools/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/developers-handbook/tools/chapter.xml Thu Aug 16 15:34:22 2018 (r52140) +++ head/en_US.ISO8859-1/books/developers-handbook/tools/chapter.xml Thu Aug 16 15:59:00 2018 (r52141) @@ -4,16 +4,31 @@ $FreeBSD$ --> - - Programming Tools + + + Programming Tools + - JamesRaynardContributed by - MurrayStokely + + + James + Raynard + + Contributed by + + + + Murray + Stokely + + - - Synopsis + + Synopsis This chapter is an introduction to using some of the programming tools supplied with FreeBSD, although much of it @@ -22,24 +37,24 @@ detail. Most of the chapter assumes little or no previous programming knowledge, although it is hoped that most programmers will find something of value in it. - - Introduction + + Introduction FreeBSD offers an excellent development environment. - Compilers for C and C++ and an assembler come with the - basic system, not to mention classic &unix; - tools such as sed and awk. - If that is not enough, there are many more compilers and - interpreters in the Ports collection. The following section, - Introduction to Programming, - lists some of the available options. FreeBSD is very - compatible with standards such as &posix; and - ANSI C, as well with its own BSD heritage, so - it is possible to write applications that will compile and run - with little or no modification on a wide range of - platforms. + Compilers for C and C++ and an assembler come with the basic + system, not to mention classic &unix; tools such as + sed and awk. If that is + not enough, there are many more compilers and interpreters in + the Ports collection. The following section, Introduction to + Programming, lists some of the available options. + FreeBSD is very compatible with standards such as + &posix; and ANSI C, as + well with its own BSD heritage, so it is possible to write + applications that will compile and run with little or no + modification on a wide range of platforms. However, all this power can be rather overwhelming at first if you have never written programs on a &unix; platform before. @@ -95,26 +110,26 @@ start if you have not done any programming before. This kind of environment is typically found with languages like Lisp, Smalltalk, Perl and Basic. It could also be argued that the - &unix; shell (sh, csh) is itself an - interpreter, and many people do in fact write shell - scripts to help with various - housekeeping tasks on their machine. Indeed, part - of the original &unix; philosophy was to provide lots of small - utility programs that could be linked together in shell + &unix; shell (sh, csh) + is itself an interpreter, and many people do in fact write + shell scripts to help with various + housekeeping tasks on their machine. Indeed, + part of the original &unix; philosophy was to provide lots of + small utility programs that could be linked together in shell scripts to perform useful tasks. - Interpreters available with FreeBSD + Interpreters Available with FreeBSD - Here is a list of interpreters that are available from - the &os; Ports Collection, with a brief discussion of - some of the more popular interpreted languages. + Here is a list of interpreters that are available from the + &os; Ports Collection, with a brief discussion of some of the + more popular interpreted languages. - Instructions on how to get and install applications - from the Ports Collection can be found in the - - Ports section of the handbook. + Instructions on how to get and install applications from + the Ports Collection can be found in the Ports + section of the handbook. @@ -126,14 +141,13 @@ University students to program and provided with every self-respecting personal computer in the 1980s, BASIC has been the first programming - language for many programmers. It is also the foundation - for Visual Basic. + language for many programmers. It is also the + foundation for Visual Basic. The Bywater Basic Interpreter can be found in the - Ports Collection as - lang/bwbasic - and the Phil Cockroft's Basic Interpreter - (formerly Rabbit Basic) is available as + Ports Collection as lang/bwbasic and + the Phil Cockroft's Basic Interpreter (formerly Rabbit + Basic) is available as lang/pbasic. @@ -153,16 +167,16 @@ Lisp is an extremely powerful and sophisticated language, but can be rather large and unwieldy. - Various implementations of Lisp that can run on &unix; - systems are available in the Ports Collection for &os;. - GNU Common Lisp can be found as - lang/gcl. CLISP - by Bruno Haible and Michael Stoll is available as - lang/clisp. - For CMUCL, which includes a highly-optimizing compiler too, or - simpler Lisp implementations like SLisp, which implements most - of the Common Lisp constructs in a few hundred lines of C code, - lang/cmucl and + Various implementations of Lisp that can run on + &unix; systems are available in the Ports Collection for + &os;. GNU Common Lisp can be found as + lang/gcl. CLISP by Bruno Haible and + Michael Stoll is available as + lang/clisp. For CMUCL, which + includes a highly-optimizing compiler too, or simpler + Lisp implementations like SLisp, which implements most + of the Common Lisp constructs in a few hundred lines of + C code, lang/cmucl and lang/slisp are available respectively. @@ -221,11 +235,12 @@ Logo is a language that is easy to learn, and has been used as an introductory programming language in various courses. It is an excellent tool to work with - when teaching programming to smaller age groups, as it makes - creation of elaborate geometric shapes an easy task. + when teaching programming to smaller age groups, as it + makes creation of elaborate geometric shapes an easy + task. - The latest version of Logo for &os; is available from - the Ports Collection in + The latest version of Logo for &os; is available + from the Ports Collection in lang/logo. @@ -239,8 +254,9 @@ to start programming with, since it is relatively easy to start with, but is not limited in comparison to other popular interpreted languages that are used for the - development of large, complex applications (Perl and - Tcl are two other languages that are popular for such tasks). + development of large, complex applications (Perl and Tcl + are two other languages that are popular for such + tasks). The latest version of Python is available from the Ports Collection in @@ -252,11 +268,11 @@ Ruby - Ruby is an interpreter, pure object-oriented programming - language. It has become widely popular because of its easy - to understand syntax, flexibility when writing code, and the - ability to easily develop and maintain large, complex - programs. + Ruby is an interpreter, pure object-oriented + programming language. It has become widely popular + because of its easy to understand syntax, flexibility + when writing code, and the ability to easily develop and + maintain large, complex programs. Ruby is available from the Ports Collection as lang/ruby25. @@ -268,14 +284,14 @@ Tcl is an embeddable, interpreted language, that has - become widely used and became popular mostly because of its portability to many - platforms. It can be used both for quickly writing - small, prototype applications, or (when combined with - Tk, a GUI toolkit) fully-fledged, featureful - programs. + become widely used and became popular mostly because of + its portability to many platforms. It can be used both + for quickly writing small, prototype applications, or + (when combined with Tk, a GUI toolkit) fully-fledged, + featureful programs. - Various versions of Tcl are available as ports - for &os;. The latest version, Tcl 8.5, can be found in + Various versions of Tcl are available as ports for + &os;. The latest version, Tcl 8.5, can be found in lang/tcl87. @@ -291,13 +307,9 @@ not compile, grit your teeth and go back to the editor; if it did compile and gave you a program, you can run it either at a shell command prompt or in a debugger to see if it works - properly. + properly.If you run it in the shell, you may + get a core dump. - - If you run it in the shell, you may get a core - dump. - - Obviously, this is not quite as direct as using an interpreter. However it allows you to do a lot of things which are very difficult or even impossible with an @@ -315,11 +327,11 @@ using separate programs, many commercial compiler makers have produced Integrated Development Environments (IDEs for short). FreeBSD does not include - an IDE in the base system, but devel/kdevelop is - available in the Ports Collection and many use - Emacs for this purpose. Using - Emacs as an IDE is discussed in - . + an IDE in the base system, but + devel/kdevelop is available in the Ports + Collection and many use Emacs for + this purpose. Using Emacs as an + IDE is discussed in . @@ -331,11 +343,10 @@ and clang compilers for C and C++, since they come with the &os; base system. Starting with &os; 10.X clang is installed as - cc. The - details of producing a program with an interpreter vary - considerably between interpreters, and are usually well covered - in the documentation and on-line help for the - interpreter. + cc. The details of producing a program with + an interpreter vary considerably between interpreters, and are + usually well covered in the documentation and on-line help for + the interpreter. Once you have written your masterpiece, the next step is to convert it into something that will (hopefully!) run on FreeBSD. @@ -390,21 +401,22 @@ - The word compiling is often used to refer to - just steps 1 to 4—the others are referred to as - linking. Sometimes step 1 is referred to as - pre-processing and steps 3-4 as + The word compiling is often used to + refer to just steps 1 to 4—the others are referred to as + linking. Sometimes step 1 is referred to + as pre-processing and steps 3-4 as assembling. Fortunately, almost all this detail is hidden from you, as - cc is a front end that manages calling all these - programs with the right arguments for you; simply typing + cc is a front end that manages calling all + these programs with the right arguments for you; simply + typing &prompt.user; cc foobar.c - will cause foobar.c to be compiled by all the - steps above. If you have more than one file to compile, just do - something like + will cause foobar.c to be compiled by + all the steps above. If you have more than one file to compile, + just do something like &prompt.user; cc foo.c bar.c @@ -412,32 +424,28 @@ the syntax. It will not check for any logical mistakes you may have made, like putting the program into an infinite loop, or using a bubble sort when you meant to use a binary - sort. + sort.In case you did not know, a binary sort is + an efficient way of sorting things into order and a bubble + sort is not. - - In case you did not know, a binary sort is an efficient - way of sorting things into order and a bubble sort - is not. - + There are lots and lots of options for + cc, which are all in the manual page. Here + are a few of the most important ones, with examples of how to + use them. - There are lots and lots of options for cc, which - are all in the manual page. Here are a few of the most important - ones, with examples of how to use them. - - + + + The output name of the file. If you do not use this - option, cc will produce an executable called - a.out. + option, cc will produce an executable + called a.out.The + reasons for this are buried in the mists of + history. - - The reasons for this are buried in the mists of - history. - - &prompt.user; cc foobar.c executable is a.out &prompt.user; cc -o foobar foobar.c executable is foobar @@ -457,9 +465,10 @@ &prompt.user; cc -c foobar.c - This will produce an object file (not an - executable) called foobar.o. This - can be linked together with other object files into an + This will produce an object + file (not an executable) called + foobar.o. This can be linked + together with other object files into an executable. @@ -471,14 +480,15 @@ Create a debug version of the executable. This makes the compiler put information into the executable about which line of which source file corresponds to which - function call. A debugger can use this information to show - the source code as you step through the program, which is - very useful; the disadvantage is that - all this extra information makes the program much bigger. - Normally, you compile with while you - are developing a program and then compile a release - version without when you are - satisfied it works properly. + function call. A debugger can use this information to + show the source code as you step through the program, + which is very useful; the + disadvantage is that all this extra information makes the + program much bigger. Normally, you compile with + while you are developing a program and + then compile a release version without + when you are satisfied it works + properly. &prompt.user; cc -g foobar.c @@ -493,8 +503,7 @@ executable called a.out. Producing a debug version called foobar is left as an exercise for - the reader! - + the reader! @@ -586,7 +595,8 @@ - Specify a function library to be used at link time. + Specify a function library to be used at link + time. The most common example of this is when compiling a program that uses some of the mathematical functions in C. @@ -613,8 +623,8 @@ foobar. If you are compiling C++ code, use - c++. c++ can also be - invoked as clang++ on &os;. + c++. c++ can also + be invoked as clang++ on &os;. &prompt.user; c++ -o foobar foobar.cc @@ -669,8 +679,7 @@ int main() { f = pow(2.1, 6); printf("2.1 ^ 6 = %f\n", f); return 0; -} - +} and I compiled it as: @@ -717,8 +726,7 @@ int main() { #include <stdio.h> int main() { -... - +... After recompiling it as you did before, run @@ -740,8 +748,8 @@ int main() { I compiled a file called foobar.c and I cannot find an - executable called foobar. Where has - it gone? + executable called foobar. Where + has it gone? @@ -768,12 +776,11 @@ int main() { - Unlike &ms-dos;, &unix; does not - look in the current directory when it is trying to find - out which executable you want it to run, unless you tell - it to. Type ./foobar, which - means run the file called - foobar in the current + Unlike &ms-dos;, &unix; does not look in the current + directory when it is trying to find out which executable + you want it to run, unless you tell it to. Type + ./foobar, which means run the + file called foobar in the current directory. @@ -803,8 +810,8 @@ int main() { I compiled my program and it seemed to run all right at first, then there was an error and it said something - about core dumped. What does that - mean? + about core dumped. What does + that mean? @@ -851,8 +858,7 @@ int main() { pointer, eg char *foo = NULL; -strcpy(foo, "bang!"); - +strcpy(foo, "bang!"); @@ -860,12 +866,11 @@ strcpy(foo, "bang!"); eg char *foo; -strcpy(foo, "bang!"); - +strcpy(foo, "bang!"); The pointer will have some random value that, - with luck, will point into an area of memory that - is not available to your program and the kernel will + with luck, will point into an area of memory that is + not available to your program and the kernel will kill your program before it can do any damage. If you are unlucky, it will point somewhere inside your own program and corrupt one of your data structures, @@ -877,8 +882,7 @@ strcpy(foo, "bang!"); eg int bar[20]; -bar[27] = 6; - +bar[27] = 6; @@ -886,8 +890,7 @@ bar[27] = 6; eg char *foo = "My string"; -strcpy(foo, "bang!"); - +strcpy(foo, "bang!"); &unix; compilers often put string literals like "My string" into read-only areas @@ -900,15 +903,13 @@ strcpy(foo, "bang!"); free(), eg char bar[80]; -free(bar); - +free(bar); or char *foo = malloc(27); free(foo); -free(foo); - +free(foo); @@ -966,14 +967,14 @@ free(foo); Alternatively, you can create a core dump from inside your program, by calling the - abort() function. See the manual page - of &man.abort.3; to learn more. + abort() function. See the manual + page of &man.abort.3; to learn more. - If you want to create a core dump from outside your - program, but do not want the process to terminate, you - can use the gcore program. See the - manual page of &man.gcore.1; for more information. - + If you want to create a core dump from outside your + program, but do not want the process to terminate, you + can use the gcore program. See the + manual page of &man.gcore.1; for more + information. @@ -1001,8 +1002,8 @@ free(foo); &prompt.user; cc file1.o file2.o … file37.c … - if we had changed file37.c, but not any - of the others, since the last time we compiled. This may + if we had changed file37.c, but not + any of the others, since the last time we compiled. This may speed up the compilation quite a bit, but does not solve the typing problem. @@ -1039,17 +1040,14 @@ free(foo); or MAKEFILE. Most programmers use the name Makefile, as this puts it near the top of a directory listing, where it can easily be - seen. - - - They do not use the MAKEFILE form - as block capitals are often used for documentation files - like README. - + seen.They do not use the + MAKEFILE form as block capitals are + often used for documentation files like + README. - Example of using <command>make</command> + Example of Using <command>make</command> Here is a very simple make file: @@ -1073,12 +1071,12 @@ free(foo); re-compiled. The creation line starts with a tab (press - the tab key) and then the command you would - type to create foo if you were doing it - at a command prompt. If foo is out of - date, or does not exist, make then executes - this command to create it. In other words, this is the rule - which tells make how to re-compile + tab) and then the command you would type to + create foo if you were doing it at a + command prompt. If foo is out of date, + or does not exist, make then executes this + command to create it. In other words, this is the rule which + tells make how to re-compile foo.c. So, when you type make, it will @@ -1091,8 +1089,8 @@ free(foo); world in the appropriate directory! Another useful property of makefiles is that the targets - do not have to be programs. For instance, we could have a make - file that looks like this: + do not have to be programs. For instance, we could have a + make file that looks like this: foo: foo.c cc -o foo foo.c @@ -1108,7 +1106,8 @@ install: make will then only look at that target and ignore any others. For example, if we type make foo with the makefile above, make - will ignore the install target. + will ignore the install + target. If we just type make on its own, make will always look at the first target and then stop @@ -1116,36 +1115,36 @@ install: make here, it will just go to the foo target, re-compile foo if necessary, and then stop without - going on to the install target. + going on to the install + target. - Notice that the install target does not - actually depend on anything! This means that the command on - the following line is always executed when we try to make that - target by typing make install. In this - case, it will copy foo into the user's - home directory. This is often used by application makefiles, - so that the application can be installed in the correct - directory when it has been correctly compiled. + Notice that the install target + does not actually depend on anything! This means that the + command on the following line is always executed when we try + to make that target by typing make + install. In this case, it will copy + foo into the user's home directory. This + is often used by application makefiles, so that the + application can be installed in the correct directory when it + has been correctly compiled. This is a slightly confusing subject to try to explain. If you do not quite understand how make works, the best thing to do is to write a simple program like hello world and a make file like the one above and experiment. Then progress to using more than one source - file, or having the source file include a header file. The - touch command is very useful here—it - changes the date on a file without you having to edit - it. + file, or having the source file include a header file. + touch is very useful here—it changes + the date on a file without you having to edit it. Make and include-files C code often starts with a list of files to include, for - example stdio.h. Some of these files are system-include + example stdio.h. Some of these files are system-include files, some of them are from the project you are now working - on: - + on: #include <stdio.h> #include "foo.h" @@ -1153,20 +1152,19 @@ install: int main(.... To make sure that this file is recompiled the moment - foo.h is changed, you have to add it in - your Makefile: + foo.h is changed, you have to add it in + your Makefile: foo: foo.c foo.h The moment your project is getting bigger and you have - more and more own include-files to maintain, it will be a - pain to keep track of all include files and the files which - are depending on it. If you change an include-file but - forget to recompile all the files which are depending on - it, the results will be devastating. clang - has an option to analyze your files and to produce a list - of include-files and their dependencies: . - + more and more own include-files to maintain, it will be a pain + to keep track of all include files and the files which are + depending on it. If you change an include-file but forget to + recompile all the files which are depending on it, the results + will be devastating. clang has an option + to analyze your files and to produce a list of include-files + and their dependencies: . If you add this to your Makefile: @@ -1179,22 +1177,23 @@ int main(.... foo.o: foo.c foo.h - If you change foo.h, next time - you run make all files depending on + If you change foo.h, next time you + run make all files depending on foo.h will be recompiled. Do not forget to run make depend each - time you add an include-file to one of your files. + time you add an include-file to one of your files. FreeBSD Makefiles - Makefiles can be rather complicated to write. Fortunately, - BSD-based systems like FreeBSD come with some very powerful - ones as part of the system. One very good example of this is - the FreeBSD ports system. Here is the essential part of a - typical ports Makefile: + Makefiles can be rather complicated to write. + Fortunately, BSD-based systems like FreeBSD come with some + very powerful ones as part of the system. One very good + example of this is the FreeBSD ports system. Here is the + essential part of a typical ports + Makefile: MASTER_SITES= ftp://freefall.cdrom.com/pub/FreeBSD/LOCAL_PORTS/ DISTFILES= scheme-microcode+dist-7.3-freebsd.tgz @@ -1232,9 +1231,9 @@ DISTFILES= scheme-microcode+dist-7.3-freebsd.tgz Any special configuration needed for the source is done. (Many &unix; program distributions try to work out - which version of &unix; they are being compiled on and which - optional &unix; features are present—this is where - they are given the information in the FreeBSD ports + which version of &unix; they are being compiled on and + which optional &unix; features are present—this is + where they are given the information in the FreeBSD ports scenario). @@ -1271,16 +1270,16 @@ DISTFILES= scheme-microcode+dist-7.3-freebsd.tgz any errors that may occur) and anyone can get access to that just by putting a single line in their own make file! - If you want to have a look at these system makefiles, - they are in /usr/share/mk, but it is - probably best to wait until you have had a bit of practice with + If you want to have a look at these system makefiles, they + are in /usr/share/mk, but it is probably + best to wait until you have had a bit of practice with makefiles, as they are very complicated (and if you do look at them, make sure you have a flask of strong coffee handy!) - More advanced uses of <command>make</command> + More Advanced Uses of <command>make</command> Make is a very powerful tool, and can do much more than the simple example above shows. @@ -1307,8 +1306,8 @@ DISTFILES= scheme-microcode+dist-7.3-freebsd.tgz available as a port and package in its own right. To view the info pages for GNU - make, you will have to edit the - dir file in the + make, you will have to edit + dir in the /usr/local/info directory to add an entry for it. This involves adding a line like @@ -1344,10 +1343,10 @@ DISTFILES= scheme-microcode+dist-7.3-freebsd.tgz program a line at a time, inspect the value of variables, change them, tell the debugger to run up to a certain point and then stop, and so on. You can even attach to a program - that is already running, or load a core file to investigate why - the program crashed. It is even possible to debug the kernel, - though that is a little trickier than the user applications - we will be discussing in this section. + that is already running, or load a core file to investigate + why the program crashed. It is even possible to debug the + kernel, though that is a little trickier than the user + applications we will be discussing in this section. gdb has quite good on-line help, as well as a set of info pages, so this section will concentrate @@ -1364,19 +1363,18 @@ DISTFILES= scheme-microcode+dist-7.3-freebsd.tgz - Running a program in the debugger + Running a Program in the Debugger - You will need to have compiled the program with the - option to get the most out of using - gdb. It will work without, but you will only - see the name of the function you are in, instead of the source - code. If you see a line like: + You will need to have compiled the program with + to get the most out of using + gdb. It will work without, but you will + only see the name of the function you are in, instead of the + source code. If you see a line like: … (no debugging symbols found) … when gdb starts up, you will know that - the program was not compiled with the - option. + the program was not compiled with . At the gdb prompt, type break main. This will tell the @@ -1392,10 +1390,10 @@ DISTFILES= scheme-microcode+dist-7.3-freebsd.tgz You can now step through the program, a line at a time, by pressing n. If you get to a function call, you can step into it by pressing s. Once - you are in a function call, you can return from stepping into a - function call by pressing f. You can also - use up and down to take - a quick look at the caller. + you are in a function call, you can return from stepping into + a function call by pressing f. You can + also use up and down to + take a quick look at the caller. Here is a simple example of how to spot a mistake in a program with gdb. This is our program @@ -1452,7 +1450,7 @@ bazz (anint=4231) at temp.c:17 gdb d Hang on a minute! How did anint get to be 4231? Did we not we set it to be - 5 in main()? Let's + 5 in main()? Let us move up to main() and have a look. (gdb) up Move up call stack @@ -1491,7 +1489,7 @@ main() { - Examining a core file + Examining a Core File A core file is basically a file which contains the complete state of the process when it crashed. In the @@ -1499,9 +1497,9 @@ main() { listings of core files and sweat over machine code manuals, but now life is a bit easier. Incidentally, under FreeBSD and other 4.4BSD systems, a core file is called - progname.core instead of just - core, to make it clearer which program a - core file belongs to. + progname.core + instead of just core, to make it clearer + which program a core file belongs to. To examine a core file, start up gdb in the usual way. Instead of typing break or @@ -1509,9 +1507,9 @@ main() { (gdb) core progname.core - If you are not in the same directory as the core file, - you will have to do dir - /path/to/core/file first. + If you are not in the same directory as the core file, you + will have to do dir /path/to/core/file + first. You should see something like this: @@ -1534,11 +1532,11 @@ Cannot access memory at address 0x7020796d. available to it in a function called bazz. - Sometimes it is useful to be able to see how a function was - called, as the problem could have occurred a long way up the - call stack in a complex program. The bt - command causes gdb to print out a - back-trace of the call stack: + Sometimes it is useful to be able to see how a function + was called, as the problem could have occurred a long way up + the call stack in a complex program. bt + causes gdb to print out a back-trace of the + call stack: (gdb) bt #0 0x164a in bazz (anint=0x5) at temp.c:17 @@ -1552,14 +1550,14 @@ Cannot access memory at address 0x7020796d. - Attaching to a running program + Attaching to a Running Program One of the neatest features about gdb - is that it can attach to a program that is already running. Of - course, that assumes you have sufficient permissions to do so. - A common problem is when you are stepping through a program - that forks, and you want to trace the child, but the debugger - will only let you trace the parent. + is that it can attach to a program that is already running. + Of course, that assumes you have sufficient permissions to do + so. A common problem is when you are stepping through a + program that forks, and you want to trace the child, but the + debugger will only let you trace the parent. What you do is start up another gdb, use ps to find the process ID for the @@ -1659,14 +1657,13 @@ else if (pid == 0) { /* child */ the editors/emacs port. - Once it is installed, start it up and do C-h - t to read an Emacs tutorial—that means - hold down the control key, press - h, let go of the control - key, and then press t. (Alternatively, you - can use the mouse to select Emacs - Tutorial from the Help - menu.) + Once it is installed, start it up and do C-h + t to read an Emacs tutorial—that means hold + down control, press h, let + go of control, and then press + t. (Alternatively, you can use the mouse to + select Emacs Tutorial from the + Help menu.) Although Emacs does have menus, it is well worth learning the key bindings, as it is much quicker when you are editing @@ -1686,7 +1683,7 @@ else if (pid == 0) { /* child */ doing C-x C-f. When you are happy with that, move on to another menu command. - If you can not remember what a particular combination of + If you cannot remember what a particular combination of keys does, select Describe Key from the Help menu and type it in—Emacs will tell you what it does. You can also use the @@ -1707,11 +1704,11 @@ else if (pid == 0) { /* child */ return again. Emacs will then do the search-and-replace operation you have just requested. - If you are wondering what on earth the - Meta key is, it is a special key that many - &unix; workstations have. Unfortunately, PC's do not have one, - so it is usually the alt key (or if you are - unlucky, the escape key). + If you are wondering what on earth Meta + is, it is a special key that many &unix; workstations have. + Unfortunately, PC's do not have one, so it is usually + alt (or if you are unlucky, the + escape key). Oh, and to get out of Emacs, do C-x C-c (that means hold down the control key, press @@ -1739,20 +1736,20 @@ else if (pid == 0) { /* child */ *** DIFF OUTPUT TRUNCATED AT 1000 LINES *** From owner-svn-doc-head@freebsd.org Thu Aug 16 16:43:19 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 2DCE9106DC98; Thu, 16 Aug 2018 16:43:19 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id D91648C98B; Thu, 16 Aug 2018 16:43:18 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id BA1251C12B; Thu, 16 Aug 2018 16:43:18 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7GGhIVA088175; Thu, 16 Aug 2018 16:43:18 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7GGhIPE088174; Thu, 16 Aug 2018 16:43:18 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808161643.w7GGhIPE088174@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Thu, 16 Aug 2018 16:43:18 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52142 - head/en_US.ISO8859-1/articles/linux-users X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/articles/linux-users X-SVN-Commit-Revision: 52142 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Aug 2018 16:43:19 -0000 Author: bcr Date: Thu Aug 16 16:43:18 2018 New Revision: 52142 URL: https://svnweb.freebsd.org/changeset/doc/52142 Log: Cleanup overlong lines in this file. Modified: head/en_US.ISO8859-1/articles/linux-users/article.xml Modified: head/en_US.ISO8859-1/articles/linux-users/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/linux-users/article.xml Thu Aug 16 15:59:00 2018 (r52141) +++ head/en_US.ISO8859-1/articles/linux-users/article.xml Thu Aug 16 16:43:18 2018 (r52142) @@ -1,8 +1,9 @@ -
- +
FreeBSD Quickstart Guide for &linux; Users @@ -55,24 +56,25 @@ &linux; users are often surprised to find that Bash is not the default shell in &os;. In fact, Bash is not included - in the default installation. Instead, &os; uses &man.tcsh.1; - as the default root shell, and the Bourne - shell-compatible &man.sh.1; as the default user - shell. &man.sh.1; is very similar to Bash - but with a much smaller feature-set. Generally shell scripts - written for &man.sh.1; will run in Bash, - but the reverse is not always true. + in the default installation. Instead, &os; uses &man.tcsh.1; as + the default root shell, and the Bourne + shell-compatible &man.sh.1; as the default user + shell. &man.sh.1; is very similar to + Bash but with a much smaller + feature-set. Generally shell scripts written for &man.sh.1; + will run in Bash, but the reverse is + not always true. However, Bash and other shells are available for installation using the &os; Packages - and Ports Collection. + xlink:href="&url.base;/doc/en_US.ISO8859-1/books/handbook/ports.html">Packages + and Ports Collection. - After installing another shell, use &man.chsh.1; to change - a user's default shell. It is recommended that the - root user's default - shell remain unchanged since shells which are not included in - the base distribution are installed to + After installing another shell, use &man.chsh.1; to change a + user's default shell. It is recommended that the root user's default shell remain + unchanged since shells which are not included in the base + distribution are installed to /usr/local/bin. In the event of a problem, the file system where /usr/local/bin is located may not be mounted. In this case, Some common command equivalents are as follows: - - + @@ -447,16 +448,22 @@ net.inet.ip.forwarding: 0 - yum install package / - apt-get install package - pkg install package + yum install + package / + apt-get install + package + pkg install + package Install package from remote repository - rpm -ivh package - / dpkg -i package - pkg add package + rpm -ivh + package / + dpkg -i + package + pkg add + package Install local package From owner-svn-doc-head@freebsd.org Thu Aug 16 18:08:49 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id D67351071354; Thu, 16 Aug 2018 18:08:48 +0000 (UTC) (envelope-from bhd@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 82BC570D84; Thu, 16 Aug 2018 18:08:48 +0000 (UTC) (envelope-from bhd@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 54EB61CE72; Thu, 16 Aug 2018 18:08:48 +0000 (UTC) (envelope-from bhd@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7GI8mnO029518; Thu, 16 Aug 2018 18:08:48 GMT (envelope-from bhd@FreeBSD.org) Received: (from bhd@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7GI8lOA029510; Thu, 16 Aug 2018 18:08:47 GMT (envelope-from bhd@FreeBSD.org) Message-Id: <201808161808.w7GI8lOA029510@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bhd set sender to bhd@FreeBSD.org using -f From: Bjoern Heidotting Date: Thu, 16 Aug 2018 18:08:47 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52143 - in head/de_DE.ISO8859-1/books/handbook: . disks usb-device-mode X-SVN-Group: doc-head X-SVN-Commit-Author: bhd X-SVN-Commit-Paths: in head/de_DE.ISO8859-1/books/handbook: . disks usb-device-mode X-SVN-Commit-Revision: 52143 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Aug 2018 18:08:49 -0000 Author: bhd Date: Thu Aug 16 18:08:47 2018 New Revision: 52143 URL: https://svnweb.freebsd.org/changeset/doc/52143 Log: Update to rr51744: Introduce a new chapter on USB Device Mode / USB OTG. (german translation) Reviewed by: bcr Differential Revision: https://reviews.freebsd.org/D16445 Added: head/de_DE.ISO8859-1/books/handbook/usb-device-mode/ head/de_DE.ISO8859-1/books/handbook/usb-device-mode/chapter.xml (contents, props changed) Modified: head/de_DE.ISO8859-1/books/handbook/Makefile head/de_DE.ISO8859-1/books/handbook/book.xml head/de_DE.ISO8859-1/books/handbook/chapters.ent head/de_DE.ISO8859-1/books/handbook/disks/chapter.xml Modified: head/de_DE.ISO8859-1/books/handbook/Makefile ============================================================================== --- head/de_DE.ISO8859-1/books/handbook/Makefile Thu Aug 16 16:43:18 2018 (r52142) +++ head/de_DE.ISO8859-1/books/handbook/Makefile Thu Aug 16 18:08:47 2018 (r52143) @@ -1,7 +1,7 @@ # # $FreeBSD$ # $FreeBSDde: de-docproj/books/handbook/Makefile,v 1.67 2011/12/31 12:27:25 bcr Exp $ -# basiert auf: r47275 +# basiert auf: r51744 # # Build the FreeBSD Handbook in its German translation. # @@ -202,6 +202,7 @@ SRCS+= preface/preface.xml SRCS+= printing/chapter.xml SRCS+= security/chapter.xml SRCS+= serialcomms/chapter.xml +SRCS+= usb-device-mode/chapter.xml SRCS+= virtualization/chapter.xml SRCS+= x11/chapter.xml Modified: head/de_DE.ISO8859-1/books/handbook/book.xml ============================================================================== --- head/de_DE.ISO8859-1/books/handbook/book.xml Thu Aug 16 16:43:18 2018 (r52142) +++ head/de_DE.ISO8859-1/books/handbook/book.xml Thu Aug 16 18:08:47 2018 (r52143) @@ -7,7 +7,7 @@ $FreeBSD$ $FreeBSDde: de-docproj/books/handbook/book.xml,v 1.91 2012/03/27 19:32:11 bcr Exp $ - basiert auf: r51568 + basiert auf: r51744 --> %chapters; %txtfiles; @@ -266,6 +266,7 @@ &chap.l10n; &chap.cutting-edge; &chap.dtrace; + &chap.usb-device-mode; Modified: head/de_DE.ISO8859-1/books/handbook/chapters.ent ============================================================================== --- head/de_DE.ISO8859-1/books/handbook/chapters.ent Thu Aug 16 16:43:18 2018 (r52142) +++ head/de_DE.ISO8859-1/books/handbook/chapters.ent Thu Aug 16 18:08:47 2018 (r52143) @@ -10,7 +10,7 @@ $FreeBSD$ $FreeBSDde: de-docproj/books/handbook/chapters.ent,v 1.34 2011/10/08 16:47:33 jkois Exp $ - basiert auf: r47275 + basiert auf: r51744 --> @@ -47,6 +47,7 @@ + Modified: head/de_DE.ISO8859-1/books/handbook/disks/chapter.xml ============================================================================== --- head/de_DE.ISO8859-1/books/handbook/disks/chapter.xml Thu Aug 16 16:43:18 2018 (r52142) +++ head/de_DE.ISO8859-1/books/handbook/disks/chapter.xml Thu Aug 16 18:08:47 2018 (r52143) @@ -650,140 +650,6 @@ da0: <STECH Simple Drive 1.04> s/n WD-WXE508CAN2 Laufwerken und iSCSI-LUNs. - - - <acronym>USB</acronym>-Massenspeicher - - - Der &man.cfumass.4;-Treiber ist ein - USB Ger�te-Modus-Treiber und steht mit - &os; 12.0 zur Verf�gung. - - - Auf - USB-OTG-kompatibler - Hardware, wie in eingebetteten Systemen, kann der &os; - USB-Stack im Ger�te-Modus laufen. Der - Ger�te-Modus erm�glicht es dem Rechner, verschiedene Arten von - USB-Ger�teklassen zu pr�sentieren, - einschlie�lich serieller Schnittstellen, Netzwerkadapter und - Massenspeicher. Ein USB-Host, - beispielsweise ein Laptop oder Desktop-Rechner, kann darauf - wie auf ein physikalisches USB-Ger�t - zugreifen. - - Je nach angeschlossener Hardware, erm�glicht das - &man.usb.template.4; Kernelmodul es dem - USB-Stack, automatisch zwischen Host- und - Ger�teseite umzuschalten. Das Anschlie�en eines - USB-Ger�tes an den - USB-OTG-Port bewirkt, - dass &os; in den Ger�te-Modus wechselt. - - Was &os; dem USB-Host pr�sentiert, - h�ngt von der sysctl-Variablen - hw.usb.template ab. Eine Liste der - verf�gbaren Werte finden Sie in &man.usb.template.4;. Damit - der Host die ge�nderte Konfiguration erkennt, muss entweder - das Ger�t getrennt und wieder angeschlossen, oder der - USB-Bus neu gescannt werden. Wenn auf dem - Host &os; l�uft, k�nnen Sie &man.usbconfig.8; - reset benutzen. Dieser Befehl muss nach - dem Laden von usb_template.ko erfolgen, - falls der USB-Host bereits am - USB-OTG-Port - angeschlossen war. - - Die sysctl-Variable hw.usb.template ist - in der Voreinstellung auf 0 gesetzt, so dass &os; als - USB-Massenspeicher funktioniert. Dazu - m�ssen die beiden Kernelmodule &man.usb.template.4; und - &man.cfumass.4; geladen sein. &man.cfumass.4; ist die - Schnittstelle zum CTL-Subsystem, die auch f�r - iSCSI- und Fibre Channel-Targets - benutzt wird. Auf der Host-Seite k�nnen - USB-Massenspeicher nur auf eine einzelne - LUN (LUN 0) - zugreifen. - - USB-Massenspeicher ben�tigen keinen - aktiven &man.ctld.8;-Daemon, obwohl er bei Bedarf verwendet - werden kann. Dies unterscheidet sich von - iSCSI. So gibt es zwei M�glichkeiten, - ein Target zu konfigurieren: &man.ctladm.8; und &man.ctld.8;. - Beide erfordern, dass das cfumass.ko - Kernelmodul geladen ist. Das Modul kann wie folgt geladen - werden: - - &prompt.root; kldload cfumass - - Wenn cfumass.ko nicht im Kernel - enthalten ist, kann das Modul beim Booten �ber - /boot/loader.conf geladen werden: - - cfumass_load="YES" - - Eine LUN kann auch ohne den - &man.ctld.8;-Daemon erstellt werden: - - &prompt.root; ctladm create -b block -o file=/data/target0 - - Damit wird dem USB der Inhalt des - Abbilds /data/target0 als - LUN pr�sentiert. Die Datei muss vor dem - Ausf�hren des Befehls vorhanden sein. Um die - LUN beim Systemstart zu konfigurieren, - f�gen Sie den Befehl in /etc/rc.local - hinzu. - - &man.ctld.8; kann ebenfalls verwendet werden, um - LUNs zu verwalten. Erstellen Sie - /etc/ctl.conf und f�gen Sie eine Zeile in - /etc/rc.conf hinzu, um sicherzustellen, - dass &man.ctld.8; beim Booten automatisch gestartet wird. - Danach starten Sie den Daemon. - - Dies ist ein Beispiel f�r eine einfache - /etc/ctl.conf Konfigurationsdatei. - &man.ctl.conf.5; enth�lt eine ausf�hrliche Beschreibung der - einzelnen Optionen. - - target naa.50015178f369f092 { - lun 0 { - path /data/target0 - size 4G - } -} - - Dieses Beispiel erstellt ein Target mit einer einzigen - LUN. - naa.50015178f369f092 ist eine Ger�tekennung - aus 32 zuf�lligen, hexadezimalen Ziffern. Die - path-Zeile definiert den vollst�ndigen Pfad - einer Datei oder eines zvols, welche als Backend f�r die - LUN benutzt wird. Die Konfigurationsdatei - muss vor dem Start von &man.ctld.8; existieren. Die zweite - Zeile ist optional und gibt die Gr��e der - LUN an. - - F�gen Sie folgende Zeile in - /etc/rc.conf hinzu, um den - &man.ctld.8;-Daemon beim Booten zu starten: - - ctld_enable="YES" - - Um &man.ctld.8; zu starten, f�hren Sie dieses Kommando - aus: - - &prompt.root; service ctld start - - Beim Start liest der &man.ctld.8;-Daemon - /etc/ctl.conf ein. Wenn diese Datei nach - dem Start des Daemons bearbeitet wird, k�nnen Sie sie erneut - einlesen, damit die �nderungen direkt wirksam sind: - - &prompt.root; service ctld reload - Added: head/de_DE.ISO8859-1/books/handbook/usb-device-mode/chapter.xml ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/de_DE.ISO8859-1/books/handbook/usb-device-mode/chapter.xml Thu Aug 16 18:08:47 2018 (r52143) @@ -0,0 +1,404 @@ + + + + + + USB Ger�temodus + + + �bersicht + + + + + + Edward Tomasz + Napierala + + +
+ trasz@FreeBSD.org +
+ + Beigetragen von + + + + + Dieses Kapitel behandelt die Verwendung des USB Ger�temodus + und USB On-The-Go (USB OTG) unter &os;. Dazu + geh�ren virtuelle serielle Konsolen, virtuelle Netzwerkkarten + und virtuelle USB-Laufwerke. + + Wenn die eingesetzte Hardware den USB-Ger�temodus oder + USB OTG unterst�tzt, kann &os;s + USB-Stack im Ger�temodus ausgef�hrt werden. + Solche Hardware wird h�ufig in eingebetteten Systeme verbaut. + Der Ger�temodus erm�glicht es dem Rechner verschiedene Arten von + USB-Ger�teklassen darzustellen, + einschlie�lich serieller Schnittstellen, Netzwerkkarten und + Massenspeicher oder Kombinationen davon. Ein + USB-Host, beispielsweise ein Notebook oder + ein Desktop-Rechner, kann wie auf ein physisches + USB-Ger�t darauf zugreifen. + + Es gibt zwei grundlegende M�glichkeiten, wie die Hardware + den Ger�temodus bereitstellen kann: mit einem separaten + Client Modus, der nur den Ger�temodus + unterst�tzt, und mit einem USB-OTG-Port, der sowohl den + Ger�te- als auch den Hostmodus bereitstellen kann. Bei + USB-OTG-Ports wechselt der USB-Stack automatisch zwischen + host- und ger�teseitig, je nachdem, was an dem Port + angeschlossen ist. Wenn Sie ein USB-Ger�t + wie einen Speicherstick an den Port anschlie�en, wechselt &os; + in den Hostmodus. Wenn Sie einen USB-Host + wie einen Computer anschlie�en, wechselt &os; in den + Ger�temodus. Client Ports arbeiten immer + im Ger�temodus. + + Was &os; dem USB-Host pr�sentiert, h�ngt + von der sysctl-Variable hw.usb.template ab. + Einige Vorlagen bieten ein einzelnes Ger�t, beispielsweise ein + serielles Terminal, andere bieten mehrere, die alle gleichzeitig + verwendet werden k�nnen. Ein Beispiel ist die Vorlage 10, die + ein Massenspeicherger�t, eine serielle Konsole und eine + Netzwerkkarte bereitstellt. &man.usb.template.4; enth�lt eine + Liste der verf�gbaren Werte. + + Beachten Sie, dass in einigen F�llen, abh�ngig von der + Hardware und dem Betriebssystem des Hosts, die �nderung an der + Konfiguration nur dann bemerkt werden kann, wenn der Host + entweder physisch getrennt und wieder verbunden oder gezwungen + wird, den USB-Bus auf eine + systemspezifische Weise neu zu scannen. Wenn &os; auf dem Host + l�uft, kann &man.usbconfig.8; reset + verwendet werden. Dies muss auch nach dem Laden von + usb_template.ko geschehen, wenn der + USB-Host bereits an der + USB OTG-Buchse angeschlossen war. + + Nachdem Sie dieses Kapitel gelesen haben, werden + Sie wissen: + + + + wie man den USB Ger�temodus unter + &os; einrichtet. + + + + wie man die virtuelle serielle Schnittstelle unter + &os; konfiguriert. + + + + wie man sich mit der virtuellen seriellen Schnittstelle + von verschiedenen Betriebssystemen aus verbindet. + + + + + + Virtuelle serielle + <acronym>USB</acronym>-Ports + + + Konfiguration des <acronym>USB</acronym>-Ger�temodus f�r + serielle Ports + + Die virtuellen seriellen Ports werden durch die + Vorlagen 3, 8 und 10 unterst�tzt. Beachten Sie, dass + Vorlage 3 mit Microsoft Windows 10 ohne spezielle Treiber + und INF-Dateien funktioinert. Andere Host-Betriebssysteme + arbeiten mit allen drei Vorlagen. Die beiden Kernelmodule + &man.usb.template.4; und &man.umodem.4; m�ssen geladen + werden. + + Um die seriellen Ports im + USB-Ger�temodus zu aktivieren, f�gen Sie + folgenden Zeilen in + /etc/ttys hinzu: + + ttyU0 "/usr/libexec/getty 3wire" vt100 onifconsole secure +ttyU1 "/usr/libexec/getty 3wire" vt100 onifconsole secure + + Danach f�gen Sie folgende Zeilen in + /etc/devd.conf hinzu: + + notify 100 { + match "system" "DEVFS"; + match "subsystem" "CDEV"; + match "type" "CREATE"; + match "cdev" "ttyU[0-9]+"; + action "/sbin/init q"; +}; + + Laden Sie die Konfiguration neu, falls &man.devd.8; + bereits l�uft: + + &prompt.root; service devd restart + + Stellen Sie sicher, dass die notwendigen Module geladen + sind und die richtige Vorlage beim Booten gesetzt ist. F�gen + Sie dazu folgende Zeilen in + /boot/loader.conf ein: + + umodem_load="YES" +hw.usb.template=3 + + Um das Modul zu laden und die Vorlage ohne Neustart zu + aktivieren, verwenden Sie: + + &prompt.root; kldload umodem +&prompt.root; sysctl hw.usb.template=3 + + + + &os; mit der seriellen Schnittstelle im + <acronym>USB</acronym>-Ger�temodus verbinden + + Um eine Verbindung zu einer Karte herzustellen, die so + konfiguriert ist, dass sie serielle Ports im + USB-Ger�temodus bereitstellt, schlie�en + Sie den USB-Host, beispielsweise einen + Laptop, an den USB OTG- oder + USB-Client-Port der Karte an. Verwenden + Sie pstat -t auf dem Host, um die + Terminalzeilen aufzulisten. Am Ende der Liste sollten Sie + einen seriellen USB-Anschluss sehen, + zum Beispiel ttyU0. Um die Verbindung zu + �ffnen, benutzen Sie: + + &prompt.root; cu -l /dev/ttyU0 + + Nach mehrmaligem Dr�cken der Enter-Taste + erscheint ein Anmeldeprompt. + + + + macOS mit der seriellen Schnittstelle im + <acronym>USB</acronym>-Ger�temodus verbinden + + Um eine Verbindung zu einer Karte herzustellen, die so + konfiguriert ist, dass sie serielle Ports im + USB-Ger�temodus bereitstellt, schlie�en + Sie den USB-Host, beispielsweise einen + Laptop, an den USB OTG- oder + USB-Client-Port der Karte an. Um die + Verbindung zu �ffnen, benutzen Sie: + + &prompt.root; cu -l /dev/cu.usbmodemFreeBSD1 + + + + Linux mit der seriellen Schnittstelle im + <acronym>USB</acronym>-Ger�temodus verbinden + + Um eine Verbindung zu einer Karte herzustellen, die so + konfiguriert ist, dass sie serielle Ports im + USB-Ger�temodus bereitstellt, schlie�en + Sie den USB-Host, beispielsweise einen + Laptop, an den USB OTG- oder + USB-Client-Port der Karte an. Um die + Verbindung zu �ffnen, benutzen Sie: + + &prompt.root; minicom -D /dev/ttyACM0 + + + + Windows 10 mit der seriellen Schnittstelle im + <acronym>USB</acronym>-Ger�temodus verbinden + + Um eine Verbindung zu einer Karte herzustellen, die so + konfiguriert ist, dass sie serielle Ports im + USB-Ger�temodus bereitstellt, schlie�en + Sie den USB-Host, beispielsweise einen + Laptop, an den USB OTG- oder + USB-Client-Port der Karte an. Um die + Verbindung zu �ffnen, ben�tigen Sie ein Terminalprogramm mit + Unterst�tzung f�r serielle Schnittstellen, zum Beispiel + PuTTY. Um den von &windows; + verwendeten COM-Port zu ermitteln, starten Sie den + Ger�te-Manager und erweitern Sie + Ports (COM & LPT). Dort sehen Sie einen + Namen wie USB Serial Sevice (COM4). Starten + Sie das Terminalprogramm Ihrer Wahl, zum Beispiel + PuTTY. Im Dialog von + PuTTY setzen Sie den + Connection type auf Serial und + notieren im Feld Serial line den ermittelten + COM-Namen. Danach klicken Sie auf Open. + + + + + Netzwerkkarten im + <acronym>USB</acronym>-Ger�temodus + + Virtuelle Netzwerkkarten werden durch die Vorlagen 1, 8 und + 10 unterst�tzt. Beachten Sie, dass keine dieser Vorlagen mit + &windows; funktioniert. Andere Host-Betriebssysteme arbeiten + mit allen drei Vorlagen. Die Kernelmodule + &man.usb.template.4; und &man.if.cdce.4; m�ssen + geladen sein. + + Stellen Sie sicher, dass die notwendigen Module geladen + sind und die richtige Vorlage beim Booten gesetzt ist. F�gen + Sie dazu folgende Zeilen in + /boot/loader.conf ein: + + if_cdce_load="YES" +hw.usb.template=1 + + Um das Modul zu laden und die Vorlage ohne Neustart zu + aktivieren, verwenden Sie: + + &prompt.root; kldload if_cdce +&prompt.root; sysctl hw.usb.template=1 + + + + Virtuelle <acronym>USB</acronym>-Speicherger�te + + + &man.cfumass.4; ist ein + USB-Ger�tetreiber, der seit + &os; 12.0 verf�gbar ist. + + + Virtuelle Speicherger�te werden durch die Vorlagen 0 und 10 + unterst�tzt. Die Kernelmodule &man.usb.template.4; und + &man.cfumass.4; m�ssen geladen sein. &man.cfumass.4; ist die + Schnittstelle zum CTL-Subsystem, das auch f�r + iSCSI- oder Fibre-Channel-Targets benutzt + wird. Auf dem Host k�nnen Initiatioren von + USB-Massenspeichern nur auf eine einzige + LUN, LUN 0 + zugreifen. + + + Konfiguration von <acronym>USB</acronym>-Massenspeicher + Targets mit dem cfumass-Startskript + + Der einfachste Weg, ein schreibgesch�tztes + USBSpeicherziel einzurichten, ist die + Verwendung des cfumass rc-Skripts. + Kopieren Sie einfach die Dateien, die dem + USB-Host pr�sentiert werden sollen, in das + Verzeichnis /var/cfumass und f�gen Sie + diese Zeile in /etc/rc.conf ein: + + cfumass_enable="YES" + + Um das Ziel ohne Neustart zu konfigurieren, f�hren Sie + diesen Befehl aus: + + &prompt.root; service cfumass start + + Im Gegensatz zur seriellen und Netzwerkfunktionalit�t + sollte die Vorlage in /boot/loader.conf + nicht auf 0 oder 10 gesetzt werden, da die + LUN vor dem Setzen der Vorlage + konfiguriert werden muss. Das cfumass + rc-Skript setzt beim Start automatisch die richtige + Vorlage. + + + + <acronym>USB</acronym>-Massenspeicher mit anderen + Werkzeugen konfigurieren + + Der Rest dieses Kapitels enth�lt eine detaillierte + Beschreibung der Konfiguration ohne die Verwendung des + cfumass rc-Skripts. Dies ist + beispielsweise notwendig, wenn man eine beschreibbare + LUN zur Verf�gung stellen will. + + Im Gegensatz zu iSCSI ist es bei + USB-Massenspeichern nicht zwingend + erforderlich, dass der &man.ctld.8; Daemon l�uft. Es + gibt zwei M�glichkeiten, das Target zu konfigurieren: + &man.ctladm.8; oder &man.ctld.8;. Beide erfordern, dass das + Kernelmodul cfumass.ko geladen ist. + Das Modul kann manuell geladen werden: + + &prompt.root; kldload cfumass + + Wenn cfumass nicht im Kernel + integriert ist, kann /boot/loader.conf + angepasst werden, damit das Modul beim Booten geladen + wird: + + cfumass_load="YES" + + Eine LUN kann ohne den + &man.ctld.8; Daemon erstellt werden: + + &prompt.root; ctladm create -b block -o file=/data/target0 + + Dies stellt den Inhalt des Abbilds von + /data/target0 als LUN + auf dem USB-Host dar. Die Datei muss vor + der Ausf�hrung des Befehls vorhanden sein. Um die + LUN beim Systemstart zu konfigurieren, + muss das Kommando in /etc/rc.local + eingetragen werden. + + &man.ctld.8; kann auch benutzt werden, um + LUNs zu verwalten. Dazu erstellen Sie eine + /etc/ctl.conf und f�gen eine Zeile in + /etc/rc.conf hinzu, um sicherzustellen, + dass &man.ctld.8; beim Booten automatisch gestartet wird. + Danach kann der Daemon gestartet werden. + + Es folgt ein Beispiel einer einfachen Konfiguration f�r + /etc/ctl.conf. Eine ausf�hrliche + Beschreibung der Optionen finden Sie + in &man.ctl.conf.5;. + + target naa.50015178f369f092 { + lun 0 { + path /data/target0 + size 4G + } +} + + Dieses Beispiel erstellt ein einzelnes Target + mit einer einzigen LUN. + naa.50015178f369f092 ist eine + Ger�tekennung, die aus 32 zuf�lligen + Hexadezimalziffern besteht. + path definiert den absoluten Pfad zu einer + Datei oder eines zvol, welches die + LUN als Speicher nutzen kann. Diese Datei + muss vor dem Start von &man.ctld.8; existieren. Die zweite + Zeile ist optional und definiert die Gr��e + der LUN. + + Damit der &man.ctld.8; Daemon beim Booten gestartet wird, + muss diese Zeile in /etc/rc.conf + hinzugef�gt werden: + + ctld_enable="YES" + + Sie k�nnen &man.ctld.8; mit diesem Befehl direkt + starten: + + &prompt.root; service ctld start + + Der &man.ctld.8; Daemon liest beim Start + /etc/ctl.conf. Wenn diese Datei nach dem + Start des Daemons bearbeitet wird, m�ssen die �nderungen neu + geladen werden, damit sie sofort wirksam werden: + + &prompt.root; service ctld reload + + + From owner-svn-doc-head@freebsd.org Fri Aug 17 09:16:32 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id BF5841087D05; Fri, 17 Aug 2018 09:16:32 +0000 (UTC) (envelope-from ryusuke@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 66F6373C85; Fri, 17 Aug 2018 09:16:32 +0000 (UTC) (envelope-from ryusuke@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 39B812662A; Fri, 17 Aug 2018 09:16:32 +0000 (UTC) (envelope-from ryusuke@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7H9GWFK098886; Fri, 17 Aug 2018 09:16:32 GMT (envelope-from ryusuke@FreeBSD.org) Received: (from ryusuke@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7H9GWRU098885; Fri, 17 Aug 2018 09:16:32 GMT (envelope-from ryusuke@FreeBSD.org) Message-Id: <201808170916.w7H9GWRU098885@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: ryusuke set sender to ryusuke@FreeBSD.org using -f From: Ryusuke SUZUKI Date: Fri, 17 Aug 2018 09:16:32 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52144 - head/ja_JP.eucJP/htdocs/java X-SVN-Group: doc-head X-SVN-Commit-Author: ryusuke X-SVN-Commit-Paths: head/ja_JP.eucJP/htdocs/java X-SVN-Commit-Revision: 52144 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 09:16:32 -0000 Author: ryusuke Date: Fri Aug 17 09:16:31 2018 New Revision: 52144 URL: https://svnweb.freebsd.org/changeset/doc/52144 Log: - Merge the following from the English version: r51348 -> r52094 head/ja_JP.eucJP/htdocs/java/index.xml Modified: head/ja_JP.eucJP/htdocs/java/index.xml Modified: head/ja_JP.eucJP/htdocs/java/index.xml ============================================================================== --- head/ja_JP.eucJP/htdocs/java/index.xml Thu Aug 16 18:08:47 2018 (r52143) +++ head/ja_JP.eucJP/htdocs/java/index.xml Fri Aug 17 09:16:31 2018 (r52144) @@ -5,7 +5,7 @@ - + ]> @@ -38,7 +38,7 @@ �ܺ٤ʥ�꡼��Τ�ˤϡ� ��ӥ�� 򻲾Ȥ��Ƥ��ˡ� - FreshPorts + FreshPorts �Ǥ��¿��ξ��ӥ塼��뤳�Ȥ�Ǥ��ޤ��

&openjdk; 7 package �򥤥󥹥ȡ��뤹��ˤϡ� @@ -90,15 +90,6 @@ JDK �ΥХ��ʥ��ۤ��뤳�ȤϤǤ��ޤ�� ޤ��Ŀ�Ū�˻��Ѥ��뤳�Ȥ��ޤ�� Ʊ��ͳ�ǡ��ɤ��ư�ǥ��ɤ��ɬ�פ��ޤ��
-
-
�쥬��ͥ��ƥ�� JDK
- -
FreeBSD Foundation �ϡ�� Sun �Υѡ��ȥʡ��١�� - &java; &jdk; �� &jre; packages ��󶡤Ϥ��ʤ��ޤ�� - �Ť� &java; &jdk; �� &jre; �� 5.0 �� 6.0 �� packages �ϡ� - ��ߤǤ��ѤǤ��ޤ��

From owner-svn-doc-head@freebsd.org Fri Aug 17 12:37:23 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 6BA6A106C99B; Fri, 17 Aug 2018 12:37:23 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 20E827AE50; Fri, 17 Aug 2018 12:37:23 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 033B5714; Fri, 17 Aug 2018 12:37:23 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HCbM75001424; Fri, 17 Aug 2018 12:37:22 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HCbMCg001422; Fri, 17 Aug 2018 12:37:22 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808171237.w7HCbMCg001422@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 12:37:22 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52145 - in head/en_US.ISO8859-1/books/developers-handbook: policies x86 X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: in head/en_US.ISO8859-1/books/developers-handbook: policies x86 X-SVN-Commit-Revision: 52145 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 12:37:23 -0000 Author: bcr Date: Fri Aug 17 12:37:22 2018 New Revision: 52145 URL: https://svnweb.freebsd.org/changeset/doc/52145 Log: Rewrapping, putting commas after i.e., minor fixes that textproc/igor was emitting. Modified: head/en_US.ISO8859-1/books/developers-handbook/policies/chapter.xml head/en_US.ISO8859-1/books/developers-handbook/x86/chapter.xml Modified: head/en_US.ISO8859-1/books/developers-handbook/policies/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/developers-handbook/policies/chapter.xml Fri Aug 17 09:16:31 2018 (r52144) +++ head/en_US.ISO8859-1/books/developers-handbook/policies/chapter.xml Fri Aug 17 12:37:22 2018 (r52145) @@ -4,17 +4,29 @@ $FreeBSD$ --> - - Source Tree Guidelines and Policies + + + Source Tree Guidelines and Policies + - Poul-HenningKampContributed by - GiorgosKeramidas + + + Poul-Henning + Kamp + + Contributed by + + + + Giorgos + Keramidas + + - - - This chapter documents various guidelines and policies in force for the FreeBSD source tree. @@ -37,11 +49,11 @@ If a particular portion of the &os; src/ distribution is being maintained by a person or group of persons, this is communicated through an - entry in the src/MAINTAINERS file. - Maintainers of ports within the Ports Collection express their - maintainership to the world by adding a - MAINTAINER line to the - Makefile of the port in question: + entry in src/MAINTAINERS. Maintainers of + ports within the Ports Collection express their maintainership + to the world by adding a MAINTAINER line to + the Makefile of the port in + question: MAINTAINER= email-addresses @@ -90,17 +102,32 @@ - Contributed Software + + Contributed Software + - Poul-HenningKampContributed by - DavidO'Brien - GavinAtkinson + + + Poul-Henning + Kamp + + Contributed by + + + + David + O'Brien + + + + + Gavin + Atkinson + + - - - contributed software Some parts of the FreeBSD distribution consist of software @@ -144,12 +171,19 @@ - Vendor Imports with SVN + + Vendor Imports with SVN + - Dag-ErlingSmørgravContributed by + + + Dag-Erling + Smørgrav + + Contributed by + - This section describes the vendor import procedure with Subversion in details. @@ -212,7 +246,7 @@ &prompt.user; svn commit where svn_base is the base - directory of your SVN repository, e.g. + directory of your SVN repository, e.g., svn+ssh://svn.FreeBSD.org/base. @@ -237,7 +271,7 @@ &prompt.user; find . -type f | cut -c 3- | sort > ../new With these two files, the following command will list - list removed files (files only in + removed files (files only in old): &prompt.user; comm -23 ../old ../new @@ -248,7 +282,7 @@ &prompt.user; comm -13 ../old ../new - Let's put this together: + Let us put this together: &prompt.user; cd vendor/foo/foo-9.9 &prompt.user; tar cf - . | tar xf - -C ../dist @@ -337,7 +371,7 @@ &prompt.user; svn diff --no-diff-deleted --old=svn_base/vendor/foo/dist --new=. - The option tells + tells SVN not to check files that are in the vendor tree but not in the main tree. @@ -401,7 +435,8 @@ Any encumbered file requires specific approval from the - Core + Core Team before it is added to the repository. @@ -433,9 +468,11 @@ Should always be in LINT, but - the Core - Team decides per case if it should be - commented out or not. The Core + the Core + Team decides per case if it should be commented + out or not. The Core Team can, of course, change their minds later on. @@ -452,18 +489,19 @@ - The Core + The Core teamcore - team decides if - the code should be part of - make world. + team decides if the code + should be part of make world. - The Release + The Release Engineeringrelease - engineering - decides if it goes into the release. + engineering decides if it goes + into the release. @@ -471,17 +509,32 @@ - Shared Libraries + + Shared Libraries + - SatoshiAsamiContributed by - PeterWemm - DavidO'Brien + + + Satoshi + Asami + + Contributed by + + + + Peter + Wemm + + + + + David + O'Brien + + - - - If you are adding shared library support to a port or other piece of software that does not have one, the version numbers should follow these rules. Generally, the resulting numbers @@ -518,7 +571,7 @@ form x.y.z well. Any version number after the y - (i.e. the third digit) is totally ignored when comparing shared + (i.e., the third digit) is totally ignored when comparing shared lib version numbers to decide which library to link with. Given two shared libraries that differ only in the micro revision, ld.so will @@ -547,7 +600,7 @@ For non-port libraries, it is also our policy to change the shared library version number only once between releases. In addition, it is our policy to change the major shared library - version number only once between major OS releases (i.e. from + version number only once between major OS releases (i.e., from 6.0 to 7.0). When you make a change to a system library that requires the version number to be bumped, check the Makefile's commit logs. It is the Modified: head/en_US.ISO8859-1/books/developers-handbook/x86/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/developers-handbook/x86/chapter.xml Fri Aug 17 09:16:31 2018 (r52144) +++ head/en_US.ISO8859-1/books/developers-handbook/x86/chapter.xml Fri Aug 17 12:37:22 2018 (r52145) @@ -18,150 +18,118 @@ $FreeBSD$ --> - + -x86 Assembly Language Programming - - -This chapter was written by &a.stanislav.email;. - + x86 Assembly Language Programming + This chapter was written by + &a.stanislav.email;. + + Synopsis - -Synopsis + Assembly language programming under &unix; is highly + undocumented. It is generally assumed that no one would ever + want to use it because various &unix; systems run on different + microprocessors, so everything should be written in C for + portability. - -Assembly language programming under &unix; is highly undocumented. It -is generally assumed that no one would ever want to use it because -various &unix; systems run on different microprocessors, so everything -should be written in C for portability. - + In reality, C portability is quite a myth. Even C programs + need to be modified when ported from one &unix; to another, + regardless of what processor each runs on. Typically, such a + program is full of conditional statements depending on the + system it is compiled for. - -In reality, C portability is quite a myth. Even C programs need -to be modified when ported from one &unix; to another, regardless of -what processor each runs on. Typically, such a program is full -of conditional statements depending on the system it is -compiled for. - + Even if we believe that all of &unix; software should be + written in C, or some other high-level language, we still need + assembly language programmers: Who else would write the section + of C library that accesses the kernel? - -Even if we believe that all of &unix; software should be written in C, -or some other high-level language, we still need assembly language -programmers: Who else would write the section of C library -that accesses the kernel? - + In this chapter I will attempt to show you how you can use + assembly language writing &unix; programs, specifically under + FreeBSD. - -In this chapter I will attempt to show you -how you can use assembly language writing -&unix; programs, specifically under FreeBSD. - + This chapter does not explain the basics of assembly + language. There are enough resources about that (for a complete + online course in assembly language, see Randall Hyde's Art of Assembly + Language; or if you prefer a printed book, take a look + at Jeff Duntemann's Assembly Language Step-by-Step (ISBN: + 0471375233). However, once the chapter is finished, any + assembly language programmer will be able to write programs for + FreeBSD quickly and efficiently. - -This chapter does not explain the basics of assembly language. -There are enough resources about that (for a complete -online course in assembly language, see Randall Hyde's -Art -of Assembly Language; or if you prefer -a printed book, take a look at Jeff Duntemann's -Assembly -Language Step-by-Step (ISBN: 0471375233). However, -once the chapter is finished, any assembly language programmer -will be able to write programs for FreeBSD -quickly and efficiently. - + Copyright © 2000-2001 G. Adam Stanislav. All rights + reserved. + - -Copyright © 2000-2001 G. Adam Stanislav. All rights reserved. - + + The Tools - + + The Assembler - -The Tools + The most important tool for assembly language programming + is the assembler, the software that converts assembly language + code into machine language. - -The Assembler + Two very different assemblers are available for FreeBSD. + One is + as1, + which uses the traditional &unix; assembly language syntax. + It comes with the system. - -The most important tool for assembly language programming is the -assembler, the software that converts assembly language code -into machine language. - + The other is + /usr/ports/devel/nasm. It uses the + Intel syntax. Its main advantage is that it can assemble code + for many operating systems. It needs to be installed + separately, but is completely free. - -Two very different assemblers are available for FreeBSD. One is -as1, -which uses the traditional &unix; assembly language syntax. It -comes with the system. - + This chapter uses nasm syntax + because most assembly language programmers coming to FreeBSD + from other operating systems will find it easier to + understand. And, because, quite frankly, that is what I am + used to. + - -The other is /usr/ports/devel/nasm. -It uses the Intel syntax. Its main advantage is that it -can assemble code for many operating systems. It needs -to be installed separately, but is completely free. - + + The Linker - -This chapter uses nasm -syntax because most assembly language programmers -coming to FreeBSD from other operating systems -will find it easier to understand. And, because, -quite frankly, that is what I am used to. - + The output of the assembler, like that of any compiler, + needs to be linked to form an executable file. - + The standard + ld1 + linker comes with FreeBSD. It works with the code assembled + with either assembler. + + - -The Linker + + System Calls - -The output of the assembler, like that of any -compiler, needs to be linked to form an executable file. - + + Default Calling Convention - -The standard -ld1 -linker comes with FreeBSD. It works with the -code assembled with either assembler. - + By default, the FreeBSD kernel uses the C calling + convention. Further, although the kernel is accessed using + int 80h, it is assumed the + program will call a function that issues int 80h, rather than issuing + int 80h directly. - - + This convention is very convenient, and quite superior to + the µsoft; convention used by + &ms-dos;. Why? Because the &unix; + convention allows any program written in any language to + access the kernel. - -System Calls + An assembly language program can do that as well. For + example, we could open a file: - -Default Calling Convention - - -By default, the FreeBSD kernel uses the C calling -convention. Further, although the kernel is accessed -using int 80h, -it is assumed the program will call a function that -issues int 80h, rather than -issuing int 80h directly. - - - -This convention is very convenient, and quite superior to the -µsoft; convention used by &ms-dos;. -Why? Because the &unix; convention allows any program written in -any language to access the kernel. - - - -An assembly language program can do that as well. -For example, we could open a file: - - - -kernel: + kernel: int 80h ; Call kernel ret @@ -172,364 +140,286 @@ open: mov eax, 5 call kernel add esp, byte 12 - ret - + ret - -This is a very clean and portable way of coding. If you need to -port the code to a &unix; system which uses a different interrupt, -or a different way of passing parameters, all you need to change -is the kernel procedure. - + This is a very clean and portable way of coding. If you + need to port the code to a &unix; system which uses a + different interrupt, or a different way of passing parameters, + all you need to change is the kernel procedure. - -But assembly language programmers like to shave off cycles. The above example -requires a call/ret combination. -We can eliminate it by -pushing an extra dword: - + But assembly language programmers like to shave off + cycles. The above example requires a call/ret combination. We can + eliminate it by pushing an + extra dword: - -open: + open: push dword mode push dword flags push dword path mov eax, 5 push eax ; Or any other dword int 80h - add esp, byte 16 - + add esp, byte 16 - -The 5 that we have placed in -EAX identifies -the kernel function, in this case open. - + The 5 that we have placed in EAX identifies the kernel + function, in this case open. + - - -Alternate Calling Convention - -FreeBSD is an extremely flexible system. It offers other ways of -calling the kernel. For it to work, however, the system must -have Linux emulation installed. - + + Alternate Calling Convention - -Linux is a &unix; like system. However, its kernel uses the same -system-call convention of passing parameters in registers -&ms-dos; does. As with the &unix; convention, -the function number is placed in EAX. -The parameters, however, are not passed on the stack but in -EBX, ECX, EDX, ESI, EDI, EBP: - + FreeBSD is an extremely flexible system. It offers other + ways of calling the kernel. For it to work, however, the + system must have Linux emulation installed. - -open: + Linux is a &unix; like system. However, its kernel uses + the same system-call convention of passing parameters in + registers &ms-dos; does. As with the + &unix; convention, the function number is placed in EAX. The parameters, however, are + not passed on the stack but in EBX, + ECX, EDX, ESI, EDI, EBP: + + open: mov eax, 5 mov ebx, path mov ecx, flags mov edx, mode - int 80h - + int 80h - -This convention has a great disadvantage over -the &unix; way, at least as far as assembly language programming -is concerned: Every time you make a kernel call -you must push the registers, then -pop them later. This makes your code -bulkier and slower. Nevertheless, FreeBSD gives -you a choice. - + This convention has a great disadvantage over the &unix; + way, at least as far as assembly language programming is + concerned: Every time you make a kernel call you must + push the registers, then + pop them later. This makes + your code bulkier and slower. Nevertheless, FreeBSD gives you + a choice. - -If you do choose the Linux convention, you must let -the system know about it. After your program is assembled and -linked, you need to brand the executable: - + If you do choose the Linux convention, you must let the + system know about it. After your program is assembled and + linked, you need to brand the executable: -&prompt.user; brandelf -t Linux filename + &prompt.user; brandelf -t Linux filename + - + + Which Convention Should You Use? - -Which Convention Should You Use? + If you are coding specifically for FreeBSD, you should + always use the &unix; convention: It is faster, you can store + global variables in registers, you do not have to brand the + executable, and you do not impose the installation of the + Linux emulation package on the target system. - -If you are coding specifically for FreeBSD, you should always -use the &unix; convention: It is faster, you can store global -variables in registers, you do not have to brand -the executable, and you do not impose the installation of -the Linux emulation package on the target system. - + If you want to create portable code that can also run on + Linux, you will probably still want to give the FreeBSD users + as efficient a code as possible. I will show you how you can + accomplish that after I have explained the basics. + - -If you want to create portable code that can also run -on Linux, you will probably still want to give the FreeBSD -users as efficient a code as possible. I will show you -how you can accomplish that after I have explained the basics. - + + Call Numbers - + To tell the kernel which system service you are calling, + place its number in EAX. + Of course, you need to know what the number is. - -Call Numbers + + The <filename>syscalls</filename> File - -To tell the kernel which system service you are calling, -place its number in EAX. Of course, you need -to know what the number is. - + The numbers are listed in syscalls. + locate syscalls finds this file in + several different formats, all produced automatically from + syscalls.master. - -The <filename>syscalls</filename> File + You can find the master file for the default &unix; + calling convention in + /usr/src/sys/kern/syscalls.master. If + you need to use the other convention implemented in the + Linux emulation mode, read + /usr/src/sys/i386/linux/syscalls.master. - -The numbers are listed in syscalls. -locate syscalls finds this file -in several different formats, all produced automatically -from syscalls.master. - + + Not only do FreeBSD and Linux use different calling + conventions, they sometimes use different numbers for the + same functions. + - -You can find the master file for the default &unix; calling -convention in -/usr/src/sys/kern/syscalls.master. -If you need to use the other convention implemented -in the Linux emulation mode, read -/usr/src/sys/i386/linux/syscalls.master. - + syscalls.master describes how the + call is to be made: - - -Not only do FreeBSD and Linux use different calling -conventions, they sometimes use different numbers for -the same functions. - - - - -syscalls.master describes how -the call is to be made: - - - -0 STD NOHIDE { int nosys(void); } syscall nosys_args int + 0 STD NOHIDE { int nosys(void); } syscall nosys_args int 1 STD NOHIDE { void exit(int rval); } exit rexit_args void 2 STD POSIX { int fork(void); } 3 STD POSIX { ssize_t read(int fd, void *buf, size_t nbyte); } 4 STD POSIX { ssize_t write(int fd, const void *buf, size_t nbyte); } 5 STD POSIX { int open(char *path, int flags, int mode); } 6 STD POSIX { int close(int fd); } -etc... - - -It is the leftmost column that tells us the number to place in -EAX. - +etc... - -The rightmost column tells us what parameters to -push. They are pushed -from right to left. - + It is the leftmost column that tells us the number to + place in EAX. - - -For example, to open a file, we need -to push the mode first, -then flags, then the address at which -the path is stored. - - + The rightmost column tells us what parameters to push. They are pushed from right to + left. - - - - + + For example, to open a file, we + need to push the + mode first, then + flags, then the address at which the + path is stored. + + + -Return Values + Return Values - -A system call would not be useful most of the time -if it did not return some kind of a value: The file -descriptor of an open file, the number of bytes read -to a buffer, the system time, etc. - + A system call would not be useful most of the time if it did + not return some kind of a value: The file descriptor of an open + file, the number of bytes read to a buffer, the system time, + etc. - -Additionally, the system needs to inform us if an error -occurs: A file does not exist, system resources are exhausted, -we passed an invalid parameter, etc. - + Additionally, the system needs to inform us if an error + occurs: A file does not exist, system resources are exhausted, we + passed an invalid parameter, etc. - -Man Pages + + Man Pages - -The traditional place to look for information about various -system calls under &unix; systems are the manual pages. -FreeBSD describes its system calls in section 2, sometimes -in section 3. - + The traditional place to look for information about various + system calls under &unix; systems are the manual pages. FreeBSD + describes its system calls in section 2, sometimes in section + 3. - -For example, open2 says: - + For example, + open2 + says: -

- -If successful, open() returns a non-negative -integer, termed a file descriptor. It returns -1 on failure, -and sets errno to indicate the error. - +
+ If successful, open() returns a + non-negative integer, termed a file descriptor. It returns + -1 on failure, and sets + errno to indicate the error. +
-

- -The assembly language programmer new to &unix; and FreeBSD will -immediately ask the puzzling question: Where is -errno and how do I get to it? - + The assembly language programmer new to &unix; and FreeBSD + will immediately ask the puzzling question: Where is + errno and how do I get to it? - - -The information presented in the manual pages applies -to C programs. The assembly language programmer needs additional -information. - - + + The information presented in the manual pages applies to C + programs. The assembly language programmer needs additional + information. + + - + + Where Are the Return Values? - -Where Are the Return Values? + Unfortunately, it depends... For most system calls it is in + EAX, but not for all. A good + rule of thumb, when working with a system call for the first + time, is to look for the return value in EAX. If it is not there, you need + further research. - -Unfortunately, it depends... For most system calls it is -in EAX, but not for all. -A good rule of thumb, -when working with a system call for -the first time, is to look for -the return value in EAX. -If it is not there, you -need further research. - + + I am aware of one system call that returns the value in + EDX: SYS_fork. All others I have + worked with use EAX. But I + have not worked with them all yet. + - - -I am aware of one system call that returns the value in -EDX: SYS_fork. All others -I have worked with use EAX. -But I have not worked with them all yet. - - + + If you cannot find the answer here or anywhere else, study + libc source code and see how it + interfaces with the kernel. + + - - -If you cannot find the answer here or anywhere else, -study libc source code and see how it -interfaces with the kernel. - - + + Where Is <varname>errno</varname>? - - -Where Is <varname>errno</varname>? + Actually, nowhere... - -Actually, nowhere... - + errno is part of the C language, not the + &unix; kernel. When accessing kernel services directly, the + error code is returned in EAX, the same register the proper + return value generally ends up in. - -errno is part of the C language, not the -&unix; kernel. When accessing kernel services directly, the -error code is returned in EAX, -the same register the proper -return value generally ends up in. - + This makes perfect sense. If there is no error, there is no + error code. If there is an error, there is no return value. + One register can contain either. + - -This makes perfect sense. If there is no error, there is -no error code. If there is an error, there is no return -value. One register can contain either. - + + Determining an Error Occurred - + When using the standard FreeBSD calling convention, the + carry flag is cleared upon + success, set upon failure. - -Determining an Error Occurred - - -When using the standard FreeBSD calling convention, -the carry flag is cleared upon success, -set upon failure. - - - -When using the Linux emulation mode, the signed -value in EAX is non-negative upon success, -and contains the return value. In case of an error, the value -is negative, i.e., -errno. - - - - + When using the Linux emulation mode, the signed value in + EAX is non-negative upon + success, and contains the return value. In case of an error, + the value is negative, i.e., -errno. + -Creating Portable Code + Creating Portable Code - -Portability is generally not one of the strengths of assembly language. -Yet, writing assembly language programs for different platforms is -possible, especially with nasm. I have written -assembly language libraries that can be assembled for such different -operating systems as &windows; and FreeBSD. - *** DIFF OUTPUT TRUNCATED AT 1000 LINES *** From owner-svn-doc-head@freebsd.org Fri Aug 17 13:57:03 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id BCC11106FABA; Fri, 17 Aug 2018 13:57:03 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 733E87F1A2; Fri, 17 Aug 2018 13:57:03 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 507021426; Fri, 17 Aug 2018 13:57:03 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HDv3CY042814; Fri, 17 Aug 2018 13:57:03 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HDv3xb042813; Fri, 17 Aug 2018 13:57:03 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808171357.w7HDv3xb042813@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 13:57:03 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52146 - head/en_US.ISO8859-1/articles/committers-guide X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/articles/committers-guide X-SVN-Commit-Revision: 52146 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 13:57:04 -0000 Author: bcr Date: Fri Aug 17 13:57:02 2018 New Revision: 52146 URL: https://svnweb.freebsd.org/changeset/doc/52146 Log: Minor cleanups of the committer guide from the textproc/igor output. Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/committers-guide/article.xml Fri Aug 17 12:37:22 2018 (r52145) +++ head/en_US.ISO8859-1/articles/committers-guide/article.xml Fri Aug 17 13:57:02 2018 (r52146) @@ -1867,10 +1867,10 @@ U stable/9/share/man/man4/netmap.4 four to ten times longer. One way to limit the time required is to grab a seed file. - It is large - (~1GB) but will consume less network traffic and take less - time to fetch than svnsync will. + xlink:href="https://download.freebsd.org/ftp/development/subversion/">seed + file. It is large (~1GB) but will consume less + network traffic and take less time to fetch than svnsync + will. Extract the file and update it: @@ -2393,14 +2393,13 @@ freebsd-mfc-after = 2 weeks portion of the work was sponsored, or different amounts of sponsorship were provided to different authors, please give appropriate credit in parentheses after each - sponsor name. For example, - Example.com (alice, code refactoring), - Wormulon (bob), Momcorp (cindy) - shows that Alice was sponsored by Example.com to do code - refactoring, while Wormulon sponsored Bob's work and - Momcorp sponsored Cindy's work. Other authors were - either not sponsored or chose not to list - sponsorship. + sponsor name. For example, Example.com (alice, + code refactoring), Wormulon (bob), Momcorp + (cindy) shows that Alice was sponsored by + Example.com to do code refactoring, while Wormulon + sponsored Bob's work and Momcorp sponsored Cindy's work. + Other authors were either not sponsored or chose not to + list sponsorship. @@ -3511,17 +3510,16 @@ Relnotes: yes Reasons for modifying upstream software range from wanting strict control over a tightly coupled dependency - to lack of portability in the canonical - repository's distribution of their code. Regardless of the - reason, effort to minimize the maintenance burden of - fork is helpful to fellow maintainers. Avoid committing - trivial or cosmetic changes to files - since it makes every merge thereafter more - difficult: such patches need to be manually re-verified - every import. + to lack of portability in the canonical repository's + distribution of their code. Regardless of the reason, + effort to minimize the maintenance burden of fork is + helpful to fellow maintainers. Avoid committing trivial + or cosmetic changes to files since it makes every merge + thereafter more difficult: such patches need to be + manually re-verified every import. If a particular piece of software lacks a maintainer, - you're encouraged to take up owership. If you're unsure + you are encouraged to take up owership. If you are unsure of the current maintainership email &a.arch; and ask. @@ -4476,9 +4474,9 @@ MFH: 2014Q1 (browser blanket) - Commits that aren't covered by these blanket - approvals always require explicit approval of - either &a.ports-secteam; or &a.portmgr;. + Commits that are not covered by these blanket + approvals always require explicit approval of either + &a.ports-secteam; or &a.portmgr;. @@ -4575,9 +4573,9 @@ Do you want to commit? (no = start a shell) [y/n]in the order they were committed on the - mfh command line. The new commit - log message will contain the combined log messages - from all the original commits. These messages + mfh line. The new commit log + message will contain the combined log messages from + all the original commits. These messages must be edited to show what is actually being done with the new commit. From owner-svn-doc-head@freebsd.org Fri Aug 17 14:05:30 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 9FF93106FDB7; Fri, 17 Aug 2018 14:05:30 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 52C1F7F82D; Fri, 17 Aug 2018 14:05:30 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 33F2415BD; Fri, 17 Aug 2018 14:05:30 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HE5Uce047899; Fri, 17 Aug 2018 14:05:30 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HE5UYe047898; Fri, 17 Aug 2018 14:05:30 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808171405.w7HE5UYe047898@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 14:05:30 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52147 - head/en_US.ISO8859-1/books/fdp-primer/translations X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/fdp-primer/translations X-SVN-Commit-Revision: 52147 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 14:05:30 -0000 Author: bcr Date: Fri Aug 17 14:05:29 2018 New Revision: 52147 URL: https://svnweb.freebsd.org/changeset/doc/52147 Log: Cleanup the translation section by rewrapping long lines. textproc/igor is happy now. Modified: head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml Fri Aug 17 13:57:02 2018 (r52146) +++ head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml Fri Aug 17 14:05:29 2018 (r52147) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + Translations This is the FAQ for people translating the FreeBSD @@ -71,12 +73,13 @@ Yes. Different translation groups have their own - mailing lists. The list + mailing lists. The list of translation projects has more information about - the mailing lists and web sites run by each translation - project. In addition there is - freebsd-translators@freebsd.org for general - translation discussion. + the mailing lists and web sites run by each translation + project. In addition there is + freebsd-translators@freebsd.org for general + translation discussion. @@ -124,15 +127,17 @@ &prompt.user; svn checkout https://svn.FreeBSD.org/doc/head/ head - svn.FreeBSD.org - is a public SVN server. - Verify the server - certificate from the list of Subversion - mirror sites. + svn.FreeBSD.org + is a public SVN server. Verify the + server certificate from the list of Subversion + mirror sites. - This will require the devel/subversion package to - be installed. + This will require the + devel/subversion package to be + installed. You should be comfortable using @@ -148,8 +153,9 @@ &prompt.user; svn diff -r33733:33734 en_US.ISO8859-1/books/fdp-primer/book.xml Please see the complete explanation of using - Subversion in &os; in the &os; Handbook. + Subversion in &os; in the &os; + Handbook. @@ -160,7 +166,8 @@ - The Documentation + The Documentation Project translations page lists the translation efforts that are currently known about. If others are already working on translating documentation to your From owner-svn-doc-head@freebsd.org Fri Aug 17 14:09:06 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 818CA106FE98; Fri, 17 Aug 2018 14:09:06 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 27A767F930; Fri, 17 Aug 2018 14:09:06 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 031A015BF; Fri, 17 Aug 2018 14:09:06 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HE959f048071; Fri, 17 Aug 2018 14:09:05 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HE95nn048070; Fri, 17 Aug 2018 14:09:05 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808171409.w7HE95nn048070@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 14:09:05 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52148 - head/en_US.ISO8859-1/books/fdp-primer/structure X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/fdp-primer/structure X-SVN-Commit-Revision: 52148 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 14:09:06 -0000 Author: bcr Date: Fri Aug 17 14:09:05 2018 New Revision: 52148 URL: https://svnweb.freebsd.org/changeset/doc/52148 Log: Properly wrap line that were too long. Modified: head/en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml Fri Aug 17 14:05:29 2018 (r52147) +++ head/en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml Fri Aug 17 14:09:05 2018 (r52148) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + Documentation Directory Structure Files and directories in the @@ -86,10 +88,10 @@ Contains subdirectories to further categorize the information. For example, the files that comprise the &man.make.1; infrastructure are in - share/mk, while - the additional XML support files - (such as the &os; extended DocBook - DTD) are in share/xml. + share/mk, while the additional + XML support files (such as the &os; + extended DocBook DTD) are in + share/xml. @@ -158,8 +160,8 @@ man For translations of the system manual pages. This - directory will contain one or more - manN + directory will contain one or more manN directories, corresponding to the sections that have been translated. @@ -167,10 +169,11 @@ - Not every lang.encoding - directory will have all of these subdirectories. It depends - on how much translation has been accomplished by that - translation team. + Not every lang.encoding + directory will have all of these subdirectories. It depends on + how much translation has been accomplished by that translation + team. @@ -204,8 +207,8 @@ The Handbook's organization may change over time, and this document may lag in detailing the organizational - changes. Post questions about Handbook organization to the - &a.doc;. + changes. Post questions about Handbook organization to + the &a.doc;. @@ -224,21 +227,25 @@ <filename>book.xml</filename> This is the top level document in the Handbook. It - contains the Handbook's DOCTYPE + contains the Handbook's DOCTYPE declaration, as well as the elements that describe the Handbook's structure. - book.xml uses parameter + book.xml uses parameter entities to load in the files with the .ent extension. These files - (described later) then define general + (described later) then define general entities that are used throughout the rest of the Handbook. - <filename role="directory"><replaceable>directory</replaceable>/chapter.xml</filename> + <filename + role="directory"><replaceable>directory</replaceable>/chapter.xml</filename> Each chapter in the Handbook is stored in a file called chapter.xml in a separate @@ -270,15 +277,16 @@ stored in the same directory as book.xml, and named after the value of the id attribute on the file's - chapter element. Now, it is possible - to include images in each chapter. Images for each - Handbook chapter are stored within share/images/books/handbook. - The localized version of these images should be - placed in the same directory as the XML - sources for each chapter. Namespace collisions are - inevitable, and it is easier to work with several - directories with a few files in them than it is to work - with one directory that has many files in it. + chapter element. Now, it is possible to + include images in each chapter. Images for each Handbook + chapter are stored within + share/images/books/handbook. The + localized version of these images should be placed in the + same directory as the XML sources for + each chapter. Namespace collisions are inevitable, and it + is easier to work with several directories with a few + files in them than it is to work with one directory that + has many files in it. A brief look will show that there are many directories with individual chapter.xml files, From owner-svn-doc-head@freebsd.org Fri Aug 17 14:11:31 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 76AED106FF2E; Fri, 17 Aug 2018 14:11:31 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 2C2B87FBCD; Fri, 17 Aug 2018 14:11:31 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 0D3C4171A; Fri, 17 Aug 2018 14:11:31 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HEBU32052172; Fri, 17 Aug 2018 14:11:30 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HEBUG9052171; Fri, 17 Aug 2018 14:11:30 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808171411.w7HEBUG9052171@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 14:11:30 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52149 - head/en_US.ISO8859-1/books/fdp-primer/doc-build X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/fdp-primer/doc-build X-SVN-Commit-Revision: 52149 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 14:11:31 -0000 Author: bcr Date: Fri Aug 17 14:11:30 2018 New Revision: 52149 URL: https://svnweb.freebsd.org/changeset/doc/52149 Log: Overlong lines are now properly wrapped to the proper length. Modified: head/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml Fri Aug 17 14:09:05 2018 (r52148) +++ head/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml Fri Aug 17 14:11:30 2018 (r52149) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + The Documentation Build Process This chapter covers organization of the documentation build @@ -158,8 +160,9 @@ - Make - includes are the glue that perform the document + Make + includes are the glue that perform the document production, and are usually of the form doc.xxx.mk. @@ -429,8 +432,8 @@ PRI_LANG?= en_US.ISO8859-1 ${MAKE} ${.TARGET:S/realpackage/package/:S/realinstall/install/} DIRPRFX=${DIRPRFX}${entry}/ ) .endfor - In the above, _SUBDIRUSE is now - a macro which will execute the given commands when it is + In the above, _SUBDIRUSE is + now a macro which will execute the given commands when it is listed as a dependency. What sets this macro apart from other targets? From owner-svn-doc-head@freebsd.org Fri Aug 17 14:17:17 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 5D4721070268; Fri, 17 Aug 2018 14:17:17 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 148737FEF0; Fri, 17 Aug 2018 14:17:17 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id E9BF0176B; Fri, 17 Aug 2018 14:17:16 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HEHGoS053164; Fri, 17 Aug 2018 14:17:16 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HEHGAY053163; Fri, 17 Aug 2018 14:17:16 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808171417.w7HEHGAY053163@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 14:17:16 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52150 - head/en_US.ISO8859-1/books/fdp-primer X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/fdp-primer X-SVN-Commit-Revision: 52150 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 14:17:17 -0000 Author: bcr Date: Fri Aug 17 14:17:16 2018 New Revision: 52150 URL: https://svnweb.freebsd.org/changeset/doc/52150 Log: Apply proper wrapping and nesting of tags. Modified: head/en_US.ISO8859-1/books/fdp-primer/book.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/book.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/book.xml Fri Aug 17 14:11:30 2018 (r52149) +++ head/en_US.ISO8859-1/books/fdp-primer/book.xml Fri Aug 17 14:17:16 2018 (r52150) @@ -34,12 +34,16 @@ POSSIBILITY OF SUCH DAMAGE. --> - - FreeBSD Documentation Project Primer for New +<book xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" + xml:lang="en"> + <info> + <title>FreeBSD Documentation Project Primer for New Contributors - - The FreeBSD Documentation Project + + The FreeBSD Documentation Project + 1998 @@ -113,7 +117,8 @@ - root + root &prompt.root; @@ -168,7 +173,8 @@ The time is 09:18 User and group names. - Only root can do + Only root can do this. From owner-svn-doc-head@freebsd.org Fri Aug 17 14:44:54 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id E47041070EED; Fri, 17 Aug 2018 14:44:53 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 8DC7A80FD4; Fri, 17 Aug 2018 14:44:53 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 681781C78; Fri, 17 Aug 2018 14:44:53 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HEir0q068686; Fri, 17 Aug 2018 14:44:53 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HEippU068675; Fri, 17 Aug 2018 14:44:51 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808171444.w7HEippU068675@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 14:44:51 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52151 - in head/en_US.ISO8859-1/books/fdp-primer: docbook-markup stylesheets the-website tools working-copy writing-style xhtml-markup xml-primer X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: in head/en_US.ISO8859-1/books/fdp-primer: docbook-markup stylesheets the-website tools working-copy writing-style xhtml-markup xml-primer X-SVN-Commit-Revision: 52151 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 14:44:54 -0000 Author: bcr Date: Fri Aug 17 14:44:51 2018 New Revision: 52151 URL: https://svnweb.freebsd.org/changeset/doc/52151 Log: Wrap long lines, properly indent tags, capitalizations, and other fixes for issues that textproc/igor reported. Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -417,10 +417,10 @@ The &os; tutorials are all marked up as articles, while this document, the FAQ, - and the Handbook are all marked up as books, for - example. + xlink:href="&url.books.faq;/index.html">FAQ, and the + Handbook + are all marked up as books, for example. Starting a Book @@ -1000,11 +1000,10 @@ - A procedure shows a series of - steps, which may in turn - consist of more steps or - substeps. Each step - contains block elements and may include an optional title. + A procedure shows a series of steps, + which may in turn consist of more steps or + substeps. Each step contains block + elements and may include an optional title. Sometimes, steps are not sequential, but present a choice: do this or do that, @@ -1309,7 +1308,8 @@ main(void) informaltable frame="none". - Table with <literal>frame="none"</literal> Example + Table with <literal>frame="none"</literal> + Example Appearance: @@ -1962,7 +1962,7 @@ This is the file called 'foo2' Occasionally it is useful to show a Uniform Resource Identifier (URI) without - making it an active hyperlink. The uri element + making it an active hyperlink. The uri element makes this possible: @@ -2641,18 +2641,18 @@ IMAGES= chapter1/fig1.png Web The link element described here allows the writer to - define the link text. When link text is used, it is very important to be descriptive - to give the reader an idea of where the link goes. - Remember that DocBook can be rendered to multiple - types of media. The reader might be looking at a printed book - or other form of media where there are no links. If the link - text is not descriptive enough, the reader might not be able to - locate the linked section. + define the link text. When link text is used, it is very + important to be descriptive to give the reader an idea of + where the link goes. Remember that DocBook can be rendered to + multiple types of media. The reader might be looking at a + printed book or other form of media where there are no links. + If the link text is not descriptive enough, the reader might + not be able to locate the linked section. - The xlink:href attribute - is the URL of the page, - and the content of the element is the text that - will be displayed for the user to activate. + The xlink:href attribute is the + URL of the page, and the content of the + element is the text that will be displayed for the user to + activate. In many situations, it is preferable to show the actual URL rather than text. This can be done by Modified: head/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + Style Sheets XML is concerned with content, and says Modified: head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + The Website The &os; web site is part of the &os; documents. Files for @@ -129,11 +131,12 @@ Having obtained the documentation and web site source files, the web site can be built. - An actual installation of the web site is run as the root - user because the permissions on the web server directory will - not allow files to be installed by an unprivileged user. - For testing, it can be useful to install the files as a normal - user to a temporary directory. + An actual installation of the web site is run as the + root user because the + permissions on the web server directory will not allow files to + be installed by an unprivileged user. For testing, it can be + useful to install the files as a normal user to a temporary + directory. In these examples, the web site files are built by user jru in their home @@ -143,9 +146,10 @@ The web site build uses the INDEX from the Ports Collection and might fail if that file or - /usr/ports is not - present. The simplest approach is to install the Ports - Collection. + /usr/ports is not present. The simplest + approach is to install the Ports + Collection. @@ -241,10 +245,10 @@ Include etc/apache24/Includes/*.conf &prompt.root; service apache24 onestart - The web site can be viewed at - . Be aware that many - links refer to the real &os; site by name, and those links - will still go to the external site instead of the local test + The web site can be viewed at . Be aware that many links + refer to the real &os; site by name, and those links will + still go to the external site instead of the local test version. Fully testing the local site will require temporarily setting DNS so www.FreeBSD.org resolves to Modified: head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + Tools Several software tools are used to manage the FreeBSD @@ -72,7 +74,8 @@ - DocBook DTD (textproc/docbook-xml) + DocBook DTD + (textproc/docbook-xml) DocBook is designed for marking up technical Modified: head/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -26,7 +26,9 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. --> - + The Working Copy The working copy is a copy of the &os; @@ -40,8 +42,11 @@ for temporary files and test versions of various output formats. - Subversion - is used to manage the &os; documentation files. It is obtained by installing the Subversion package: + Subversion + is used to manage the &os; documentation files. It is obtained by + installing the Subversion + package: &prompt.root; pkg install subversion @@ -148,8 +153,9 @@ documentation tree. If the diff file is to be submitted with the web - Submit a &os; - problem report interface, add a + Submit + a &os; problem report interface, add a .txt extension to give the earnest and simple-minded web form a clue that the contents are plain text. @@ -169,8 +175,10 @@ These examples show very basic usage of Subversion. More detail is available - in the Subversion Book - and the Subversion + in the Subversion + Book and the Subversion documentation. Modified: head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + Writing Style @@ -59,7 +61,7 @@ Avoid empty phrases like in order to, which usually just means to. Avoid potentially patronizing words like basically. Avoid Latin - terms like i.e. or cf., which + terms like i.e., or cf., which may be unknown outside of academic or scientific groups. @@ -248,7 +250,8 @@ - For more information about writing style, see Elements of + For more information about writing style, see Elements of Style, by William Strunk. @@ -504,12 +507,16 @@ GB. Hardware compression … CD-ROM - acronymCD-ROMacronym + acronymCD-ROMacronym DoS (Denial of Service) - acronymDoSacronym + acronymDoSacronym @@ -573,7 +580,9 @@ GB. Hardware compression … applicationSubversionapplication Do not refer to the Subversion application as SVN in upper case. To refer to the - command, use commandsvncommand. + command, use commandsvncommand. Modified: head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + <acronym>XHTML</acronym> Markup @@ -41,7 +43,8 @@ XHTML is the XML version of the HyperText Markup Language, the markup language of choice on the World Wide Web. More information can be found at - http://www.w3.org/. + http://www.w3.org/. XHTML is used to mark up pages on the &os; web site. It is usually not used to mark up other @@ -59,8 +62,9 @@ The XHTML DTDs are available from the Ports Collection in - textproc/xhtml. They are - automatically installed by the textproc/docproj port. + textproc/xhtml. They are automatically + installed by the textproc/docproj + port. This is not an exhaustive list of @@ -460,7 +464,8 @@ In-line Elements - + Emphasizing Information Two levels of emphasis are available in Modified: head/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + XML Primer Most FDP documentation is written with @@ -38,8 +40,8 @@ documentation source, and the XML techniques used. - Portions of this section were inspired by Mark Galassi's - Get + Portions of this section were inspired by Mark Galassi's Get Going With DocBook. @@ -219,8 +221,10 @@ For an element called element-name the start tag will - normally look like element-name. - The corresponding closing tag for this element is element-name. + normally look like element-name. + The corresponding closing tag for this element is element-name. Using an Element (Start and End Tags) @@ -360,14 +364,13 @@ To Do… Before running the examples in this document, install - textproc/docproj from - the &os; Ports Collection. This is a - meta-port that downloads and installs - the standard programs and supporting files needed by the - Documentation Project. &man.csh.1; users must use - rehash for the shell to recognize new - programs after they have been installed, or log out - and then log back in again. + textproc/docproj from the &os; Ports + Collection. This is a meta-port that + downloads and installs the standard programs and supporting + files needed by the Documentation Project. &man.csh.1; users + must use rehash for the shell to recognize + new programs after they have been installed, or log out and + then log back in again. @@ -486,7 +489,8 @@ example.xml:5: element head: validity error : Element - PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + PUBLIC "-//W3C//DTD XHTML 1.0 + Transitional//EN" Lists the Formal Public Identifier @@ -505,7 +509,8 @@ example.xml:5: element head: validity error : Element DTD referenced in the FPI. Other ways of telling the XML parser how to find the - DTD are shown later. + DTD are shown later. @@ -539,7 +544,7 @@ example.xml:5: element head: validity error : Element It is not necessary to know this, but it is useful background, and might help debug problems when the - XML processor can not locate the + XML processor cannot locate the DTD. From owner-svn-doc-head@freebsd.org Fri Aug 17 21:25:59 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 3F29A107C202; Fri, 17 Aug 2018 21:25:59 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id D6B6073A3A; Fri, 17 Aug 2018 21:25:58 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id B22C46310; Fri, 17 Aug 2018 21:25:58 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HLPwJA075231; Fri, 17 Aug 2018 21:25:58 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HLPww2075230; Fri, 17 Aug 2018 21:25:58 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808172125.w7HLPww2075230@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 21:25:58 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52152 - in head/en_US.ISO8859-1/books/handbook: multimedia security X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: in head/en_US.ISO8859-1/books/handbook: multimedia security X-SVN-Commit-Revision: 52152 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 21:25:59 -0000 Author: bcr Date: Fri Aug 17 21:25:58 2018 New Revision: 52152 URL: https://svnweb.freebsd.org/changeset/doc/52152 Log: Replace two instances of echo "foo='YES'" >> /etc/rc.conf with sysrc foo=yes which is shorter and provides additional error checking. Modified: head/en_US.ISO8859-1/books/handbook/multimedia/chapter.xml head/en_US.ISO8859-1/books/handbook/security/chapter.xml Modified: head/en_US.ISO8859-1/books/handbook/multimedia/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/handbook/multimedia/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) +++ head/en_US.ISO8859-1/books/handbook/multimedia/chapter.xml Fri Aug 17 21:25:58 2018 (r52152) @@ -1358,7 +1358,7 @@ bktr0: Pinnacle/Miro TV, Philips SECAM tuner.Finally, start the backend: - &prompt.root; echo 'mythbackend_enable="YES"' >> /etc/rc.conf + &prompt.root; sysrc mythbackend_enable=yes &prompt.root; service mythbackend start Modified: head/en_US.ISO8859-1/books/handbook/security/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/handbook/security/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) +++ head/en_US.ISO8859-1/books/handbook/security/chapter.xml Fri Aug 17 21:25:58 2018 (r52152) @@ -3580,7 +3580,7 @@ UWWemqWuz3lAZuORQ9KX &prompt.root; touch /var/account/acct &prompt.root; chmod 600 /var/account/acct &prompt.root; accton /var/account/acct -&prompt.root; echo 'accounting_enable="YES"' >> /etc/rc.conf +&prompt.root; sysrc accounting_enable=yes Once enabled, accounting will begin to track information such as CPU statistics and executed From owner-svn-doc-head@freebsd.org Fri Aug 17 21:34:11 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 55CDA107C42C; Fri, 17 Aug 2018 21:34:11 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id E833E73D7F; Fri, 17 Aug 2018 21:34:10 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id C4B2A64A8; Fri, 17 Aug 2018 21:34:10 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HLYArt080040; Fri, 17 Aug 2018 21:34:10 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HLYACA080039; Fri, 17 Aug 2018 21:34:10 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808172134.w7HLYACA080039@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 21:34:10 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52153 - in head/en_US.ISO8859-1/books/handbook: geom serialcomms X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: in head/en_US.ISO8859-1/books/handbook: geom serialcomms X-SVN-Commit-Revision: 52153 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Aug 2018 21:34:11 -0000 Author: bcr Date: Fri Aug 17 21:34:10 2018 New Revision: 52153 URL: https://svnweb.freebsd.org/changeset/doc/52153 Log: Replace two instances of echo "foo='bar'" >> /boot/loader.conf with sysrc -f /boot/loader.conf foo=bar which is easier to type and provides some error checking through sysrc. Modified: head/en_US.ISO8859-1/books/handbook/geom/chapter.xml head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml Modified: head/en_US.ISO8859-1/books/handbook/geom/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/handbook/geom/chapter.xml Fri Aug 17 21:25:58 2018 (r52152) +++ head/en_US.ISO8859-1/books/handbook/geom/chapter.xml Fri Aug 17 21:34:10 2018 (r52153) @@ -244,7 +244,7 @@ Done. adding a line to /boot/loader.conf: - &prompt.root; echo 'geom_stripe_load="YES"' >> /boot/loader.conf + &prompt.root; sysrc -f /boot/loader.conf geom_stripe_load=YES Modified: head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml Fri Aug 17 21:25:58 2018 (r52152) +++ head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml Fri Aug 17 21:34:10 2018 (r52153) @@ -1789,7 +1789,7 @@ raisechar=^^ console, issue the following command as the superuser: - &prompt.root; echo 'console="comconsole"' >> /boot/loader.conf + &prompt.root; sysrc -f /boot/loader.conf console=comconsole From owner-svn-doc-head@freebsd.org Sat Aug 18 15:12:32 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 07423106F3D9; Sat, 18 Aug 2018 15:12:32 +0000 (UTC) (envelope-from madpilot@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id AD4A994E9B; Sat, 18 Aug 2018 15:12:31 +0000 (UTC) (envelope-from madpilot@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 75A83192F5; Sat, 18 Aug 2018 15:12:31 +0000 (UTC) (envelope-from madpilot@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7IFCVeG037862; Sat, 18 Aug 2018 15:12:31 GMT (envelope-from madpilot@FreeBSD.org) Received: (from madpilot@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7IFCVSt037861; Sat, 18 Aug 2018 15:12:31 GMT (envelope-from madpilot@FreeBSD.org) Message-Id: <201808181512.w7IFCVSt037861@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: madpilot set sender to madpilot@FreeBSD.org using -f From: Guido Falsi Date: Sat, 18 Aug 2018 15:12:31 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52154 - head/en_US.ISO8859-1/htdocs/docproj X-SVN-Group: doc-head X-SVN-Commit-Author: madpilot X-SVN-Commit-Paths: head/en_US.ISO8859-1/htdocs/docproj X-SVN-Commit-Revision: 52154 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 18 Aug 2018 15:12:32 -0000 Author: madpilot (ports committer) Date: Sat Aug 18 15:12:30 2018 New Revision: 52154 URL: https://svnweb.freebsd.org/changeset/doc/52154 Log: Update information about Italian Translation project. Reviewed by: eadler Approved by: eadler Differential Revision: https://reviews.freebsd.org/D16788 Modified: head/en_US.ISO8859-1/htdocs/docproj/translations.xml Modified: head/en_US.ISO8859-1/htdocs/docproj/translations.xml ============================================================================== --- head/en_US.ISO8859-1/htdocs/docproj/translations.xml Fri Aug 17 21:34:10 2018 (r52153) +++ head/en_US.ISO8859-1/htdocs/docproj/translations.xml Sat Aug 18 15:12:30 2018 (r52154) @@ -300,38 +300,17 @@ http://www.bsd.ee/tolge.php

The FreeBSD Italian Documentation Project

-Web: http://www.gufi.org/~alex/
-E-Mail: ale@freebsd.org
+Web: https://people.freebsd.org/~madpilot/ItalianTranslation/
+E-Mail: madpilot@freebsd.org

Mailing lists available: Access the following URL http://liste.gufi.org/mailman/listinfo/traduzioni - for instructions on how to subscribe to the Italian translation - group's mailing list.
- Or, send an email to traduzioni-request@gufi.org - with the word "subscribe" in the subject of the message.
- Posting is allowed for the members at traduzioni@gufi.org -
Documents available: Introduction to Unix; Some Articles; Handbook
Documents currently being worked on: Handbook; Web
CVS repository: CVS web; Send a mail to cvs-all-request@gufi.org - with the word "subscribe" in the subject of the message - for subscribing to the Italian CVS update mailing list in Italian.
Git repository: GitHub

FreeBSD 10.4-RELEASE Errata

The FreeBSD Project

FreeBSD 10.4-RELEASE Errata

The FreeBSD Project

3.�Errata Notices

3.�Errata Notices

2.�Security Advisories

3.�Errata Notices

4.�Open Issues

3.�Errata Notices

4.�Open Issues

�쥬�����ͥ��ƥ��� JDK

The FreeBSD Italian Documentation Project

�쥬��ͥ��ƥ�� JDK