Commit graph

427 commits

Author SHA1 Message Date
Dru Lavigne
7945bd1282 Editorial review of USB Storage Devices chapter.
Update examples.
Add note for xhci.
Incorporate resources into context.

Sponsored by:	iXsystems
2014-04-23 17:04:02 +00:00
Warren Block
0e33be13ac Clarify usage of GELI rc.d script.
PR:		docs/187321
Reviewed by:	Allan Jude and mat@ on IRC
2014-04-11 16:07:32 +00:00
Dru Lavigne
1aa01eb97a Fix grammo.
Submitted by:	wblock
Sponsored by:	iXsystems
2014-04-09 20:03:11 +00:00
Dru Lavigne
b4b641ad5d White space fix only. Translators can ignore.
Sponsored by:	iXsystems
2014-04-09 18:20:06 +00:00
Dru Lavigne
6bb8c68447 Integrate tape backups into Backup Basics chapter.
This improves the flow as tar/dump are already covered.
The next commit will fix the formatting.

Sponsored by:	iXsystems
2014-04-09 18:14:01 +00:00
Dru Lavigne
3e479671b9 Editorial Review of Tape Backup chapter.
The next commit will integrate it into the Backup Basics chapter.

Sponsored by:	iXsystems
2014-04-09 17:57:01 +00:00
Dru Lavigne
62ad7b4488 White space fix only. Translators can ignore.
Sponsored by:	iXsystems
2014-04-09 15:54:45 +00:00
Dru Lavigne
f223ab1430 Add section ID to ZFS Quotas so it can be referred to in Disk Quotas.
Editorial review of Disk Quotas.

Sponsored by:	iXsystems
2014-04-09 15:41:54 +00:00
Dru Lavigne
194060c1b3 Editorial review of Encrypted Swap chapter.
Sponsored by:	iXsystems
2014-04-09 14:28:58 +00:00
Dru Lavigne
16f30dcb88 Fix grammo.
Sponsored by:	iXsystems
2014-04-09 14:06:19 +00:00
Dru Lavigne
285dc0a06e White space fix only. Translators can ignore.
Sponsored by:	iXsystems
2014-04-09 14:04:20 +00:00
Dru Lavigne
1b904db935 Finish editorial review of HAST chapter.
Sponsored by:	iXsystems
2014-04-09 13:44:05 +00:00
Dru Lavigne
7afb5fd08f Fix a grammo and a missing acronym tag.
Sponsored by:	iXsystems
2014-04-08 15:50:21 +00:00
Dru Lavigne
ec56d937f3 White space fix only. Translators can ignore.
Sponsored by:	iXsystems
2014-04-08 15:48:46 +00:00
Dru Lavigne
c9c8b80069 Editorial review of first 1/2 of HAST chapter.
Sponsored by:	iXsystems
2014-04-08 15:18:09 +00:00
Dru Lavigne
c43810ff95 Remove reference to Coda as it was disconnected from the build in 2012.
Sponsored by:	iXsystems
2014-04-07 17:15:51 +00:00
Chris Rees
a57d4a6bda Update the bsdinstall handbook section to describe the automatic
'root-on-zfs' feature.  Also add documentation for the 'shell' mode
feature that was not documented before.

PR:		docs/187683
Submitted by:	Allan Jude <freebsd@allanjude.com>
Approved by:	bcr (mentor)
2014-04-02 20:08:45 +00:00
Warren Block
da33711589 Recover lost <replaceable> tags. 2014-03-30 02:49:18 +00:00
Dru Lavigne
325dfc5668 White space fix only. Translators can ignore.
Sponsored by: iXsystems
2014-03-21 21:54:51 +00:00
Dru Lavigne
299480a9df Add acronym tags to Storage chapter.
Sponsored by: iXsystems
2014-03-21 20:55:43 +00:00
Dru Lavigne
df2e7c75f6 Initial prep work for Storage chapter.
Many more commits to come.

Sponsored by: iXsystems
2014-03-21 20:34:38 +00:00
Benjamin Kaduk
2fb105f2e7 Fix a few typos
PR:		docs/187241
Submitted by:	Alex Weber <alexwebr@gmail.com>
Approved by:	hrs (mentor)
2014-03-07 02:34:39 +00:00
Warren Block
cc5bc96553 Replace <command> markup with <userinput> inside the growing disks
section.
2014-02-26 01:18:03 +00:00
Warren Block
70cabefede Add a new section on growing disks. Modified version of patch submitted
with PR.

PR:		docs/186377
Submitted by:	Allan Jude <freebsd@allanjude.com>
2014-02-06 04:03:28 +00:00
Dru Lavigne
f9597a778d White space fix only. Translators can ignore.
Sponsored by: iXsystems
2014-01-30 22:57:31 +00:00
Dru Lavigne
3f5f1388e8 Last pass through this chapter.
Rename Amanda to Third-Party Backup Utilities.
Add some examples of utils. This section is light-weight and could probably use another paragraph or two.

Rename Emergency Repair Procedure to Emergency Recovery.
Tighten up this section and put the emphasis on the newer installation media option as opposed to the older livefs option.
Make editorial note to close PR48101 in 06/15 when 8.4 is EOl'd.

Sponsored by: iXsystems
2014-01-30 22:34:33 +00:00
Dru Lavigne
1f12522bb7 Next pass through this chapter.
Clarified text in File System Backups
Redid examples in Directory Backups to show how 3 utils differ when creating similar backups.
New examples are aimed at what a new user is likely to do. More complex examples should be added.

Next pass will finish this section, to be followed by white space fix-ups.

Sponsored by: iXsystems
2014-01-30 21:06:20 +00:00
Dru Lavigne
a2f0cd2ed9 First half of edits to Backup sections.
Merge 18.9 Backup Strategies and 18.10 Backup Basics.
Clean up summary.
Divide utilities into File System Backups and Directory Backups sections (not quite complete yet).
Remove Do Nothing section (we don't want to encourage this).
Remove Which Program is Best section as it is personal opinion and based on 23 year old findings.
Next commit will finish the edits to this section.

Sponsored by: iXsystems
2014-01-30 18:17:31 +00:00
Dru Lavigne
b6950141a7 White space fix only. Translators can ignore.
Sponsored by: iXsystems
2014-01-30 15:28:21 +00:00
Dru Lavigne
b75d367469 Reduce floppy section to a procedure.
Make note to remove this section in 06/15 when 8.4 is EOL'd (references PR155982)
This section will not appear in the print edition.

Sponsored by: iXsystems
2014-01-30 15:18:49 +00:00
Warren Block
360a6ebf99 Whitespace-only fixes, translators please ignore. 2014-01-08 18:58:16 +00:00
Warren Block
35119cc54b "May be also useful" is more commonly said as "May also be useful". 2014-01-08 17:57:01 +00:00
Warren Block
e134427096 Add instructions for users to determine whether their kernel supports
quotas.

Reviewed by:	pluknet
2014-01-08 17:50:24 +00:00
Sergey Kandaurov
abac6fe5fe Update status of ``options QUOTA''.
Reported by:	Michal Jedrzejczak <jedrzejczak.michal@gmail.com> on doc@
2014-01-07 18:52:44 +00:00
Gabor Kovesdan
24d129e8d1 - Definitively upgrade to DocBook 5.0 2013-11-07 15:39:28 +00:00
Rene Ladan
1d9bea10ed Merge the projects/entities branch into head/
The primary purposes are to clean up duplicated author definitions in
both share/xml/authors.ent and share/xml/developers.ent, and as a added
bonus simplify writing up author names/email addresses in web pages.

Apart from merging developers.ent into authors.ent, removing the former,
and updating the Committers Guide there should be little user-visible changes:
- a.portmgr renamed to a.portmgr.members
- a.doceng renamed to a.doceng.members
- team.re renamed to a.re.members.email and moved from
share/xml/freebsd.ent to share/xml/authors.ent
- a.core updated and moved from share/xml/mailing-lists.ent to
share/xml/teams.ent
- share/pgpkeys/{addkey.sh|README} updated

Translations are untouched except for build fixes.

Approved by:	doceng (gjb)
Approved by:	gjb (mentor)
2013-07-09 21:15:47 +00:00
Warren Block
b4cf41b730 Remove the vinum chapter. It has been surpassed by other solutions from
GEOM and ZFS.  The existing version is archived in
http://docs.freebsd.org/doc/ . Illustration images in
doc/share/images/books/handbook/vinum/ remain, as they are used by
non-English translations.  -doc mailing list discussion thread:
http://lists.freebsd.org/pipermail/freebsd-doc/2013-June/022216.html

Reviewed by:	-doc
2013-07-02 16:19:38 +00:00
Warren Block
5793bcfc27 Suppress some ugly memories in the Storage chapter:
* Remove "RAID" section that only covers ccd(4) and ataraid(4).  These
  may still work, but there are better solutions for new users.
* Remove Backups to Floppies section.
* Add SATA drive names.
* Change CDROM to CD-ROM to match the FDP Primer word list.

About ccd(4):

Once new and useful, thrice ousted from its niche, time's arrow
evicts ccd from the Handbook, to live forever in the archives.
2013-06-24 01:00:56 +00:00
Glen Barber
e05926f374 MF ISBN:
Merged /projects/print2013/en_US.ISO8859-1:r40693-40726
   Merged /projects/ISBN_1-57176-407-0/en_US.ISO8859-1:r40727-41455,
	41457-41469,41472-41477,41479-41513,41515-41521,41523-41577,
	41579-41581,41583-42013

Notes:  This merge entirely excludes the en_US/books/handbook/ppp-and-slip/
changes.  They will need to be looked at a bit more closely.

Note to translators:  I am very, very sorry.  There was no *clean* way
to merge this as separate commits.  Trust me, I tried.
The revision logs for the ISBN branch should provide some insight to what
content has changed.  I am more than happy to help out here.  Sorry :(

Approved by:	doceng (implicit)
2013-06-23 22:37:08 +00:00
Warren Block
af5332d420 Fix newfs and fstab entries to use the partition, not the whole disk.
PR:		docs/179788
Submitted by:	Zach Crum <crum.zach@gmail.com>
2013-06-20 20:34:02 +00:00
Warren Block
4a6fb0980b Update the Adding Disks section in the Storage chapter. Use a SATA
disk device instead of SCSI, use GPT instead of MBR, use gpart instead
of fdisk/bsdlabel, remove sysinstall example, remove dedicated mode
example.  The PR below was submitted after an RFC regarding this change
was posted to the freebsd-doc mailing list, but was entirely relevant.
http://lists.freebsd.org/pipermail/freebsd-doc/2013-June/022087.html

PR:		docs/179378
Submitted by:	Paul Hoffman <phoffman@proper.com>
Reviewed by:	freebsd-doc RFC (no responses after a week)
2013-06-10 16:57:30 +00:00
Gabor Kovesdan
821f9bab5d - MFH 2013-04-11 10:34:45 +00:00
Gabor Kovesdan
68645226ea - Replace misused (empty) link elements with xref 2013-04-03 11:33:18 +00:00
Glen Barber
6eb7e6c314 Remove notes about unimplemented HAST modes.
Submitted by:	mjg
2013-03-26 21:00:27 +00:00
Glen Barber
d364e5ae80 Remove out-of-date warning.
Submitted by:	pjd
2013-03-26 20:21:08 +00:00
Gabor Kovesdan
b1f6349527 - MFH 2013-03-20 21:05:33 +00:00
Eitan Adler
72f2ad9283 Remove references / support of &os; 7.x
ppp-and-slip not touched because of ongoing work to revise that chapter.

Reviewed by:	doc@
Approved by:	bcr (mentor)
2013-02-28 23:33:03 +00:00
Gabor Kovesdan
3ab2d87bc1 - MFH 2013-02-18 15:29:06 +00:00
Dru Lavigne
952b88ae23 This patch addresses the following:
- fix &os;, <xref>, incorrect directory, varname, and devicename tags

- general rewording/tightening to address "you" and redundancy

- one comment was weirdly tagged and I couldn't figure out how to fix it so it was removed

- a newfs example was modified as UFS2 is now the default

Approved by:  bcr (mentor)
2013-02-07 15:53:27 +00:00
Gabor Kovesdan
a06603e1e8 - MFH 2013-02-05 09:14:34 +00:00
Eitan Adler
7e1c3e6035 Prefer the use of service(1) to explicit invocation of /etc/rc.d
scripts: service(1) puts things in one place and abstracts them.  Also, it's less
typing and easier to autocomplete.

While here modernize script examples by removing the ".sh" suffix.

Discussed on:	-doc
Reviewed by:	bjk (prior version)
Approved by:	bcr (mentor)
2013-01-28 19:42:38 +00:00
Gabor Kovesdan
d95165dc16 - Make the English documentation valid XML 2013-01-21 17:37:33 +00:00
Warren Block
6aba0d141a Update the Using Tapes section to more closely reflect modern reality.
Modified version of patch from PR.

PR:		docs/175226
Submitted by:	Diane Bruce <db@db.net>
2013-01-18 01:17:04 +00:00
Warren Block
0e8f52f505 Whitespace-only fixes. Translators, please ignore. 2012-11-02 04:13:41 +00:00
Gabor Kovesdan
b4346b9b2d - Rename .sgml files to .xml
- Reflect the rename in referencing files

Approved by:	doceng (implicit)
2012-10-01 09:53:01 +00:00
Eitan Adler
f90d581ee9 The doc files are now XML, not SGML.
Approved by:	gjb
2012-09-23 18:47:00 +00:00
Gabor Kovesdan
9c243757ef - XML declarations should use IANA encoding names
Pointed out by:	hrs
2012-09-14 17:47:48 +00:00
Gabor Kovesdan
74586f38c6 - Remove PSGML comments since they are not very useful after the XML
migration

Approved by:		doceng (implicit)
No objection from:	doc@, www@
2012-08-07 23:31:39 +00:00
Gabor Kovesdan
3cdf4e4922 - XMLify English books
Approved by:	doceng (implicit)
2012-06-21 16:04:40 +00:00
Benjamin Kaduk
defbfa7e19 Make the dump-over-ssh example not depend on root's shell being a Bourne
derivative (particularly poignant given that root's default shell is csh!).

PR		docs/167020
Submitted by:	crees
Approved by:	hrs (mentor)
2012-05-30 05:26:11 +00:00
Glen Barber
0292a7ca80 - Fix URLs for the livefs ISO image.
- Add a note that the livefs ISOs are not available for 9.0-RELEASE and
  later, and that the standard install CDROM as well as the memstick
  image may be used to recover a system.

PR:		166580
Submitted by:	Vitaly Magerya (vmagerya%gmail!com)
2012-04-28 22:19:24 +00:00
Eitan Adler
8045345d30 The man pages documents 128 as the default, and a test verifies this.
PR:		docs/161057
Submitted by:	Robert Simmons <rsimmons0@gmail.com>
Reviewed by:	bz
Approved by:	bcr
2012-03-03 19:34:20 +00:00
Eitan Adler
e6a507fa1b Fix a variety of English style nits and other issues found with igor.
Reviewed by:	gabor
Approved by:	wblock
2012-02-13 18:28:50 +00:00
Daniel Gerzo
f15e40468d - update rc.conf configuration directive for enabling quotas for
recent FreeBSD systems

Reviewed by:	remko
PR:		docs/164735
2012-02-10 10:09:19 +00:00
Warren Block
9cdd7d95bf Correct <screen> and <programlisting> tags, replace spaces with real
tabs in a couple of <programlisting> elements, fix the link to the
"Torture-testing Backup" article.
2012-02-03 02:14:27 +00:00
Warren Block
c245e45479 Whitespace-only commit, translators may ignore. Rewrap paragraphs, fix
indentation.
2012-02-02 19:21:57 +00:00
Warren Block
d5795b93d1 Improve the HAST section of the Handbook.
Approved by:	bcr (mentor)
2011-12-05 23:46:43 +00:00
Benedict Reuschling
6b31d4c1b4 s/transfered/transferred
Found by:	codespell
2011-05-27 10:22:55 +00:00
Benedict Reuschling
3983825ca8 Mention the partitioning of large disks using gpart(8).
PR:		docs/157091
Submitted by:	Robert Simmons (rsimmons0 at gmail dot com)
Patch by:	Niclas Zeising (niclas dot zeising at gmail dot com)
2011-05-26 18:28:23 +00:00
Glen Barber
8de80a0170 s/acronym/literal for consistency.
Approved by:		jkois (mentor)
2011-03-21 14:04:13 +00:00
Benedict Reuschling
6e4fe8ed77 Remove a superfluous semicolon. 2011-03-10 18:03:32 +00:00
Daniel Gerzo
888424b7a0 - fix the failover example script in the HAST section
PR:		docs/155372
Submitted by:	johnpupu@gmail.com
2011-03-08 08:47:59 +00:00
Daniel Gerzo
56abf5b493 - the hast.conf configuration example had the IP addresses reversed.
Reported by:	lordboboss <lordboboss@free.fr>
2011-03-07 15:16:31 +00:00
Daniel Gerzo
b5257f7460 - add a new section about HAST
Reviewed by:	pjd, Mikolaj Golub <to.my.trociny@gmail.com>,
		Fabian Keil <freebsd-listen@fabiankeil.de>,
		bcr, brucec, Warren Block <wblock@wonkity.com>,
2011-03-04 16:40:26 +00:00
Ryusuke SUZUKI
0354aa6afc Fix two more broken links to vinum man page.
Noted by:	jkois@
2010-12-30 00:41:40 +00:00
Ryusuke SUZUKI
c3993e73d7 PR: docs/153269
&man.vinum.8 -> &man.vinum.4

Submitted by: Aldis Berjoza <aldis _at_ bsdroot dot lv>
2010-12-24 15:21:14 +00:00
Rene Ladan
f211e47377 Handbook fixups from 6.X removal:
- fix broken sentence in multimedia [1]
	- GNU tar is no longer in base [2]
Submitted by:	ryusuke [1], pluknet [2]
2010-12-03 09:38:53 +00:00
Rene Ladan
fffad858e3 Remove support for FreeBSD prior to 7.0 from the Handbook.
More specifically:
- mentions of old versions of FreeBSD in historical context are left in tact
- remove section about KerberosIV
- remove section about SAP R/3
- remove mentions of XFree86
- only support gvinum
- update examples to 7.X or 8.X
- remove Alpha support
- add COMPAT_FREEBSD[67] kernel options
- csup(1) now only in the base system
- update (tty) device names, add warnings for 7.X
- remove MD5 from the port checksum algorithms
- update port versions (probably not all)
- add definitions for ctm-src[5-8] to mailing-lists.ent

Reviewed by:	bcr, joel, remko, simon
2010-12-01 20:37:05 +00:00
Benedict Reuschling
174584f1b7 The -v parameter of cdda2wav does not support numerical values in newer
releases and produces a warning when invoked like that. Change the example
to use the correct non-numeric form.

PR:             docs/152248
Submitted by:   Warren Block (wblock at wonkity dot com)
2010-11-15 18:04:58 +00:00
Marc Fonvieille
c7bf2534e7 Update Emergency Restore Procedure section to use the livefs CDROM
instead of a fixit floppy (the given fixit floppy build procedure does
not work).  I had this change on my todo list since 2003...

PR:
Submitted by:
Reviewed by:
Approved by:
Obtained from:
MFC after:
Security:
2010-08-21 20:49:54 +00:00
Johann Kois
b019a703d8 Change the link to "Torture-testing Backup and Archive Programs".
Requested by:   Bernhard Erdmann (be ett berdmann dott de)
2010-08-19 18:45:18 +00:00
Marc Fonvieille
5eee66d830 Add a note mentioning that cdda2wav can also be used on ATAPI drives and
that this choice can be a better one than the dd(1) method for question
of jitter correction, etc.

PR:		docs/129281
Submitted by:	Yuri <yuri@tsoft.com>
2010-08-10 08:51:37 +00:00
Simon L. B. Nielsen
9ced15d6cf Add a warning that usermount (vfs.usermount) is not generally safe.
Text by:	rwatson (mostly)
With hat:	so
2010-05-27 09:52:11 +00:00
Marc Fonvieille
f71c5a8b8f Add a note on how to burn files > 4.38GB on DVD medias.
Submitted by:	Tomek Cedro <tomek.cedro@gmail.com>
2010-01-18 19:32:23 +00:00
Daniel Gerzo
e164385633 - reword to avoid a grammar mistak and contraction
PR:	139101
2009-09-24 15:30:11 +00:00
Marc Fonvieille
f923fa9417 A little face lifting of the "USB Storage Devices" to avoid the split
between ehci(4) and o/uchi(4) which comes from a time when USB 2.X
support was "young".  Let's mention usbconfig(8).  This section is now
8.X, 7.X and 6.X compliant.
2009-07-26 11:49:01 +00:00
Hiroki Sato
51cb41ff65 Fix build. 2008-12-24 13:30:35 +00:00
Tom Rhodes
cff3b7069f Recommend setting TMPDIR to a larger file system in cases where /tmp
is small and restore eats the space.

PR:		75865
Submitted by:	"Ben Kaduk" <minimarmot@gmail.com>
2008-12-24 10:54:09 +00:00
Marc Fonvieille
c5e08b8d45 For devfs rulesets examples use [foo=5] scheme since
/etc/defaults/devfs.rules already defines 4 rulesets.
2008-10-07 17:57:41 +00:00
Manolis Kiagias
24b5978b1a Fix two examples in the 'ubs-disks' section
Reviewed by:	pgj, keramida, trhodes
2008-10-03 19:16:10 +00:00
Gabor Pali
edafad6a69 Eliminate erroneous role="directory" attributes from <filename> elements
and replace them with class="directory" [1][2]

[1] http://docbook.org/tdg/en/html/filename.html
[2] http://www.freebsd.org/doc/en/books/fdp-primer/sgml-markup-docbook.html#AEN1799
    (4.2.5.5)

Approved by:	trhodes, gabor (mentor)
2008-08-06 22:03:50 +00:00
Gabor Kovesdan
dfd24d9758 - Use replaceable correctly. Don't mark up the environment variable,
use the "username" word instead.

PR:		docs/123343
Submitted by:	pgj
2008-05-07 14:23:37 +00:00
Gabor Kovesdan
545f3afe56 - Use keycap instead of userinput
PR:		docs/123333
Submitted by:	pgj
2008-05-05 14:04:31 +00:00
Daniel Gerzo
47e1fc0543 - use the rc.d script to restart a system service instead of the old-fashioned
kill method

PR:		docs/123348
Submitted by:	pgj
2008-05-02 23:08:05 +00:00
Marc Fonvieille
a116ea3db1 Use the default extent-size for newfs(8) instead of a -d0 one which may
lead to errors.

PR:		docs/122066
Submitted by:	Takamichi Tateoka <tate@cs.uec.ac.jp>
2008-03-25 08:43:38 +00:00
Tom Rhodes
bfce2dfb29 Remove duplicated word introduced in previous revision.
Noticed by:	ceri
2008-01-22 16:45:19 +00:00
Tom Rhodes
7e383b86e6 Discuss the gbde lockfile
PR:		113695
Submitted by:	Marc Silver <marcs@draenor.org>
2008-01-21 21:08:05 +00:00
Remko Lodder
402dcb4530 If we are creating a mini-bsd floppy with new commands, why do
we insert /dev/MAKEDEV in the floppy then? I dont have it anymore
on a recent system, thus remove the information about it. Probably
the information in the mini-kernelconfiguration example could use
a little hand as well.
2007-12-25 21:02:37 +00:00
Gabor Kovesdan
df6644b54d - Since FreeBSD 6.2 the option to define the encryption algorithm to encrypt
the swap partition has changed from -a to -e. Reflect this in the
  documentation.

PR:		docs/113390
Submitted by:	"Beat Gaetzi" <beat@chruetertee.ch>
2007-12-21 21:01:24 +00:00
Marc Fonvieille
3c53514e13 - Remove obsolete -r flag for commands using bsdlabel(8)
- Add some missing tags
2007-08-23 08:48:34 +00:00