and instead generate them each and every time (twice!).
Based on a suggestion from Alan Barrett, allow setting MAKETOC=no
to permit rebuilding the install notes without regenerating the
.toc files, to allow more speedy debugging of markup changes.
.Te adds an entry at a specified depth and also outputs the entry name
in the output stream, .To "only" adds the entry. .To is necessaary where
markup issues prevent the use of .Te.
all on page one and they add needless clutter. Additionally
doc2html doesn't output a tag for them, so we cannot link to them.
Lower indent level for Ss and Ss2
Add special HTML support: emit an HREF on each TOC line. There's some
nasty kludging with extending the dot-leader tab stop by the width
of the href, but that's life in mdoc2html.
TOCs need to be regenerated, but I'm not going to bother for a while.
This makes it _much_ more user-friendly, as it allows users
to skip to the parts they want easily.
At present, the TOCs are generated files, and can be regenerated
with "make tocs" (probably has to be run twice to account for
the size of the table itself).
TOCs are named INSTALL.{PostScript,ASCII,HTML,more}.toc instead of
INSTALL.{ps,txt,html,more}.toc because that's what \*[format]
expands to.
quick start info about bootable CD-R image
common/sysinst:
point to FAQ entry on missing hard drives
macppc/hardware:
fix info on D-Link 530TX (vr) and 530TX+ (rtk)
Some PowerBooks (FireWire and G4) won't work with FirmWare update 4.1.8,
need to use -current
mention that AirPort/AirMac 802.11b wireless is supported in -current
mention that CPU upgrades are supported
macppc/install:
point to partition numbering explanation in FAQ
fix kernel name on bootable cd-rom and mention case sensitivity
macppc/prep:
mention that people unfamiliar with MacOS should mail the port-macppc
list.
Some PowerBooks (FireWire and G4) won't work with FirmWare update 4.1.8,
need to use -current
Umax S900 isn't supported by System Disk
describe how to use Disk Copy to create the bootable floppy
point to partition numbering explanation in FAQ
point to ISO mirror site list
quick guide for impatient reword netboot section, also macppc can netboot
macppc/hardware:
mention that some older models not listed might work, but are untested
mention that some iMac (Bondi Blue) and PowerMacintosh G3 (Blue and White)
systems have keyboard problems
mention that ttya is "modem" port, and ttyb is "printer" port
macppc/install:
describe the keyboard workaround for PM G3 (B&W), and that 1.4.3 works
fine for it and the iMac (Bondi)
macppc/prep:
make the whole BootROM/Open Firmware distinction clearer
describe that some models have to remove internal modem or set
input/output devices to ttyb since int modem usurps ttya.
macppc/whatis:
mention important changes, such as ELF, binary compatability, newly
supported models that don't require kernel patches, and that the install
procedure described now works for all models (i.e. Open Firmware 3
machines with only one hard drive).
this cleans up the HTML version a lot.
macppc/hardware
doubled required RAM -- bootloader needs 16 MB to be present
reworded video section -- 9500 shipped with PCI card, not on-board video
identifisers => identifiers
wording in the 1.5.1 section release explanation
Xr ifconfig(8) for cloning pseudointerfaces
Consistently reference security advisories.
(XXX: do we need to explain them better? a footnote?)
wording of dhcp bullet
\(em
s/together with a 1.5 kernel/running under a 1.5 kernel/
macppc/install:
add description of "bad partition number, using 0no bootable HFS
partition" error message
mention that boot floppy must be booted from Open Firmware, you don't just
pop it in the floppy drive like a normal MacOS boot floppy.
example of how to read directory of CD or HD from OF (I think I got the
backslashes generated properly)
describe how to boot a kernel from an HFS partition
reiterate that some OF 1.0.5 machines can't seem to netboot
reverse recommendation of ultra0 and ultra1 busses
common/postinstall:
mention stty erase '^h' or '^?'
macppc/hardware:
mention that Sonnet Tempo ATA/66 card doesn't yet work with macppc
mention that adaptec 294x cards don't boot
mention that promise ultra66 works, but isn't bootable
macppc/prep:
mention that A/UX style partitions are interpreted as NetBSD-style
partitions, also that they're unreadable from MacOS
also describe the printenv command and give examples
mention that you can't hold down command-option-o-f on a PS/2 keyboard
rehash the partitioning section to describe under what conditions you can
have a drive with MacOS and NetBSD partitions, and what are the criteria
for a drive to be bootable under NetBSD.
recommend using official NetBSD CD-R image instead of rolling own CD-R
describe how to boot a kernel from an HFS partition
moved partitioning HDs to before copying files to it.
macppc/whatis:
heh, just noticed that it needed updating from NetBSD 1.4
define what "boot media" and "distribution media" mean
macppc/install:
corrected the text in example of booting system
corrected partition number to use in example of booting from HFS partition
added example of how to use MacOS X to print partition table using pdisk
macppc/prep:
actually drive setup 1.8.1 (ships with MacOS 9.0) works too
actually describe what netbsd.ram.gz is (installation kernel)
common/postinstall:
macppc uses vt100 for console, not vt220
describe how to mount root filesystem to edit /etc/rc.conf
order of recommendations for installation methods.
macppc/hardware:
update list of unsupported models
macppc/prep:
mention that ofwboot.elf is obsoleted, and all users should be using
ofwboot.xcf instead
link to partitioning HOW-TO on website
added some info on the "official" NetBSD/macppc-1.5.1 CD-R image
added some info on cdrecord
added note that netboot must be from on-board ethernet
macppc/install:
added a few more details to some of the open firmware error messages
reordered error messages to be in order user might encounter them
removed "pciide0:0:0: lost interrupt" since this is fixed in 1.5.1
added "TFTP timeout" and explanation to list of possible problems
point to macppc X11R6 HOW-TO
common/postinstall:
point to macppc X11R6 HOW-TO
common/xfer:
recommend waiting until later to create media for distribution sets
common/sysinst:
control-C to stop sysint, but added that you can re-run it from the
command prompt, no need to reboot.
added an example of what the sysinst main menu looks like
added some more info/details.
hardware:
add Netgear FA-311 cards (sip)
added newly supported models
added that NVIDIA now has some supported cards
moved on-board audio to supported, but untested
added usb and pci audio as supported
prep:
added a "Preparing yourself" section describing how to best prepare
oneself for the adventure ahead
some rewording of the 'how to get to open firmware' sections to make some
details more clear
I've organized the topics by Open Firmware version, since many users found
the old scheme way too confusing (clause out Open Firmware version-specific
content).
It's still really confusing to read (particularly the .txt version which
doesn't adequately distinguish headings from the body)
Also added a bit more info on partitioning vs. OF version.
capitalize X Window System
kill gratuitous newline
periods after sentences.
s/Domain Name Service/the Domain Name System/
s/new install system/current install system/
Be consistent and say 'ip address' not 'ip number'
Grammar (comma)
s/GMT/UTC/
Update document date.
Periods at ends of sentences.
Don't hyphenate NetBSD (for .ps versions)
Avoid wording that implies the current release is 1.5.
Emdashes are \(em and not -- and especially not '-'; no surrounding whitespace
bound checking => bounds checking
Grammar (including parallelism, articles, etc.)
Tagged lists spaced from largest tag.
Semicolons for list delimitters where commas are ambiguous.
Colons after text before examples.
s/1.4 or later/1.4 or prior/
Simon Burge is a pmax portmaster now
Havard Eidnes -> H\(oavard Eidnes
Jaromir Dolecek -> Jarom\('ir Dolecek [can we do better?]
note The End
they are suitable (for i386).
* Mention xf86config(1) for ports that use XFree86.
* Since i386 INSTALL kernels do not have symbols, point users at
the symbol files should they need them (hopefully not).
* mention additional kernels in binary/kernel/ dir: GENERIC_LAPTOP, etc
* note that we also include firewall software (besides X, ...)
* don't Xref the BUGS file, as it's gone
* update some file sizes (source .tgz files) to match BETA2
* mention that syssrc contains the source for all architectures
* Sysinst now allows setting root password and timezone - note that.
* Explain how to actually install binary packages, giving some
examples that people may want to install.
* Mention rawrite32 near rawrite.
* Don't show preparation of install tape on i386
* update i386 hardware a bit. This needs to be generated automatically...
* Many minor nits & typos.
sysinst: tsubai-san says that macppc doesn't suffer from install-related
pcmcia interrupt problems. removed those for macppc
upgrade: add conditional for macppc and sparc (don't need to boot
from floppy)
point out that some MacOS ftp programs default to ASCII mode
OF 2 systems reset real-base to default when booted into macos
install: add info on how to get OF to always boot
also mention that users may need to remove non-apple hardware
to get their systems to boot (in extreme cases)
block, as we're not using any formatting codes in here.
improve the comments and formatting of the example
- use /etc/rc.d/dhcpd restart as the example for how to restart the
dhcp server on a 1.5 box.
and it does work, so use it instead of .Dq for key names.
- use .Ic instead of .Nm for `external' commands (i.e, not those being
specifically described by this document)
add ross sparc 20 clone
a little more info on sw device
prep: mention that can't boot if root partition is past first 2 GB of disk
refine wording of section on scsi id mappings
install: add a little more info to the tape booting section
hardware: add Gee Three's stealth serial port and scca as console info
prep: chaos/control problems with system disk as well as bootvars
clean up the various exceptions between different versions of OF
removed .Key tags, as they aren't recognized by groff
added examples of how to create install media
install: clean up the various exceptions between different versions of OF
- use .Ic, .Pa, .Key, .Ul, .Tn, .Sq, .Dq as appropriate
- use .Dl instead of .(disp when formatting changes are required (the latter
doesn't cope too well when font change macros are used)
- wrap .Dl blocks with .Pp
- consistently use `file system' instead of `filesystem'
- migrate macppc to common/xfer
- document rc.d in `compatability issues with previous releases' section
- wrap .Dl blocks with .Pp
- use .Ul, .Pa, .Tn, .Bx, ...
- use .Pp after .Ss (since .Ss2 does this, and it looks slightly better)
- add tv@ to releng
- fix up sizes for various sets based on info from tv@ (any errors are
probably due to my conversion rather than his data)
- .Ic commands, .Pa paths, .Tn trade names
hardware: updated the list of what works, broken down by OF version
added devices reported as working by port-macppc posters
added list of what devices are supported by which versions of OF
included description of how each OF version boots
described partitioning
prep: describe how to enter OF depending on OF version
also described how to set up some important OF variables
install: give examples of boot commands
list of common error messages and what they mean
provided more detail when necessary and removed extraneous instructions.
hardware: totally revamped to be more readable and include all known
supported hardware, now matches htdocs/Ports/sparc/hardware.html
install: new section on CD-ROM, netboot has instructions on setting up a
NetBSD server, removed disklabel instructions (miniroot/sysboot's
instructions are clear enough and have error-checking anyways)
prep: reorganized, put in cleaner explanation of SCSI target remapping on
OpenBOOT PROM 1 machines, put in instructions on how to figure out names
ROM uses for SCSI device, put in info about 100BaseTX network cards
upgrade: now points to ../common/upgrade
- "this is the xxx major release"
- features added and bugs fixed in 1.5
- use .Nx instead of NetBSD
- use .Sq instead of ' [...] ' or ` [ ... ] '
- use .Dq instead of " [...] "
- define string `A' to contain the arch name (defaults to the port
name)
- define registers \*A and _\*A if
- deprecate _FOR_RELEASE, and just use FOR_RELEASE
- update for 1.5 (still more MD stuff to check)
- use new macros in ../common/macros as appropriate
- introduce some CONSISTENCY between the various ports' install docs
- use various mdoc macros as appropriate, including .Li, .Pa, .Sy, and .Ic.
- migrate more stuff into ../common/*
- whitespace cleanup
- lots of other little things i'm sure...
- optimize suggested commands (e.g, tar usage, ...)
- consistently use `@netbsd.org' in email addresses
- remember to thank the people who host the WWW, GNATS, CVS and CVSweb servers
- add blurb about trademark ownership
- update MACHINE_LIST for the 31 ports we support (as of 1.5)
- define registers for MACHINE_ARCH, depending upon \*M; may set one
of the following as appropriate: _m68k, _mips, _powerpc, _sh3
- change to using various new macros added in ../common/macros
and doesn't explicitly provide a .It
- add .(bullet & .bullet), which provide bulleted/hyphenated lists.
(alternates between -bullet & -hyphen at each alternate depth).
.(bullet does .It as well.
- add .(enum & .enum); enumerated list. the former does .It as well
- add .(item & .item); enumerated list. the former does .It as well
- add .Nx*M, which generates `NetBSD/machine', except that `NetBSD'
is done using .Nx so gets the appropriate markup from that
- remove .(note and .note), leaving .(Note and .Note)
- document \*M, \*V, \*[.CURDIR]
- suggest looking in /etc/defaults/rc.conf or rc.conf(5) for rc.conf settings
- spell "separate" correctly
- use "third party" instead of "3rd party"
- move notes about /etc/localtime; sysinst does it for us
- update copyright date
Spell Windows CE with a space always.
Add Vr4181 to list of supported processors
Change VR to Vr since that's how it is typically represented in datasheets.
Changes approved by: Jun Ebihara-san
since
- it broke context of sentence in i386 port.
- it seems to better to have port specific legal notice in
port specific place from maintenance point of view.
jhawk