Commit Graph

158 Commits

Author SHA1 Message Date
wiz fca9124183 Hardcode some dates to make this more MKREPRO safe. 2015-12-23 10:43:35 +00:00
wiz 1c9d345b30 Fix a date to make this more reproducible. 2015-12-05 08:11:42 +00:00
christos 27a26957d4 PR/50360: Thomas Klausner: Fix MKREPRO builds 2015-11-25 01:20:11 +00:00
kamil 3867e136be Clean-up resources (sys/sys/resource.h) usage
Add vmemoryuse to login_cap(3)
Document vmemoryuse in login.conf(5)
Document proc.pid.rlimit.vmemoryuse and proc.pid.rlimit.maxlwp in sysctl(7)
Document SBSIZE, AS, VMEM and NTHR in share/doc/psd/05.sysman/1.6.t

Reviewed by <riastradh>
Approved by <pgoyette>

Tested by Dominik Bialy

Closes PR xsrc/49912
2015-07-11 09:21:22 +00:00
christos 3e7dc5abac remove extra space I accidentally added. 2014-10-01 14:12:29 +00:00
christos 0c6cb327ba apply the roman numeral page number fix from psd/Title 2014-10-01 01:11:39 +00:00
christos 37a7aaf8cb Don't use ".af % i" to print page numbers with roman numerals, define a
different register instead so that macros that depend on % being numeric
don't break. From uwe
2014-10-01 01:03:47 +00:00
christos ec20a7d949 explain what's going on with all the spurious errors. 2014-10-01 00:48:14 +00:00
christos 77d06f5686 remove extra tab that broke the table. 2014-09-30 23:30:48 +00:00
dholland f99f788cdd New sentence, new line. 2014-07-06 05:32:30 +00:00
dholland 75eb1ae2e9 Minor updates - I've attempted to catch the most glaringly outdated
statements but haven't made any effort yet to rewrite the main content.
2014-07-06 05:16:18 +00:00
dholland c6bc30fe7e Add a file to help keep track of what's where and what we never
actually had.
2014-07-05 19:36:16 +00:00
dholland 0580599ec4 Reorg docs, part 3:
Move the documents that are papers to /usr/share/doc/papers.
Give them suitable names (including the author and year).

The key property of papers that distinguishes them from documentation
is that they're historical: they're published at a particular time and
aren't updated or maintained. (Except cosmetically.)

We should only ship papers that are of interest to users, either for
historical perspective or because they're the original research
writeup of stuff that went into the system and is still pertinent.

The ffs papers clearly meet this standard; the other one here (about
passwords, in 1978) is probably past its sell-by date.
2014-07-05 19:23:15 +00:00
dholland dcc711d503 Reorg docs, part 2:
Rename the following reference documents to match their programs:
   shell -> sh
   viref -> vi

and rename the following to match their topic better:
   ipctut -> sockets
   ipc -> sockets-advanced

Also, the old "timed" and "timedop" docs are now ref5/timed and
ref8/timed respectively, as the first of these documented the
protocol.
2014-07-05 19:23:00 +00:00
dholland b7b7574d3b Reorg docs, part 1:
Move all the reference manuals to subdirs of /usr/share/doc/reference.
We have subdirs ref1-ref9, corresponding to man page sections 1-9.

Everything that's the reference manual for a program (sections 1, 6,
8), C interface (sections 2, 3), driver or file system (section 4),
format or configuration (section 5), or kernel internal interface
(section 9) belongs in here.

Section 7 is a little less clear: some things that might go in section
7 if they were a man page aren't really reference manuals. So I'm only
putting things in reference section 7 that are (to me) clearly
reference material, rather than e.g. tutorials, guides, FAQs, etc.
This obviously leaves some room for debate, especially without first
editing the docs with this distinction in mind, but if people hate
what I've done things can always be moved again.

Note also that while roff macro man pages traditionally go in section
7, I have put all the roff documentation (macros, tools, etc.) in one
place in reference/ref1/roff. This will make it easier to find and
also easier to edit it into some kind of coherent form.
2014-07-05 19:22:41 +00:00
dholland c3ab26950f Rework /usr/share/doc.
Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
   - explicit use of soelim
   - refer
   - tbl
   - pic
   - eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
2014-07-05 19:22:02 +00:00
dholland 10d3e932da I'm a document, Jim, not a shell script.
Fix this to not use .sy to generate portions of the document.
Instead, generate the necessary bits with sed beforehand.

Apparently -ms is too feeble to be able to generate tables of contents
with automatically generated page numbers, so add the expected page
numbers into the document and make it possible to turn on a
rudimentary mechanism for crosschecking them. (This mechanism still
requires .sy though. Improvements welcome.)

This makes it unnecessary to build the document twice, or to use
groff in unsafe mode.
2013-10-06 05:45:19 +00:00
joerg e240adbd0b Retire OSI network stack. OK core@ 2013-03-01 18:25:13 +00:00
dholland e8c5ba3f3f Some edits, prompted by suggestions from Edgar Fuss. 2012-08-14 05:14:53 +00:00
wiz 44bdf20c29 Typos, capitalization, and file systems.
(Not reviewed at the content level.)
2012-05-21 06:30:18 +00:00
dholland f55f861ea1 Update. comments/suggestions/edits please.
This should be pulled up to netbsd-6 once the dust (if any) settles.
2012-05-21 05:53:28 +00:00
wiz 65ba3f7900 Use %U for URLs. 2012-03-08 22:52:22 +00:00
wiz 3d3c5d42cb Observe the following spelling:
- wide character (noun)
- wide-character (adjective)

Inspired by jmc@OpenBSD.
2010-12-16 17:42:25 +00:00
mbalmer 45aabfbe67 Fix language. 2010-01-28 14:05:03 +00:00
jmmv 149b8384cb The atf subdirectory is gone, so do not descend into it. 2009-01-19 07:50:20 +00:00
jmmv 0cdcf7cea6 Remove ATF 0.5 from dist/atf and all of the reachover Makefiles used to
build it.  0.6 is going to be imported in external/bsd/atf, with all the
necessary Makefiles in that same hierarchy.
2009-01-19 07:08:14 +00:00
apb f46c1de7cb Use ${TOOL_SED} instead if plain sed in Makefiles. 2008-10-25 22:27:34 +00:00
apb 96230fab84 Use ${TOOL_AWK} instead of ${AWK} or plain "awk" in make commands.
Pass AWK=${TOOL_AWK:Q} to shell scripts that use awk.
2008-10-19 22:05:19 +00:00
jmmv ec8287b4eb Adjust path to ATF data/documentation files after the import of atf-0.5. 2008-05-01 15:35:50 +00:00
jmmv 6d7b7f5fd1 Sync with share files from atf 0.4. 2008-02-04 20:30:45 +00:00
garbled 49a3869ae1 Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
2007-12-18 03:35:51 +00:00
pavel 474470307d Update URLs after website reorganization. patch by OKANO Takayoshi, from
PR 37070.
2007-12-14 21:15:52 +00:00
mjf 036409b859 Commit Caldera licensed documentation from 4.4BSD. This was taken from the
OpenBSD tree.

No objections on netbsd-docs.
2007-11-29 12:35:04 +00:00
jmmv dc55116c56 Add the ATF documentation
This change adds the ATF manual pages that are not tied to any specific
tool nor library.  It also adds some distribution documentation to the
system, as this is linked to by the manual pages (plus we have to install
the license text to comply with its terms).
2007-11-12 15:04:02 +00:00
christos 1665d5e960 fix spelling of accommodate; from Zapher. 2006-11-24 19:46:58 +00:00
wiz 5a6a71279e Moved to othersrc/usr.sbin/sushi, where the program now lives. 2006-06-24 21:12:19 +00:00
perry 7f9541e925 u_intN_t -> uintN_t
Someone really should update this whole document to reflect current
reality. It is valuable but very, very old.
2005-12-26 20:04:46 +00:00
mycroft 20dd5ad0e7 Allow docs elsewhere in tree to be built with "make" after installation. 2004-08-06 16:35:41 +00:00
mycroft 436580ddb6 Update the list of missing stuff. 2004-08-06 16:31:43 +00:00
jmc f648d12d47 Add missing NetBSD ID tags 2004-06-30 03:26:26 +00:00
keihan 12dcdec062 s/netbsd.org/NetBSD.org/g 2004-04-23 11:00:06 +00:00
simonb 9bc855a931 s/the the/the/ (only in sources that aren't regularly imported from
elsewhere).
2004-04-23 02:58:27 +00:00
garbled 88b9a63036 Add my paper from BSDCon 2002 about Sushi:
Sushi - an extensible human interface for NetBSD

This paper contains alot of documentation into how sushi works, and how
to create menus for it.
2004-03-09 20:47:40 +00:00
wiz d20841bb64 Uppercase CPU, plural is CPUs. 2004-02-13 11:36:08 +00:00
lukem 7fac3a4aea check MKDOC instead of MKSHARE 2004-01-11 16:11:52 +00:00
itojun c61230d99d fix bad example of select() - first arg shouldn't be FD_SETSIZE. from openbsd 2003-08-13 02:07:06 +00:00
agc 075022b349 Move UCB-licensed code from 4-clause to 3-clause licence.
Patches provided by Joel Baker in PR 22309, verified by myself.
2003-08-07 10:30:41 +00:00
lukem a93ea220fc Rework how dependency generation is performed:
* DPSRCS contains extra dependencies, but is _NOT_ added to CLEANFILES.
  This is a change of behaviour.  If a Makefile wants the clean semantics
  it must specifically append to CLEANFILES.
  Resolves PR toolchain/5204.

* To recap: .d (depend) files are generated for all files in SRCS and DPSRCS
  that have a suffix of: .c .m .s .S .C .cc .cpp .cxx

* If YHEADER is set, automatically add the .y->.h to DPSRCS & CLEANFILES

* Ensure that ${OBJS} ${POBJS} ${LOBJS} ${SOBJS} *.d  depend upon ${DPSRCS}

* Deprecate the (short lived) DEPENDSRCS


Update the various Makefiles to these new semantics; generally either
adding to CLEANFILES (because DPSRCS doesn't do that anymore), or replacing
specific .o dependencies with DPSRCS entries.

Tested with "make -j 8 distribution" and "make distribution".
2003-08-01 17:03:41 +00:00
lukem eb51573bd7 Use ${DEPENDSRCS} as a target instead of .depend, now that
<bsd.dep.mk> builds .depend from .dep files.
2003-07-28 15:25:02 +00:00
salo 22a0ae4298 netbsd.org->NetBSD.org 2003-07-26 20:17:31 +00:00