From 253e67c8b3a72b3a4757fdbc5845297628db0a4a Mon Sep 17 00:00:00 2001 From: Jacob McDonnell Date: Sat, 25 Apr 2026 19:55:15 -0400 Subject: docs: Added All NetBSD Manuals --- static/netbsd/man8/MAKEDEV.8 4.html | 815 +++++ static/netbsd/man8/MAKEDEV.local.8 4.html | 92 + static/netbsd/man8/RELEASE_NOTES-2.8 | 383 ++ static/netbsd/man8/RELEASE_NOTES-3.8 | 128 + static/netbsd/man8/ac.8 | 147 + static/netbsd/man8/accton.8 | 82 + static/netbsd/man8/acpidump.8 | 231 ++ static/netbsd/man8/afterboot.8 4.html | 795 +++++ static/netbsd/man8/ahdilabel.8 | 178 + static/netbsd/man8/altboot.8 | 288 ++ static/netbsd/man8/altqd.8 | 111 + static/netbsd/man8/amd.8 | 369 ++ static/netbsd/man8/amldb.8 | 363 ++ static/netbsd/man8/amq.8 | 281 ++ static/netbsd/man8/amrctl.8 | 98 + static/netbsd/man8/anvil.8 | 304 ++ static/netbsd/man8/apm.8 | 158 + static/netbsd/man8/apmd.8 | 224 ++ static/netbsd/man8/apmlabel.8 | 100 + static/netbsd/man8/arp.8 | 184 + static/netbsd/man8/atactl.8 | 306 ++ static/netbsd/man8/atrun.8 | 69 + static/netbsd/man8/audit-packages.8 | 66 + static/netbsd/man8/authpf.8 | 526 +++ static/netbsd/man8/automount.8 | 134 + static/netbsd/man8/automount2amd.8 | 118 + static/netbsd/man8/automountd.8 | 130 + static/netbsd/man8/autounmountd.8 | 113 + static/netbsd/man8/bad144.8 | 186 + static/netbsd/man8/badsect.8 | 132 + static/netbsd/man8/binpatch.8 | 93 + static/netbsd/man8/binstall.8 | 102 + static/netbsd/man8/bioctl.8 | 172 + static/netbsd/man8/blkdiscard.8 | 163 + static/netbsd/man8/blocklistctl.8 | 134 + static/netbsd/man8/blocklistd.8 | 301 ++ static/netbsd/man8/boot.8 | 303 +- static/netbsd/man8/boot.8 4.html | 223 ++ static/netbsd/man8/boot32.8 | 156 + static/netbsd/man8/boot_console.8 | 147 + static/netbsd/man8/bootmini2440.8 | 179 + static/netbsd/man8/bootpd.8 | 305 ++ static/netbsd/man8/bootpef.8 | 54 + static/netbsd/man8/bootpref.8 | 197 ++ static/netbsd/man8/bootptest.8 | 73 + static/netbsd/man8/bounce.8 | 192 + static/netbsd/man8/bozohttpd.8 | 911 +++++ static/netbsd/man8/brconfig.8 | 295 ++ static/netbsd/man8/bta2dpd.8 | 296 ++ static/netbsd/man8/btattach.8 | 146 + static/netbsd/man8/btconfig.8 | 204 ++ static/netbsd/man8/btdevctl.8 | 179 + static/netbsd/man8/bthcid.8 | 170 + static/netbsd/man8/btpand.8 | 240 ++ static/netbsd/man8/canconfig.8 | 126 + static/netbsd/man8/catman.8 | 107 + static/netbsd/man8/ccdconfig.8 | 344 ++ static/netbsd/man8/certctl.8 | 369 ++ static/netbsd/man8/cgdconfig.8 | 759 ++++ static/netbsd/man8/chat.8 | 598 ++++ static/netbsd/man8/chkconfig.8 | 133 + static/netbsd/man8/chown.8 | 189 + static/netbsd/man8/chroot.8 | 100 + static/netbsd/man8/cleanup.8 | 553 +++ static/netbsd/man8/clri.8 | 80 + static/netbsd/man8/clvmd.8 | 82 + static/netbsd/man8/cnwctl.8 | 160 + static/netbsd/man8/compat_30.8 4.html | 145 + static/netbsd/man8/compat_bsdos.8 4.html | 93 + static/netbsd/man8/compat_freebsd.8 4.html | 258 ++ static/netbsd/man8/compat_linux.8 4.html | 161 + static/netbsd/man8/compat_netbsd32.8 4.html | 109 + static/netbsd/man8/compat_sunos.8 4.html | 92 + static/netbsd/man8/compat_ultrix.8 4.html | 106 + static/netbsd/man8/comsat.8 | 114 + static/netbsd/man8/cpuctl.8 | 158 + static/netbsd/man8/crash.8 | 205 ++ static/netbsd/man8/creds_msdos.8 4.html | 99 + static/netbsd/man8/cron.8 | 181 + static/netbsd/man8/cvsbug.8 | 243 ++ static/netbsd/man8/dbsym.8 | 72 + static/netbsd/man8/defer.8 | 3 + static/netbsd/man8/dev_mkdb.8 | 95 + static/netbsd/man8/devpubd.8 | 79 + static/netbsd/man8/dhclient-script.8 | 241 ++ static/netbsd/man8/dhclient.8 | 617 ++++ static/netbsd/man8/dhcpcd-run-hooks.8 | 241 ++ static/netbsd/man8/dhcpcd.8 | 890 +++++ static/netbsd/man8/dhcpd.8 | 891 +++++ static/netbsd/man8/dhcrelay.8 | 357 ++ static/netbsd/man8/discard.8 | 136 + static/netbsd/man8/disklabel.8 | 411 +++ static/netbsd/man8/diskless.8 4.html | 542 +++ static/netbsd/man8/diskpart.8 | 140 + static/netbsd/man8/dkctl.8 | 231 ++ static/netbsd/man8/dkscan_bsdlabel.8 | 76 + static/netbsd/man8/dm.8 | 106 + static/netbsd/man8/dmctl.8 | 69 + static/netbsd/man8/dmesg.8 | 122 + static/netbsd/man8/dmesgfs.8 | 96 + static/netbsd/man8/dmsetup.8 | 364 ++ static/netbsd/man8/dnsblog.8 | 111 + static/netbsd/man8/dosboot.8 | 163 + static/netbsd/man8/download-vulnerability-list.8 | 54 + static/netbsd/man8/drtest.8 | 112 + static/netbsd/man8/drvctl.8 | 190 + static/netbsd/man8/dump.8 | 608 ++++ static/netbsd/man8/dump_lfs.8 | 566 +++ static/netbsd/man8/dumpfs.8 | 116 + static/netbsd/man8/dumplfs.8 | 87 + static/netbsd/man8/eapol_test.8 | 124 + static/netbsd/man8/edquota.8 | 200 ++ static/netbsd/man8/eeprom.8 | 357 ++ static/netbsd/man8/efi.8 | 448 +++ static/netbsd/man8/elftosb.8 | 69 + static/netbsd/man8/emcfanctl.8 | 491 +++ static/netbsd/man8/envstat.8 | 316 ++ static/netbsd/man8/error.8 | 138 + static/netbsd/man8/etcupdate.8 | 467 +++ static/netbsd/man8/example.8 | 11 + static/netbsd/man8/extattrctl.8 | 218 ++ static/netbsd/man8/faithd.8 | 401 +++ static/netbsd/man8/fanoutfs.8 | 61 + static/netbsd/man8/fastboot.8 | 67 + static/netbsd/man8/fdisk.8 | 664 ++++ static/netbsd/man8/fingerd.8 | 176 + static/netbsd/man8/fixmount.8 | 172 + static/netbsd/man8/flashctl.8 | 85 + static/netbsd/man8/flush.8 | 185 + static/netbsd/man8/format.8 | 63 + static/netbsd/man8/fsadm.8 | 63 + static/netbsd/man8/fsck.8 | 186 + static/netbsd/man8/fsck_ext2fs.8 | 261 ++ static/netbsd/man8/fsck_ffs.8 | 408 +++ static/netbsd/man8/fsck_lfs.8 | 242 ++ static/netbsd/man8/fsck_msdos.8 | 119 + static/netbsd/man8/fsck_udf.8 | 116 + static/netbsd/man8/fsck_v7fs.8 | 102 + static/netbsd/man8/fsdb.8 | 267 ++ static/netbsd/man8/fsinfo.8 | 119 + static/netbsd/man8/fsirand.8 | 98 + static/netbsd/man8/fssconfig.8 | 176 + static/netbsd/man8/fstyp.8 | 155 + static/netbsd/man8/ftp-proxy.8 | 218 ++ static/netbsd/man8/ftpd.8 | 875 +++++ static/netbsd/man8/fusermount.8 | 127 + static/netbsd/man8/fwctl.8 | 229 ++ static/netbsd/man8/getNAME.8 | 92 + static/netbsd/man8/getencstat.8 | 90 + static/netbsd/man8/getty.8 | 162 + static/netbsd/man8/gpioctl.8 | 229 ++ static/netbsd/man8/gpt.8 | 1714 +++++++++ static/netbsd/man8/grfconfig.8 | 207 ++ static/netbsd/man8/group.8 | 89 + static/netbsd/man8/groupadd.8 | 87 + static/netbsd/man8/groupdel.8 | 74 + static/netbsd/man8/groupinfo.8 | 90 + static/netbsd/man8/groupmod.8 | 83 + static/netbsd/man8/gspa.8 | 87 + static/netbsd/man8/hdaudioctl.8 | 103 + static/netbsd/man8/hlfsd.8 | 322 ++ static/netbsd/man8/hostapd.8 | 59 + static/netbsd/man8/hostapd_cli.8 | 114 + static/netbsd/man8/hpcboot.8 4.html | 133 + static/netbsd/man8/hprop.8 | 133 + static/netbsd/man8/hpropd.8 | 92 + static/netbsd/man8/i2cscan.8 | 79 + static/netbsd/man8/ian.8 | 89 + static/netbsd/man8/iasl.8 | 206 ++ static/netbsd/man8/icfs.8 | 66 + static/netbsd/man8/id3fs.8 | 76 + static/netbsd/man8/identd.8 | 245 ++ static/netbsd/man8/ifconfig.8 | 948 +++++ static/netbsd/man8/ifmcstat.8 | 45 + static/netbsd/man8/ifwatchd.8 | 223 ++ static/netbsd/man8/inetd.8 | 898 +++++ static/netbsd/man8/init.8 | 389 +++ static/netbsd/man8/installboot.8 | 139 + static/netbsd/man8/intrctl.8 | 93 + static/netbsd/man8/intro.8 4.html | 44 + static/netbsd/man8/iopctl.8 | 92 + static/netbsd/man8/iostat.8 | 365 ++ static/netbsd/man8/ip6addrctl.8 | 127 + static/netbsd/man8/ipf.8 | 174 + static/netbsd/man8/ipfs.8 | 127 + static/netbsd/man8/ipfstat.8 | 195 ++ static/netbsd/man8/ipmon.8 | 187 + static/netbsd/man8/ipnat.8 | 76 + static/netbsd/man8/ippool.8 | 133 + static/netbsd/man8/iprop-log.8 | 256 ++ static/netbsd/man8/iprop.8 | 195 ++ static/netbsd/man8/ipscan.8 | 44 + static/netbsd/man8/ipwctl.8 | 87 + static/netbsd/man8/irdaattach.8 | 121 + static/netbsd/man8/iscsi-initiator.8 | 167 + static/netbsd/man8/iscsi-target.8 | 124 + static/netbsd/man8/iscsictl.8 | 334 ++ static/netbsd/man8/iscsid.8 | 94 + static/netbsd/man8/isibootd.8 | 102 + static/netbsd/man8/iteconfig.8 | 167 + static/netbsd/man8/iwictl.8 | 74 + static/netbsd/man8/kadmind.8 | 165 + static/netbsd/man8/kcm.8 | 176 + static/netbsd/man8/kdc.8 | 234 ++ static/netbsd/man8/kdigest.8 | 259 ++ static/netbsd/man8/keama.8 | 106 + static/netbsd/man8/kerberos.8 | 114 + static/netbsd/man8/kgmon.8 | 144 + static/netbsd/man8/kimpersonate.8 | 132 + static/netbsd/man8/kpasswdd.8 | 112 + static/netbsd/man8/kstash.8 | 94 + static/netbsd/man8/kvm_mkdb.8 | 78 + static/netbsd/man8/lastlogin.8 | 131 + static/netbsd/man8/ldconfig.8 | 164 + static/netbsd/man8/ldpd.8 | 139 + static/netbsd/man8/lfs_cleanerd.8 | 156 + static/netbsd/man8/link.8 | 64 + static/netbsd/man8/lloadd.8 | 341 ++ static/netbsd/man8/lmtp.8 | 3 + static/netbsd/man8/loadbsd.8 | 137 + static/netbsd/man8/local.8 | 680 ++++ static/netbsd/man8/locate.updatedb.8 | 86 + static/netbsd/man8/lockstat.8 | 188 + static/netbsd/man8/lpc.8 | 174 + static/netbsd/man8/lpd.8 | 383 ++ static/netbsd/man8/lptctl.8 | 123 + static/netbsd/man8/luactl.8 | 127 + static/netbsd/man8/lvchange.8 | 97 + static/netbsd/man8/lvconvert.8 | 112 + static/netbsd/man8/lvcreate.8 | 193 + static/netbsd/man8/lvdisplay.8 | 63 + static/netbsd/man8/lvextend.8 | 71 + static/netbsd/man8/lvm.8 | 318 ++ static/netbsd/man8/lvm2create_initrd.8 | 281 ++ static/netbsd/man8/lvmchange.8 | 12 + static/netbsd/man8/lvmdiskscan.8 | 26 + static/netbsd/man8/lvmdump.8 | 52 + static/netbsd/man8/lvreduce.8 | 69 + static/netbsd/man8/lvremove.8 | 43 + static/netbsd/man8/lvrename.8 | 49 + static/netbsd/man8/lvresize.8 | 68 + static/netbsd/man8/lvs.8 | 103 + static/netbsd/man8/lvscan.8 | 27 + static/netbsd/man8/mDNSResponder.8 | 136 + static/netbsd/man8/mail.local.8 | 109 + static/netbsd/man8/mailwrapper.8 | 169 + static/netbsd/man8/makedbm.8 | 129 + static/netbsd/man8/makefs.8 | 648 ++++ static/netbsd/man8/makekey.8 | 57 + static/netbsd/man8/makemandb.8 | 126 + static/netbsd/man8/makewhatis.8 | 228 ++ static/netbsd/man8/man.cgi.8 | 426 +++ static/netbsd/man8/man8.hpcarm/boot.8 3.html | 80 + static/netbsd/man8/man8.mac68k/boot.8 3.html | 88 + static/netbsd/man8/man8.macppc/boot.8 3.html | 296 ++ static/netbsd/man8/man8.macppc/ofwboot.8 3.html | 367 ++ static/netbsd/man8/man8.pmax/boot.8 2.html | 162 + static/netbsd/man8/man8.prep/boot.8 3.html | 87 + static/netbsd/man8/man8.sandpoint/altboot.8 3.html | 181 + static/netbsd/man8/man8.sgimips/boot.8 3.html | 114 + static/netbsd/man8/man8.sgimips/sgivol.8 3.html | 163 + static/netbsd/man8/man8.sparc/binstall.8 3.html | 84 + static/netbsd/man8/man8.sparc/boot.8 3.html | 214 ++ static/netbsd/man8/man8.sparc64/boot.8 3.html | 205 ++ static/netbsd/man8/man8.sun2/boot.8 3.html | 137 + static/netbsd/man8/man8.sun3/boot.8 3.html | 92 + static/netbsd/man8/man8.vax/boot.8 3.html | 190 + static/netbsd/man8/man8.vax/crash.8 2.html | 175 + static/netbsd/man8/man8.vax/drtest.8 3.html | 85 + static/netbsd/man8/man8.vax/format.8 3.html | 220 ++ static/netbsd/man8/man8.x68k/boot.8 3.html | 193 + static/netbsd/man8/man8.x68k/loadbsd.8 3.html | 130 + static/netbsd/man8/man8.x68k/newdisk.8 3.html | 80 + static/netbsd/man8/man8.x86/boot.8 3.html | 705 ++++ static/netbsd/man8/man8.x86/boot_console.8 3.html | 124 + static/netbsd/man8/man8.x86/dosboot.8 3.html | 111 + static/netbsd/man8/man8.x86/mbr.8 4.html | 154 + static/netbsd/man8/man8.x86/multiboot.8 4.html | 85 + static/netbsd/man8/man8.x86/pxeboot.8 4.html | 240 ++ static/netbsd/man8/mandocd.8 | 198 ++ static/netbsd/man8/map-mbone.8 | 122 + static/netbsd/man8/master.8 | 227 ++ static/netbsd/man8/mbr.8 | 135 + static/netbsd/man8/mbrlabel.8 | 118 + static/netbsd/man8/mdconfig.8 | 74 + static/netbsd/man8/mdnsd.8 | 154 + static/netbsd/man8/mdsetimage.8 | 98 + static/netbsd/man8/memswitch.8 | 78 + static/netbsd/man8/mk-amd-map.8 | 80 + static/netbsd/man8/mkalias.8 | 91 + static/netbsd/man8/mkboot.8 | 64 + static/netbsd/man8/mkbootimage.8 | 132 + static/netbsd/man8/mkhybrid.8 | 1683 +++++++++ static/netbsd/man8/mkisofs.8 | 689 ++++ static/netbsd/man8/mknetid.8 | 101 + static/netbsd/man8/mknod.8 | 229 ++ static/netbsd/man8/mld6query.8 | 88 + static/netbsd/man8/mlxctl.8 | 162 + static/netbsd/man8/mmcformat.8 | 136 + static/netbsd/man8/modload.8 | 159 + static/netbsd/man8/modstat.8 | 147 + static/netbsd/man8/modunload.8 | 79 + static/netbsd/man8/mopd.8 | 128 + static/netbsd/man8/mount.8 | 616 ++++ static/netbsd/man8/mount_9p.8 | 152 + static/netbsd/man8/mount_ados.8 | 128 + static/netbsd/man8/mount_autofs.8 | 123 + static/netbsd/man8/mount_cd9660.8 | 242 ++ static/netbsd/man8/mount_chfs.8 | 81 + static/netbsd/man8/mount_efs.8 | 87 + static/netbsd/man8/mount_ext2fs.8 | 81 + static/netbsd/man8/mount_fdesc.8 | 157 + static/netbsd/man8/mount_ffs.8 | 99 + static/netbsd/man8/mount_filecore.8 | 119 + static/netbsd/man8/mount_hfs.8 | 126 + static/netbsd/man8/mount_kernfs.8 | 141 + static/netbsd/man8/mount_lfs.8 | 143 + static/netbsd/man8/mount_mfs.8 | 281 ++ static/netbsd/man8/mount_msdos.8 | 220 ++ static/netbsd/man8/mount_nfs.8 | 491 +++ static/netbsd/man8/mount_nilfs.8 | 101 + static/netbsd/man8/mount_ntfs.8 | 200 ++ static/netbsd/man8/mount_null.8 | 252 ++ static/netbsd/man8/mount_overlay.8 | 89 + static/netbsd/man8/mount_portal.8 | 225 ++ static/netbsd/man8/mount_procfs.8 | 333 ++ static/netbsd/man8/mount_psshfs.8 | 205 ++ static/netbsd/man8/mount_ptyfs.8 | 103 + static/netbsd/man8/mount_puffs.8 | 136 + static/netbsd/man8/mount_qemufwcfg.8 | 87 + static/netbsd/man8/mount_sysctlfs.8 | 63 + static/netbsd/man8/mount_sysvbfs.8 | 82 + static/netbsd/man8/mount_tmpfs.8 | 163 + static/netbsd/man8/mount_udf.8 | 145 + static/netbsd/man8/mount_umap.8 | 154 + static/netbsd/man8/mount_union.8 | 208 ++ static/netbsd/man8/mount_v7fs.8 | 120 + static/netbsd/man8/mount_zfs.8 | 54 + static/netbsd/man8/mountd.8 | 163 + static/netbsd/man8/moused.8 | 455 +++ static/netbsd/man8/mrinfo.8 | 152 + static/netbsd/man8/mrouted.8 | 451 +++ static/netbsd/man8/mscdlabel.8 | 41 + static/netbsd/man8/mtrace.8 | 516 +++ static/netbsd/man8/mtree.8 | 886 +++++ static/netbsd/man8/multiboot.8 | 115 + static/netbsd/man8/nbfs.8 | 82 + static/netbsd/man8/ncdcs.8 | 31 + static/netbsd/man8/ndbootd.8 | 153 + static/netbsd/man8/ndp.8 | 231 ++ static/netbsd/man8/netgroup_mkdb.8 | 83 + static/netbsd/man8/newbtconf.8 | 266 ++ static/netbsd/man8/newdisk.8 | 86 + static/netbsd/man8/newfs.8 | 427 +++ static/netbsd/man8/newfs_ext2fs.8 | 322 ++ static/netbsd/man8/newfs_lfs.8 | 188 + static/netbsd/man8/newfs_msdos.8 | 254 ++ static/netbsd/man8/newfs_sysvbfs.8 | 78 + static/netbsd/man8/newfs_udf.8 | 191 + static/netbsd/man8/newfs_v7fs.8 | 139 + static/netbsd/man8/newsyslog.8 | 416 +++ static/netbsd/man8/nfsd.8 | 126 + static/netbsd/man8/nis.8 4.html | 214 ++ static/netbsd/man8/nologin.8 | 58 + static/netbsd/man8/npfctl.8 | 260 ++ static/netbsd/man8/npfd.8 | 257 ++ static/netbsd/man8/nslookup.8 | 548 +++ static/netbsd/man8/ntpdate.8 | 203 ++ static/netbsd/man8/ntptime.8 | 59 + static/netbsd/man8/ntptrace.8 | 91 + static/netbsd/man8/nvmectl.8 | 210 ++ static/netbsd/man8/nvmmctl.8 | 62 + static/netbsd/man8/ofctl.8 | 97 + static/netbsd/man8/ofwboot.8 | 490 +++ static/netbsd/man8/oqmgr.8 | 427 +++ static/netbsd/man8/p.8 | 1 + static/netbsd/man8/pac.8 | 116 + static/netbsd/man8/pam.8 4.html | 79 + static/netbsd/man8/pam_afslog.8 | 84 + static/netbsd/man8/pam_chroot.8 | 95 + static/netbsd/man8/pam_deny.8 | 92 + static/netbsd/man8/pam_echo.8 | 94 + static/netbsd/man8/pam_exec.8 | 76 + static/netbsd/man8/pam_ftpusers.8 | 106 + static/netbsd/man8/pam_group.8 | 86 + static/netbsd/man8/pam_guest.8 | 99 + static/netbsd/man8/pam_krb5.8 | 277 ++ static/netbsd/man8/pam_ksu.8 | 122 + static/netbsd/man8/pam_lastlog.8 | 118 + static/netbsd/man8/pam_login_access.8 | 87 + static/netbsd/man8/pam_nologin.8 | 90 + static/netbsd/man8/pam_permit.8 | 75 + static/netbsd/man8/pam_radius.8 | 137 + static/netbsd/man8/pam_rhosts.8 | 95 + static/netbsd/man8/pam_rootok.8 | 75 + static/netbsd/man8/pam_securetty.8 | 92 + static/netbsd/man8/pam_self.8 | 96 + static/netbsd/man8/pam_skey.8 | 62 + static/netbsd/man8/pam_ssh.8 | 175 + static/netbsd/man8/pam_u2f.8 | 240 ++ static/netbsd/man8/pam_unix.8 | 206 ++ static/netbsd/man8/paxctl.8 | 120 + static/netbsd/man8/pbsdboot.8 | 61 + static/netbsd/man8/pcictl.8 | 194 ++ static/netbsd/man8/pcifs.8 | 86 + static/netbsd/man8/pcnfsd.8 | 217 ++ static/netbsd/man8/pdisk.8 | 240 ++ static/netbsd/man8/perfused.8 | 162 + static/netbsd/man8/pfctl.8 | 644 ++++ static/netbsd/man8/pflogd.8 | 231 ++ static/netbsd/man8/pfs.8 | 103 + static/netbsd/man8/pickup.8 | 143 + static/netbsd/man8/ping.8 | 478 +++ static/netbsd/man8/ping6.8 | 424 +++ static/netbsd/man8/pipe.8 | 494 +++ static/netbsd/man8/plainrsa-gen.8 | 138 + static/netbsd/man8/postinstall.8 | 207 ++ static/netbsd/man8/postlogd.8 | 113 + static/netbsd/man8/postscreen.8 | 484 +++ static/netbsd/man8/powerd.8 | 227 ++ static/netbsd/man8/pppd.8 | 2169 ++++++++++++ static/netbsd/man8/pppdump.8 | 66 + static/netbsd/man8/pppoe-discovery.8 | 86 + static/netbsd/man8/pppoectl.8 | 363 ++ static/netbsd/man8/pppstats.8 | 221 ++ static/netbsd/man8/proxymap.8 | 245 ++ static/netbsd/man8/psrset.8 | 122 + static/netbsd/man8/pstat.8 | 386 ++ static/netbsd/man8/pvchange.8 | 36 + static/netbsd/man8/pvck.8 | 35 + static/netbsd/man8/pvcreate.8 | 139 + static/netbsd/man8/pvdisplay.8 | 52 + static/netbsd/man8/pvmove.8 | 101 + static/netbsd/man8/pvremove.8 | 24 + static/netbsd/man8/pvresize.8 | 51 + static/netbsd/man8/pvs.8 | 80 + static/netbsd/man8/pvscan.8 | 36 + static/netbsd/man8/pwd_mkdb.8 | 219 ++ static/netbsd/man8/pxeboot.8 | 401 +++ static/netbsd/man8/qmgr.8 | 497 +++ static/netbsd/man8/qmqpd.8 | 216 ++ static/netbsd/man8/quot.8 | 96 + static/netbsd/man8/quotacheck.8 | 188 + static/netbsd/man8/quotaon.8 | 136 + static/netbsd/man8/quotarestore.8 | 76 + static/netbsd/man8/racoon.8 | 157 + static/netbsd/man8/racoonctl.8 | 228 ++ static/netbsd/man8/raidctl.8 | 1654 +++++++++ static/netbsd/man8/rarpd.8 | 105 + static/netbsd/man8/rbootd.8 | 154 + static/netbsd/man8/rc.8 4.html | 292 ++ static/netbsd/man8/rc.subr.8 4.html | 575 +++ static/netbsd/man8/rcorder.8 | 171 + static/netbsd/man8/rdate.8 | 73 + static/netbsd/man8/reboot.8 | 168 + static/netbsd/man8/renice.8 | 188 + static/netbsd/man8/repquota.8 | 106 + static/netbsd/man8/rescue.8 4.html | 94 + static/netbsd/man8/resize_ffs.8 | 144 + static/netbsd/man8/resize_lfs.8 | 85 + static/netbsd/man8/restore.8 | 562 +++ static/netbsd/man8/revnetgroup.8 | 143 + static/netbsd/man8/revoke.8 | 57 + static/netbsd/man8/rexecd.8 | 148 + static/netbsd/man8/rip6query.8 | 66 + static/netbsd/man8/rlogind.8 | 193 + static/netbsd/man8/rmt.8 | 203 ++ static/netbsd/man8/rndctl.8 | 185 + static/netbsd/man8/route.8 | 469 +++ static/netbsd/man8/route6d.8 | 241 ++ static/netbsd/man8/routed.8 | 724 ++++ static/netbsd/man8/rpc.bootparamd.8 | 74 + static/netbsd/man8/rpc.lockd.8 | 130 + static/netbsd/man8/rpc.rquotad.8 | 60 + static/netbsd/man8/rpc.rstatd.8 | 78 + static/netbsd/man8/rpc.rusersd.8 | 59 + static/netbsd/man8/rpc.rwalld.8 | 62 + static/netbsd/man8/rpc.sprayd.8 | 57 + static/netbsd/man8/rpc.statd.8 | 113 + static/netbsd/man8/rpc.yppasswdd.8 | 84 + static/netbsd/man8/rpcbind.8 | 172 + static/netbsd/man8/rpcinfo.8 | 356 ++ static/netbsd/man8/rshd.8 | 235 ++ static/netbsd/man8/rtadvd.8 | 214 ++ static/netbsd/man8/rtquery.8 | 128 + static/netbsd/man8/rtsold.8 | 68 + static/netbsd/man8/rump_cd9660.8 | 134 + static/netbsd/man8/rump_efs.8 | 134 + static/netbsd/man8/rump_ext2fs.8 | 134 + static/netbsd/man8/rump_fdesc.8 | 96 + static/netbsd/man8/rump_ffs.8 | 134 + static/netbsd/man8/rump_hfs.8 | 134 + static/netbsd/man8/rump_kernfs.8 | 96 + static/netbsd/man8/rump_lfs.8 | 134 + static/netbsd/man8/rump_msdos.8 | 134 + static/netbsd/man8/rump_nfs.8 | 110 + static/netbsd/man8/rump_ntfs.8 | 134 + static/netbsd/man8/rump_syspuffs.8 | 73 + static/netbsd/man8/rump_sysvbfs.8 | 134 + static/netbsd/man8/rump_tmpfs.8 | 96 + static/netbsd/man8/rump_udf.8 | 134 + static/netbsd/man8/rump_v7fs.8 | 134 + static/netbsd/man8/rwhod.8 | 160 + static/netbsd/man8/sa.8 | 257 ++ static/netbsd/man8/savecore.8 | 203 ++ static/netbsd/man8/sbkeygen.8 | 71 + static/netbsd/man8/sbtool.8 | 60 + static/netbsd/man8/scache.8 | 180 + static/netbsd/man8/scan_ffs.8 | 130 + static/netbsd/man8/schedctl.8 | 131 + static/netbsd/man8/scsictl.8 | 285 ++ static/netbsd/man8/sdpd.8 | 180 + static/netbsd/man8/service.8 | 206 ++ static/netbsd/man8/services_mkdb.8 | 114 + static/netbsd/man8/sesd.8 | 86 + static/netbsd/man8/setencstat.8 | 83 + static/netbsd/man8/setkey.8 | 866 +++++ static/netbsd/man8/setnetbootinfo.8 | 151 + static/netbsd/man8/setobjstat.8 | 69 + static/netbsd/man8/sftp-server.8 | 171 + static/netbsd/man8/sgivol.8 | 155 + static/netbsd/man8/showmount.8 | 93 + static/netbsd/man8/showq.8 | 127 + static/netbsd/man8/shutdown.8 | 255 ++ static/netbsd/man8/slapacl.8 | 205 ++ static/netbsd/man8/slapadd.8 | 218 ++ static/netbsd/man8/slapauth.8 | 152 + static/netbsd/man8/slapcat.8 | 203 ++ static/netbsd/man8/slapd.8 | 379 ++ static/netbsd/man8/slapdn.8 | 108 + static/netbsd/man8/slapindex.8 | 178 + static/netbsd/man8/slapmodify.8 | 222 ++ static/netbsd/man8/slappasswd.8 | 203 ++ static/netbsd/man8/slapschema.8 | 193 + static/netbsd/man8/slaptest.8 | 117 + static/netbsd/man8/slattach.8 | 164 + static/netbsd/man8/sliplogin.8 | 231 ++ static/netbsd/man8/smtp.8 | 1042 ++++++ static/netbsd/man8/smtpd.8 | 1314 +++++++ static/netbsd/man8/spawn.8 | 167 + static/netbsd/man8/spray.8 | 74 + static/netbsd/man8/ssh-keysign.8 | 92 + static/netbsd/man8/ssh-pkcs11-helper.8 | 72 + static/netbsd/man8/ssh-sk-helper.8 | 71 + static/netbsd/man8/sshd.8 | 1019 ++++++ static/netbsd/man8/stdethers.8 | 54 + static/netbsd/man8/stdhosts.8 | 58 + static/netbsd/man8/sti.8 | 73 + static/netbsd/man8/strfile.8 | 143 + static/netbsd/man8/string2key.8 | 87 + static/netbsd/man8/sun2amd.8 | 94 + static/netbsd/man8/sunlabel.8 | 244 ++ static/netbsd/man8/svhlabel.8 | 101 + static/netbsd/man8/swapctl.8 | 386 ++ static/netbsd/man8/sync.8 | 72 + static/netbsd/man8/sysctl.8 | 527 +++ static/netbsd/man8/sysinst.8 | 135 + static/netbsd/man8/syslogd.8 | 307 ++ static/netbsd/man8/tadpolectl.8 | 133 + static/netbsd/man8/talkd.8 | 111 + static/netbsd/man8/tbrconfig.8 | 170 + static/netbsd/man8/tcpdchk.8 | 68 + static/netbsd/man8/tcpdmatch.8 | 104 + static/netbsd/man8/tcpdrop.8 | 90 + static/netbsd/man8/telnetd.8 | 589 ++++ static/netbsd/man8/test_packets.8 | 13 + static/netbsd/man8/test_signatures.8 | 83 + static/netbsd/man8/tftp-proxy.8 | 141 + static/netbsd/man8/tftpd.8 | 252 ++ static/netbsd/man8/timed.8 | 279 ++ static/netbsd/man8/timedc.8 | 135 + static/netbsd/man8/tlsmgr.8 | 210 ++ static/netbsd/man8/tlsproxy.8 | 421 +++ static/netbsd/man8/tpctl.8 | 117 + static/netbsd/man8/tpm_changeownerauth.8 | 72 + static/netbsd/man8/tpm_clear.8 | 63 + static/netbsd/man8/tpm_createek.8 | 68 + static/netbsd/man8/tpm_getpubek.8 | 58 + static/netbsd/man8/tpm_nvdefine.8 | 245 ++ static/netbsd/man8/tpm_nvinfo.8 | 166 + static/netbsd/man8/tpm_nvread.8 | 195 ++ static/netbsd/man8/tpm_nvrelease.8 | 179 + static/netbsd/man8/tpm_nvwrite.8 | 201 ++ static/netbsd/man8/tpm_resetdalock.8 | 53 + static/netbsd/man8/tpm_restrictpubek.8 | 64 + static/netbsd/man8/tpm_revokeek.8 | 57 + static/netbsd/man8/tpm_selftest.8 | 60 + static/netbsd/man8/tpm_setactive.8 | 71 + static/netbsd/man8/tpm_setclearable.8 | 68 + static/netbsd/man8/tpm_setenable.8 | 71 + static/netbsd/man8/tpm_setoperatorauth.8 | 61 + static/netbsd/man8/tpm_setownable.8 | 68 + static/netbsd/man8/tpm_setpresence.8 | 84 + static/netbsd/man8/tpm_takeownership.8 | 61 + static/netbsd/man8/tprof.8 | 294 ++ static/netbsd/man8/trace.8 | 3 + static/netbsd/man8/traceroute.8 | 419 +++ static/netbsd/man8/traceroute6.8 | 177 + static/netbsd/man8/trivial-rewrite.8 | 330 ++ static/netbsd/man8/trpt.8 | 158 + static/netbsd/man8/ttyflags.8 | 88 + static/netbsd/man8/tunefs.8 | 212 ++ static/netbsd/man8/tzselect.8 | 126 + static/netbsd/man8/umbctl.8 | 162 + static/netbsd/man8/umcpmioctl.8 | 205 ++ static/netbsd/man8/umount.8 | 188 + static/netbsd/man8/unlink.8 | 58 + static/netbsd/man8/usbdevs.8 | 69 + static/netbsd/man8/user.8 | 115 + static/netbsd/man8/useradd.8 | 318 ++ static/netbsd/man8/userdel.8 | 168 + static/netbsd/man8/userinfo.8 | 87 + static/netbsd/man8/usermod.8 | 259 ++ static/netbsd/man8/utmp_update.8 | 66 + static/netbsd/man8/veriexec.8 4.html | 176 + static/netbsd/man8/veriexecctl.8 | 133 + static/netbsd/man8/veriexecgen.8 | 166 + static/netbsd/man8/verify.8 | 259 ++ static/netbsd/man8/verify_krb5_conf.8 | 97 + static/netbsd/man8/vgcfgbackup.8 | 34 + static/netbsd/man8/vgcfgrestore.8 | 46 + static/netbsd/man8/vgchange.8 | 154 + static/netbsd/man8/vgck.8 | 17 + static/netbsd/man8/vgconvert.8 | 41 + static/netbsd/man8/vgcreate.8 | 112 + static/netbsd/man8/vgdisplay.8 | 75 + static/netbsd/man8/vgexport.8 | 29 + static/netbsd/man8/vgextend.8 | 27 + static/netbsd/man8/vgimport.8 | 27 + static/netbsd/man8/vgimportclone.8 | 60 + static/netbsd/man8/vgmerge.8 | 31 + static/netbsd/man8/vgmknodes.8 | 19 + static/netbsd/man8/vgreduce.8 | 41 + static/netbsd/man8/vgremove.8 | 30 + static/netbsd/man8/vgrename.8 | 50 + static/netbsd/man8/vgs.8 | 91 + static/netbsd/man8/vgscan.8 | 30 + static/netbsd/man8/vgsplit.8 | 68 + static/netbsd/man8/vipw.8 | 120 + static/netbsd/man8/virecover.8 | 90 + static/netbsd/man8/virtual.8 | 360 ++ static/netbsd/man8/vnconfig.8 | 319 ++ static/netbsd/man8/wakeonlan.8 | 72 + static/netbsd/man8/wdogctl.8 | 194 ++ static/netbsd/man8/wg-keygen.8 | 81 + static/netbsd/man8/wg-userspace.8 | 105 + static/netbsd/man8/wgconfig.8 | 194 ++ static/netbsd/man8/wiconfig.8 | 189 + static/netbsd/man8/wire-test.8 | 85 + static/netbsd/man8/wizd.8 4.html | 78 + static/netbsd/man8/wlanctl.8 | 238 ++ static/netbsd/man8/wpa_background.8 | 84 + static/netbsd/man8/wpa_cli.8 | 219 ++ static/netbsd/man8/wpa_gui.8 | 60 + static/netbsd/man8/wpa_passphrase.8 | 40 + static/netbsd/man8/wpa_priv.8 | 120 + static/netbsd/man8/wpa_supplicant.8 | 562 +++ static/netbsd/man8/wsconscfg.8 | 182 + static/netbsd/man8/wsconsctl.8 | 208 ++ static/netbsd/man8/wsfontload.8 | 185 + static/netbsd/man8/wsmoused.8 | 199 ++ static/netbsd/man8/wsmuxctl.8 | 70 + static/netbsd/man8/ypbind.8 | 168 + static/netbsd/man8/ypinit.8 | 132 + static/netbsd/man8/yppoll.8 | 84 + static/netbsd/man8/yppush.8 | 66 + static/netbsd/man8/ypserv.8 | 145 + static/netbsd/man8/ypset.8 | 105 + static/netbsd/man8/yptest.8 | 44 + static/netbsd/man8/ypxfr.8 | 75 + static/netbsd/man8/zdb.8 | 351 ++ static/netbsd/man8/zdump.8 | 231 ++ static/netbsd/man8/zfs.8 | 3677 ++++++++++++++++++++ static/netbsd/man8/zic.8 | 975 ++++++ static/netbsd/man8/zpool.8 | 2045 +++++++++++ 675 files changed, 137319 insertions(+), 271 deletions(-) create mode 100644 static/netbsd/man8/MAKEDEV.8 4.html create mode 100644 static/netbsd/man8/MAKEDEV.local.8 4.html create mode 100644 static/netbsd/man8/RELEASE_NOTES-2.8 create mode 100644 static/netbsd/man8/RELEASE_NOTES-3.8 create mode 100644 static/netbsd/man8/ac.8 create mode 100644 static/netbsd/man8/accton.8 create mode 100644 static/netbsd/man8/acpidump.8 create mode 100644 static/netbsd/man8/afterboot.8 4.html create mode 100644 static/netbsd/man8/ahdilabel.8 create mode 100644 static/netbsd/man8/altboot.8 create mode 100644 static/netbsd/man8/altqd.8 create mode 100644 static/netbsd/man8/amd.8 create mode 100644 static/netbsd/man8/amldb.8 create mode 100644 static/netbsd/man8/amq.8 create mode 100644 static/netbsd/man8/amrctl.8 create mode 100644 static/netbsd/man8/anvil.8 create mode 100644 static/netbsd/man8/apm.8 create mode 100644 static/netbsd/man8/apmd.8 create mode 100644 static/netbsd/man8/apmlabel.8 create mode 100644 static/netbsd/man8/arp.8 create mode 100644 static/netbsd/man8/atactl.8 create mode 100644 static/netbsd/man8/atrun.8 create mode 100644 static/netbsd/man8/audit-packages.8 create mode 100644 static/netbsd/man8/authpf.8 create mode 100644 static/netbsd/man8/automount.8 create mode 100644 static/netbsd/man8/automount2amd.8 create mode 100644 static/netbsd/man8/automountd.8 create mode 100644 static/netbsd/man8/autounmountd.8 create mode 100644 static/netbsd/man8/bad144.8 create mode 100644 static/netbsd/man8/badsect.8 create mode 100644 static/netbsd/man8/binpatch.8 create mode 100644 static/netbsd/man8/binstall.8 create mode 100644 static/netbsd/man8/bioctl.8 create mode 100644 static/netbsd/man8/blkdiscard.8 create mode 100644 static/netbsd/man8/blocklistctl.8 create mode 100644 static/netbsd/man8/blocklistd.8 create mode 100644 static/netbsd/man8/boot.8 4.html create mode 100644 static/netbsd/man8/boot32.8 create mode 100644 static/netbsd/man8/boot_console.8 create mode 100644 static/netbsd/man8/bootmini2440.8 create mode 100644 static/netbsd/man8/bootpd.8 create mode 100644 static/netbsd/man8/bootpef.8 create mode 100644 static/netbsd/man8/bootpref.8 create mode 100644 static/netbsd/man8/bootptest.8 create mode 100644 static/netbsd/man8/bounce.8 create mode 100644 static/netbsd/man8/bozohttpd.8 create mode 100644 static/netbsd/man8/brconfig.8 create mode 100644 static/netbsd/man8/bta2dpd.8 create mode 100644 static/netbsd/man8/btattach.8 create mode 100644 static/netbsd/man8/btconfig.8 create mode 100644 static/netbsd/man8/btdevctl.8 create mode 100644 static/netbsd/man8/bthcid.8 create mode 100644 static/netbsd/man8/btpand.8 create mode 100644 static/netbsd/man8/canconfig.8 create mode 100644 static/netbsd/man8/catman.8 create mode 100644 static/netbsd/man8/ccdconfig.8 create mode 100644 static/netbsd/man8/certctl.8 create mode 100644 static/netbsd/man8/cgdconfig.8 create mode 100644 static/netbsd/man8/chat.8 create mode 100644 static/netbsd/man8/chkconfig.8 create mode 100644 static/netbsd/man8/chown.8 create mode 100644 static/netbsd/man8/chroot.8 create mode 100644 static/netbsd/man8/cleanup.8 create mode 100644 static/netbsd/man8/clri.8 create mode 100644 static/netbsd/man8/clvmd.8 create mode 100644 static/netbsd/man8/cnwctl.8 create mode 100644 static/netbsd/man8/compat_30.8 4.html create mode 100644 static/netbsd/man8/compat_bsdos.8 4.html create mode 100644 static/netbsd/man8/compat_freebsd.8 4.html create mode 100644 static/netbsd/man8/compat_linux.8 4.html create mode 100644 static/netbsd/man8/compat_netbsd32.8 4.html create mode 100644 static/netbsd/man8/compat_sunos.8 4.html create mode 100644 static/netbsd/man8/compat_ultrix.8 4.html create mode 100644 static/netbsd/man8/comsat.8 create mode 100644 static/netbsd/man8/cpuctl.8 create mode 100644 static/netbsd/man8/crash.8 create mode 100644 static/netbsd/man8/creds_msdos.8 4.html create mode 100644 static/netbsd/man8/cron.8 create mode 100644 static/netbsd/man8/cvsbug.8 create mode 100644 static/netbsd/man8/dbsym.8 create mode 100644 static/netbsd/man8/defer.8 create mode 100644 static/netbsd/man8/dev_mkdb.8 create mode 100644 static/netbsd/man8/devpubd.8 create mode 100644 static/netbsd/man8/dhclient-script.8 create mode 100644 static/netbsd/man8/dhclient.8 create mode 100644 static/netbsd/man8/dhcpcd-run-hooks.8 create mode 100644 static/netbsd/man8/dhcpcd.8 create mode 100644 static/netbsd/man8/dhcpd.8 create mode 100644 static/netbsd/man8/dhcrelay.8 create mode 100644 static/netbsd/man8/discard.8 create mode 100644 static/netbsd/man8/disklabel.8 create mode 100644 static/netbsd/man8/diskless.8 4.html create mode 100644 static/netbsd/man8/diskpart.8 create mode 100644 static/netbsd/man8/dkctl.8 create mode 100644 static/netbsd/man8/dkscan_bsdlabel.8 create mode 100644 static/netbsd/man8/dm.8 create mode 100644 static/netbsd/man8/dmctl.8 create mode 100644 static/netbsd/man8/dmesg.8 create mode 100644 static/netbsd/man8/dmesgfs.8 create mode 100644 static/netbsd/man8/dmsetup.8 create mode 100644 static/netbsd/man8/dnsblog.8 create mode 100644 static/netbsd/man8/dosboot.8 create mode 100644 static/netbsd/man8/download-vulnerability-list.8 create mode 100644 static/netbsd/man8/drtest.8 create mode 100644 static/netbsd/man8/drvctl.8 create mode 100644 static/netbsd/man8/dump.8 create mode 100644 static/netbsd/man8/dump_lfs.8 create mode 100644 static/netbsd/man8/dumpfs.8 create mode 100644 static/netbsd/man8/dumplfs.8 create mode 100644 static/netbsd/man8/eapol_test.8 create mode 100644 static/netbsd/man8/edquota.8 create mode 100644 static/netbsd/man8/eeprom.8 create mode 100644 static/netbsd/man8/efi.8 create mode 100644 static/netbsd/man8/elftosb.8 create mode 100644 static/netbsd/man8/emcfanctl.8 create mode 100644 static/netbsd/man8/envstat.8 create mode 100644 static/netbsd/man8/error.8 create mode 100644 static/netbsd/man8/etcupdate.8 create mode 100644 static/netbsd/man8/example.8 create mode 100644 static/netbsd/man8/extattrctl.8 create mode 100644 static/netbsd/man8/faithd.8 create mode 100644 static/netbsd/man8/fanoutfs.8 create mode 100644 static/netbsd/man8/fastboot.8 create mode 100644 static/netbsd/man8/fdisk.8 create mode 100644 static/netbsd/man8/fingerd.8 create mode 100644 static/netbsd/man8/fixmount.8 create mode 100644 static/netbsd/man8/flashctl.8 create mode 100644 static/netbsd/man8/flush.8 create mode 100644 static/netbsd/man8/format.8 create mode 100644 static/netbsd/man8/fsadm.8 create mode 100644 static/netbsd/man8/fsck.8 create mode 100644 static/netbsd/man8/fsck_ext2fs.8 create mode 100644 static/netbsd/man8/fsck_ffs.8 create mode 100644 static/netbsd/man8/fsck_lfs.8 create mode 100644 static/netbsd/man8/fsck_msdos.8 create mode 100644 static/netbsd/man8/fsck_udf.8 create mode 100644 static/netbsd/man8/fsck_v7fs.8 create mode 100644 static/netbsd/man8/fsdb.8 create mode 100644 static/netbsd/man8/fsinfo.8 create mode 100644 static/netbsd/man8/fsirand.8 create mode 100644 static/netbsd/man8/fssconfig.8 create mode 100644 static/netbsd/man8/fstyp.8 create mode 100644 static/netbsd/man8/ftp-proxy.8 create mode 100644 static/netbsd/man8/ftpd.8 create mode 100644 static/netbsd/man8/fusermount.8 create mode 100644 static/netbsd/man8/fwctl.8 create mode 100644 static/netbsd/man8/getNAME.8 create mode 100644 static/netbsd/man8/getencstat.8 create mode 100644 static/netbsd/man8/getty.8 create mode 100644 static/netbsd/man8/gpioctl.8 create mode 100644 static/netbsd/man8/gpt.8 create mode 100644 static/netbsd/man8/grfconfig.8 create mode 100644 static/netbsd/man8/group.8 create mode 100644 static/netbsd/man8/groupadd.8 create mode 100644 static/netbsd/man8/groupdel.8 create mode 100644 static/netbsd/man8/groupinfo.8 create mode 100644 static/netbsd/man8/groupmod.8 create mode 100644 static/netbsd/man8/gspa.8 create mode 100644 static/netbsd/man8/hdaudioctl.8 create mode 100644 static/netbsd/man8/hlfsd.8 create mode 100644 static/netbsd/man8/hostapd.8 create mode 100644 static/netbsd/man8/hostapd_cli.8 create mode 100644 static/netbsd/man8/hpcboot.8 4.html create mode 100644 static/netbsd/man8/hprop.8 create mode 100644 static/netbsd/man8/hpropd.8 create mode 100644 static/netbsd/man8/i2cscan.8 create mode 100644 static/netbsd/man8/ian.8 create mode 100644 static/netbsd/man8/iasl.8 create mode 100644 static/netbsd/man8/icfs.8 create mode 100644 static/netbsd/man8/id3fs.8 create mode 100644 static/netbsd/man8/identd.8 create mode 100644 static/netbsd/man8/ifconfig.8 create mode 100644 static/netbsd/man8/ifmcstat.8 create mode 100644 static/netbsd/man8/ifwatchd.8 create mode 100644 static/netbsd/man8/inetd.8 create mode 100644 static/netbsd/man8/init.8 create mode 100644 static/netbsd/man8/installboot.8 create mode 100644 static/netbsd/man8/intrctl.8 create mode 100644 static/netbsd/man8/intro.8 4.html create mode 100644 static/netbsd/man8/iopctl.8 create mode 100644 static/netbsd/man8/iostat.8 create mode 100644 static/netbsd/man8/ip6addrctl.8 create mode 100644 static/netbsd/man8/ipf.8 create mode 100644 static/netbsd/man8/ipfs.8 create mode 100644 static/netbsd/man8/ipfstat.8 create mode 100644 static/netbsd/man8/ipmon.8 create mode 100644 static/netbsd/man8/ipnat.8 create mode 100644 static/netbsd/man8/ippool.8 create mode 100644 static/netbsd/man8/iprop-log.8 create mode 100644 static/netbsd/man8/iprop.8 create mode 100644 static/netbsd/man8/ipscan.8 create mode 100644 static/netbsd/man8/ipwctl.8 create mode 100644 static/netbsd/man8/irdaattach.8 create mode 100644 static/netbsd/man8/iscsi-initiator.8 create mode 100644 static/netbsd/man8/iscsi-target.8 create mode 100644 static/netbsd/man8/iscsictl.8 create mode 100644 static/netbsd/man8/iscsid.8 create mode 100644 static/netbsd/man8/isibootd.8 create mode 100644 static/netbsd/man8/iteconfig.8 create mode 100644 static/netbsd/man8/iwictl.8 create mode 100644 static/netbsd/man8/kadmind.8 create mode 100644 static/netbsd/man8/kcm.8 create mode 100644 static/netbsd/man8/kdc.8 create mode 100644 static/netbsd/man8/kdigest.8 create mode 100644 static/netbsd/man8/keama.8 create mode 100644 static/netbsd/man8/kerberos.8 create mode 100644 static/netbsd/man8/kgmon.8 create mode 100644 static/netbsd/man8/kimpersonate.8 create mode 100644 static/netbsd/man8/kpasswdd.8 create mode 100644 static/netbsd/man8/kstash.8 create mode 100644 static/netbsd/man8/kvm_mkdb.8 create mode 100644 static/netbsd/man8/lastlogin.8 create mode 100644 static/netbsd/man8/ldconfig.8 create mode 100644 static/netbsd/man8/ldpd.8 create mode 100644 static/netbsd/man8/lfs_cleanerd.8 create mode 100644 static/netbsd/man8/link.8 create mode 100644 static/netbsd/man8/lloadd.8 create mode 100644 static/netbsd/man8/lmtp.8 create mode 100644 static/netbsd/man8/loadbsd.8 create mode 100644 static/netbsd/man8/local.8 create mode 100644 static/netbsd/man8/locate.updatedb.8 create mode 100644 static/netbsd/man8/lockstat.8 create mode 100644 static/netbsd/man8/lpc.8 create mode 100644 static/netbsd/man8/lpd.8 create mode 100644 static/netbsd/man8/lptctl.8 create mode 100644 static/netbsd/man8/luactl.8 create mode 100644 static/netbsd/man8/lvchange.8 create mode 100644 static/netbsd/man8/lvconvert.8 create mode 100644 static/netbsd/man8/lvcreate.8 create mode 100644 static/netbsd/man8/lvdisplay.8 create mode 100644 static/netbsd/man8/lvextend.8 create mode 100644 static/netbsd/man8/lvm.8 create mode 100644 static/netbsd/man8/lvm2create_initrd.8 create mode 100644 static/netbsd/man8/lvmchange.8 create mode 100644 static/netbsd/man8/lvmdiskscan.8 create mode 100644 static/netbsd/man8/lvmdump.8 create mode 100644 static/netbsd/man8/lvreduce.8 create mode 100644 static/netbsd/man8/lvremove.8 create mode 100644 static/netbsd/man8/lvrename.8 create mode 100644 static/netbsd/man8/lvresize.8 create mode 100644 static/netbsd/man8/lvs.8 create mode 100644 static/netbsd/man8/lvscan.8 create mode 100644 static/netbsd/man8/mDNSResponder.8 create mode 100644 static/netbsd/man8/mail.local.8 create mode 100644 static/netbsd/man8/mailwrapper.8 create mode 100644 static/netbsd/man8/makedbm.8 create mode 100644 static/netbsd/man8/makefs.8 create mode 100644 static/netbsd/man8/makekey.8 create mode 100644 static/netbsd/man8/makemandb.8 create mode 100644 static/netbsd/man8/makewhatis.8 create mode 100644 static/netbsd/man8/man.cgi.8 create mode 100644 static/netbsd/man8/man8.hpcarm/boot.8 3.html create mode 100644 static/netbsd/man8/man8.mac68k/boot.8 3.html create mode 100644 static/netbsd/man8/man8.macppc/boot.8 3.html create mode 100644 static/netbsd/man8/man8.macppc/ofwboot.8 3.html create mode 100644 static/netbsd/man8/man8.pmax/boot.8 2.html create mode 100644 static/netbsd/man8/man8.prep/boot.8 3.html create mode 100644 static/netbsd/man8/man8.sandpoint/altboot.8 3.html create mode 100644 static/netbsd/man8/man8.sgimips/boot.8 3.html create mode 100644 static/netbsd/man8/man8.sgimips/sgivol.8 3.html create mode 100644 static/netbsd/man8/man8.sparc/binstall.8 3.html create mode 100644 static/netbsd/man8/man8.sparc/boot.8 3.html create mode 100644 static/netbsd/man8/man8.sparc64/boot.8 3.html create mode 100644 static/netbsd/man8/man8.sun2/boot.8 3.html create mode 100644 static/netbsd/man8/man8.sun3/boot.8 3.html create mode 100644 static/netbsd/man8/man8.vax/boot.8 3.html create mode 100644 static/netbsd/man8/man8.vax/crash.8 2.html create mode 100644 static/netbsd/man8/man8.vax/drtest.8 3.html create mode 100644 static/netbsd/man8/man8.vax/format.8 3.html create mode 100644 static/netbsd/man8/man8.x68k/boot.8 3.html create mode 100644 static/netbsd/man8/man8.x68k/loadbsd.8 3.html create mode 100644 static/netbsd/man8/man8.x68k/newdisk.8 3.html create mode 100644 static/netbsd/man8/man8.x86/boot.8 3.html create mode 100644 static/netbsd/man8/man8.x86/boot_console.8 3.html create mode 100644 static/netbsd/man8/man8.x86/dosboot.8 3.html create mode 100644 static/netbsd/man8/man8.x86/mbr.8 4.html create mode 100644 static/netbsd/man8/man8.x86/multiboot.8 4.html create mode 100644 static/netbsd/man8/man8.x86/pxeboot.8 4.html create mode 100644 static/netbsd/man8/mandocd.8 create mode 100644 static/netbsd/man8/map-mbone.8 create mode 100644 static/netbsd/man8/master.8 create mode 100644 static/netbsd/man8/mbr.8 create mode 100644 static/netbsd/man8/mbrlabel.8 create mode 100644 static/netbsd/man8/mdconfig.8 create mode 100644 static/netbsd/man8/mdnsd.8 create mode 100644 static/netbsd/man8/mdsetimage.8 create mode 100644 static/netbsd/man8/memswitch.8 create mode 100644 static/netbsd/man8/mk-amd-map.8 create mode 100644 static/netbsd/man8/mkalias.8 create mode 100644 static/netbsd/man8/mkboot.8 create mode 100644 static/netbsd/man8/mkbootimage.8 create mode 100644 static/netbsd/man8/mkhybrid.8 create mode 100644 static/netbsd/man8/mkisofs.8 create mode 100644 static/netbsd/man8/mknetid.8 create mode 100644 static/netbsd/man8/mknod.8 create mode 100644 static/netbsd/man8/mld6query.8 create mode 100644 static/netbsd/man8/mlxctl.8 create mode 100644 static/netbsd/man8/mmcformat.8 create mode 100644 static/netbsd/man8/modload.8 create mode 100644 static/netbsd/man8/modstat.8 create mode 100644 static/netbsd/man8/modunload.8 create mode 100644 static/netbsd/man8/mopd.8 create mode 100644 static/netbsd/man8/mount.8 create mode 100644 static/netbsd/man8/mount_9p.8 create mode 100644 static/netbsd/man8/mount_ados.8 create mode 100644 static/netbsd/man8/mount_autofs.8 create mode 100644 static/netbsd/man8/mount_cd9660.8 create mode 100644 static/netbsd/man8/mount_chfs.8 create mode 100644 static/netbsd/man8/mount_efs.8 create mode 100644 static/netbsd/man8/mount_ext2fs.8 create mode 100644 static/netbsd/man8/mount_fdesc.8 create mode 100644 static/netbsd/man8/mount_ffs.8 create mode 100644 static/netbsd/man8/mount_filecore.8 create mode 100644 static/netbsd/man8/mount_hfs.8 create mode 100644 static/netbsd/man8/mount_kernfs.8 create mode 100644 static/netbsd/man8/mount_lfs.8 create mode 100644 static/netbsd/man8/mount_mfs.8 create mode 100644 static/netbsd/man8/mount_msdos.8 create mode 100644 static/netbsd/man8/mount_nfs.8 create mode 100644 static/netbsd/man8/mount_nilfs.8 create mode 100644 static/netbsd/man8/mount_ntfs.8 create mode 100644 static/netbsd/man8/mount_null.8 create mode 100644 static/netbsd/man8/mount_overlay.8 create mode 100644 static/netbsd/man8/mount_portal.8 create mode 100644 static/netbsd/man8/mount_procfs.8 create mode 100644 static/netbsd/man8/mount_psshfs.8 create mode 100644 static/netbsd/man8/mount_ptyfs.8 create mode 100644 static/netbsd/man8/mount_puffs.8 create mode 100644 static/netbsd/man8/mount_qemufwcfg.8 create mode 100644 static/netbsd/man8/mount_sysctlfs.8 create mode 100644 static/netbsd/man8/mount_sysvbfs.8 create mode 100644 static/netbsd/man8/mount_tmpfs.8 create mode 100644 static/netbsd/man8/mount_udf.8 create mode 100644 static/netbsd/man8/mount_umap.8 create mode 100644 static/netbsd/man8/mount_union.8 create mode 100644 static/netbsd/man8/mount_v7fs.8 create mode 100644 static/netbsd/man8/mount_zfs.8 create mode 100644 static/netbsd/man8/mountd.8 create mode 100644 static/netbsd/man8/moused.8 create mode 100644 static/netbsd/man8/mrinfo.8 create mode 100644 static/netbsd/man8/mrouted.8 create mode 100644 static/netbsd/man8/mscdlabel.8 create mode 100644 static/netbsd/man8/mtrace.8 create mode 100644 static/netbsd/man8/mtree.8 create mode 100644 static/netbsd/man8/multiboot.8 create mode 100644 static/netbsd/man8/nbfs.8 create mode 100644 static/netbsd/man8/ncdcs.8 create mode 100644 static/netbsd/man8/ndbootd.8 create mode 100644 static/netbsd/man8/ndp.8 create mode 100644 static/netbsd/man8/netgroup_mkdb.8 create mode 100644 static/netbsd/man8/newbtconf.8 create mode 100644 static/netbsd/man8/newdisk.8 create mode 100644 static/netbsd/man8/newfs.8 create mode 100644 static/netbsd/man8/newfs_ext2fs.8 create mode 100644 static/netbsd/man8/newfs_lfs.8 create mode 100644 static/netbsd/man8/newfs_msdos.8 create mode 100644 static/netbsd/man8/newfs_sysvbfs.8 create mode 100644 static/netbsd/man8/newfs_udf.8 create mode 100644 static/netbsd/man8/newfs_v7fs.8 create mode 100644 static/netbsd/man8/newsyslog.8 create mode 100644 static/netbsd/man8/nfsd.8 create mode 100644 static/netbsd/man8/nis.8 4.html create mode 100644 static/netbsd/man8/nologin.8 create mode 100644 static/netbsd/man8/npfctl.8 create mode 100644 static/netbsd/man8/npfd.8 create mode 100644 static/netbsd/man8/nslookup.8 create mode 100644 static/netbsd/man8/ntpdate.8 create mode 100644 static/netbsd/man8/ntptime.8 create mode 100644 static/netbsd/man8/ntptrace.8 create mode 100644 static/netbsd/man8/nvmectl.8 create mode 100644 static/netbsd/man8/nvmmctl.8 create mode 100644 static/netbsd/man8/ofctl.8 create mode 100644 static/netbsd/man8/ofwboot.8 create mode 100644 static/netbsd/man8/oqmgr.8 create mode 100644 static/netbsd/man8/p.8 create mode 100644 static/netbsd/man8/pac.8 create mode 100644 static/netbsd/man8/pam.8 4.html create mode 100644 static/netbsd/man8/pam_afslog.8 create mode 100644 static/netbsd/man8/pam_chroot.8 create mode 100644 static/netbsd/man8/pam_deny.8 create mode 100644 static/netbsd/man8/pam_echo.8 create mode 100644 static/netbsd/man8/pam_exec.8 create mode 100644 static/netbsd/man8/pam_ftpusers.8 create mode 100644 static/netbsd/man8/pam_group.8 create mode 100644 static/netbsd/man8/pam_guest.8 create mode 100644 static/netbsd/man8/pam_krb5.8 create mode 100644 static/netbsd/man8/pam_ksu.8 create mode 100644 static/netbsd/man8/pam_lastlog.8 create mode 100644 static/netbsd/man8/pam_login_access.8 create mode 100644 static/netbsd/man8/pam_nologin.8 create mode 100644 static/netbsd/man8/pam_permit.8 create mode 100644 static/netbsd/man8/pam_radius.8 create mode 100644 static/netbsd/man8/pam_rhosts.8 create mode 100644 static/netbsd/man8/pam_rootok.8 create mode 100644 static/netbsd/man8/pam_securetty.8 create mode 100644 static/netbsd/man8/pam_self.8 create mode 100644 static/netbsd/man8/pam_skey.8 create mode 100644 static/netbsd/man8/pam_ssh.8 create mode 100644 static/netbsd/man8/pam_u2f.8 create mode 100644 static/netbsd/man8/pam_unix.8 create mode 100644 static/netbsd/man8/paxctl.8 create mode 100644 static/netbsd/man8/pbsdboot.8 create mode 100644 static/netbsd/man8/pcictl.8 create mode 100644 static/netbsd/man8/pcifs.8 create mode 100644 static/netbsd/man8/pcnfsd.8 create mode 100644 static/netbsd/man8/pdisk.8 create mode 100644 static/netbsd/man8/perfused.8 create mode 100644 static/netbsd/man8/pfctl.8 create mode 100644 static/netbsd/man8/pflogd.8 create mode 100644 static/netbsd/man8/pfs.8 create mode 100644 static/netbsd/man8/pickup.8 create mode 100644 static/netbsd/man8/ping.8 create mode 100644 static/netbsd/man8/ping6.8 create mode 100644 static/netbsd/man8/pipe.8 create mode 100644 static/netbsd/man8/plainrsa-gen.8 create mode 100644 static/netbsd/man8/postinstall.8 create mode 100644 static/netbsd/man8/postlogd.8 create mode 100644 static/netbsd/man8/postscreen.8 create mode 100644 static/netbsd/man8/powerd.8 create mode 100644 static/netbsd/man8/pppd.8 create mode 100644 static/netbsd/man8/pppdump.8 create mode 100644 static/netbsd/man8/pppoe-discovery.8 create mode 100644 static/netbsd/man8/pppoectl.8 create mode 100644 static/netbsd/man8/pppstats.8 create mode 100644 static/netbsd/man8/proxymap.8 create mode 100644 static/netbsd/man8/psrset.8 create mode 100644 static/netbsd/man8/pstat.8 create mode 100644 static/netbsd/man8/pvchange.8 create mode 100644 static/netbsd/man8/pvck.8 create mode 100644 static/netbsd/man8/pvcreate.8 create mode 100644 static/netbsd/man8/pvdisplay.8 create mode 100644 static/netbsd/man8/pvmove.8 create mode 100644 static/netbsd/man8/pvremove.8 create mode 100644 static/netbsd/man8/pvresize.8 create mode 100644 static/netbsd/man8/pvs.8 create mode 100644 static/netbsd/man8/pvscan.8 create mode 100644 static/netbsd/man8/pwd_mkdb.8 create mode 100644 static/netbsd/man8/pxeboot.8 create mode 100644 static/netbsd/man8/qmgr.8 create mode 100644 static/netbsd/man8/qmqpd.8 create mode 100644 static/netbsd/man8/quot.8 create mode 100644 static/netbsd/man8/quotacheck.8 create mode 100644 static/netbsd/man8/quotaon.8 create mode 100644 static/netbsd/man8/quotarestore.8 create mode 100644 static/netbsd/man8/racoon.8 create mode 100644 static/netbsd/man8/racoonctl.8 create mode 100644 static/netbsd/man8/raidctl.8 create mode 100644 static/netbsd/man8/rarpd.8 create mode 100644 static/netbsd/man8/rbootd.8 create mode 100644 static/netbsd/man8/rc.8 4.html create mode 100644 static/netbsd/man8/rc.subr.8 4.html create mode 100644 static/netbsd/man8/rcorder.8 create mode 100644 static/netbsd/man8/rdate.8 create mode 100644 static/netbsd/man8/reboot.8 create mode 100644 static/netbsd/man8/renice.8 create mode 100644 static/netbsd/man8/repquota.8 create mode 100644 static/netbsd/man8/rescue.8 4.html create mode 100644 static/netbsd/man8/resize_ffs.8 create mode 100644 static/netbsd/man8/resize_lfs.8 create mode 100644 static/netbsd/man8/restore.8 create mode 100644 static/netbsd/man8/revnetgroup.8 create mode 100644 static/netbsd/man8/revoke.8 create mode 100644 static/netbsd/man8/rexecd.8 create mode 100644 static/netbsd/man8/rip6query.8 create mode 100644 static/netbsd/man8/rlogind.8 create mode 100644 static/netbsd/man8/rmt.8 create mode 100644 static/netbsd/man8/rndctl.8 create mode 100644 static/netbsd/man8/route.8 create mode 100644 static/netbsd/man8/route6d.8 create mode 100644 static/netbsd/man8/routed.8 create mode 100644 static/netbsd/man8/rpc.bootparamd.8 create mode 100644 static/netbsd/man8/rpc.lockd.8 create mode 100644 static/netbsd/man8/rpc.rquotad.8 create mode 100644 static/netbsd/man8/rpc.rstatd.8 create mode 100644 static/netbsd/man8/rpc.rusersd.8 create mode 100644 static/netbsd/man8/rpc.rwalld.8 create mode 100644 static/netbsd/man8/rpc.sprayd.8 create mode 100644 static/netbsd/man8/rpc.statd.8 create mode 100644 static/netbsd/man8/rpc.yppasswdd.8 create mode 100644 static/netbsd/man8/rpcbind.8 create mode 100644 static/netbsd/man8/rpcinfo.8 create mode 100644 static/netbsd/man8/rshd.8 create mode 100644 static/netbsd/man8/rtadvd.8 create mode 100644 static/netbsd/man8/rtquery.8 create mode 100644 static/netbsd/man8/rtsold.8 create mode 100644 static/netbsd/man8/rump_cd9660.8 create mode 100644 static/netbsd/man8/rump_efs.8 create mode 100644 static/netbsd/man8/rump_ext2fs.8 create mode 100644 static/netbsd/man8/rump_fdesc.8 create mode 100644 static/netbsd/man8/rump_ffs.8 create mode 100644 static/netbsd/man8/rump_hfs.8 create mode 100644 static/netbsd/man8/rump_kernfs.8 create mode 100644 static/netbsd/man8/rump_lfs.8 create mode 100644 static/netbsd/man8/rump_msdos.8 create mode 100644 static/netbsd/man8/rump_nfs.8 create mode 100644 static/netbsd/man8/rump_ntfs.8 create mode 100644 static/netbsd/man8/rump_syspuffs.8 create mode 100644 static/netbsd/man8/rump_sysvbfs.8 create mode 100644 static/netbsd/man8/rump_tmpfs.8 create mode 100644 static/netbsd/man8/rump_udf.8 create mode 100644 static/netbsd/man8/rump_v7fs.8 create mode 100644 static/netbsd/man8/rwhod.8 create mode 100644 static/netbsd/man8/sa.8 create mode 100644 static/netbsd/man8/savecore.8 create mode 100644 static/netbsd/man8/sbkeygen.8 create mode 100644 static/netbsd/man8/sbtool.8 create mode 100644 static/netbsd/man8/scache.8 create mode 100644 static/netbsd/man8/scan_ffs.8 create mode 100644 static/netbsd/man8/schedctl.8 create mode 100644 static/netbsd/man8/scsictl.8 create mode 100644 static/netbsd/man8/sdpd.8 create mode 100644 static/netbsd/man8/service.8 create mode 100644 static/netbsd/man8/services_mkdb.8 create mode 100644 static/netbsd/man8/sesd.8 create mode 100644 static/netbsd/man8/setencstat.8 create mode 100644 static/netbsd/man8/setkey.8 create mode 100644 static/netbsd/man8/setnetbootinfo.8 create mode 100644 static/netbsd/man8/setobjstat.8 create mode 100644 static/netbsd/man8/sftp-server.8 create mode 100644 static/netbsd/man8/sgivol.8 create mode 100644 static/netbsd/man8/showmount.8 create mode 100644 static/netbsd/man8/showq.8 create mode 100644 static/netbsd/man8/shutdown.8 create mode 100644 static/netbsd/man8/slapacl.8 create mode 100644 static/netbsd/man8/slapadd.8 create mode 100644 static/netbsd/man8/slapauth.8 create mode 100644 static/netbsd/man8/slapcat.8 create mode 100644 static/netbsd/man8/slapd.8 create mode 100644 static/netbsd/man8/slapdn.8 create mode 100644 static/netbsd/man8/slapindex.8 create mode 100644 static/netbsd/man8/slapmodify.8 create mode 100644 static/netbsd/man8/slappasswd.8 create mode 100644 static/netbsd/man8/slapschema.8 create mode 100644 static/netbsd/man8/slaptest.8 create mode 100644 static/netbsd/man8/slattach.8 create mode 100644 static/netbsd/man8/sliplogin.8 create mode 100644 static/netbsd/man8/smtp.8 create mode 100644 static/netbsd/man8/smtpd.8 create mode 100644 static/netbsd/man8/spawn.8 create mode 100644 static/netbsd/man8/spray.8 create mode 100644 static/netbsd/man8/ssh-keysign.8 create mode 100644 static/netbsd/man8/ssh-pkcs11-helper.8 create mode 100644 static/netbsd/man8/ssh-sk-helper.8 create mode 100644 static/netbsd/man8/sshd.8 create mode 100644 static/netbsd/man8/stdethers.8 create mode 100644 static/netbsd/man8/stdhosts.8 create mode 100644 static/netbsd/man8/sti.8 create mode 100644 static/netbsd/man8/strfile.8 create mode 100644 static/netbsd/man8/string2key.8 create mode 100644 static/netbsd/man8/sun2amd.8 create mode 100644 static/netbsd/man8/sunlabel.8 create mode 100644 static/netbsd/man8/svhlabel.8 create mode 100644 static/netbsd/man8/swapctl.8 create mode 100644 static/netbsd/man8/sync.8 create mode 100644 static/netbsd/man8/sysctl.8 create mode 100644 static/netbsd/man8/sysinst.8 create mode 100644 static/netbsd/man8/syslogd.8 create mode 100644 static/netbsd/man8/tadpolectl.8 create mode 100644 static/netbsd/man8/talkd.8 create mode 100644 static/netbsd/man8/tbrconfig.8 create mode 100644 static/netbsd/man8/tcpdchk.8 create mode 100644 static/netbsd/man8/tcpdmatch.8 create mode 100644 static/netbsd/man8/tcpdrop.8 create mode 100644 static/netbsd/man8/telnetd.8 create mode 100644 static/netbsd/man8/test_packets.8 create mode 100644 static/netbsd/man8/test_signatures.8 create mode 100644 static/netbsd/man8/tftp-proxy.8 create mode 100644 static/netbsd/man8/tftpd.8 create mode 100644 static/netbsd/man8/timed.8 create mode 100644 static/netbsd/man8/timedc.8 create mode 100644 static/netbsd/man8/tlsmgr.8 create mode 100644 static/netbsd/man8/tlsproxy.8 create mode 100644 static/netbsd/man8/tpctl.8 create mode 100644 static/netbsd/man8/tpm_changeownerauth.8 create mode 100644 static/netbsd/man8/tpm_clear.8 create mode 100644 static/netbsd/man8/tpm_createek.8 create mode 100644 static/netbsd/man8/tpm_getpubek.8 create mode 100644 static/netbsd/man8/tpm_nvdefine.8 create mode 100644 static/netbsd/man8/tpm_nvinfo.8 create mode 100644 static/netbsd/man8/tpm_nvread.8 create mode 100644 static/netbsd/man8/tpm_nvrelease.8 create mode 100644 static/netbsd/man8/tpm_nvwrite.8 create mode 100644 static/netbsd/man8/tpm_resetdalock.8 create mode 100644 static/netbsd/man8/tpm_restrictpubek.8 create mode 100644 static/netbsd/man8/tpm_revokeek.8 create mode 100644 static/netbsd/man8/tpm_selftest.8 create mode 100644 static/netbsd/man8/tpm_setactive.8 create mode 100644 static/netbsd/man8/tpm_setclearable.8 create mode 100644 static/netbsd/man8/tpm_setenable.8 create mode 100644 static/netbsd/man8/tpm_setoperatorauth.8 create mode 100644 static/netbsd/man8/tpm_setownable.8 create mode 100644 static/netbsd/man8/tpm_setpresence.8 create mode 100644 static/netbsd/man8/tpm_takeownership.8 create mode 100644 static/netbsd/man8/tprof.8 create mode 100644 static/netbsd/man8/trace.8 create mode 100644 static/netbsd/man8/traceroute.8 create mode 100644 static/netbsd/man8/traceroute6.8 create mode 100644 static/netbsd/man8/trivial-rewrite.8 create mode 100644 static/netbsd/man8/trpt.8 create mode 100644 static/netbsd/man8/ttyflags.8 create mode 100644 static/netbsd/man8/tunefs.8 create mode 100644 static/netbsd/man8/tzselect.8 create mode 100644 static/netbsd/man8/umbctl.8 create mode 100644 static/netbsd/man8/umcpmioctl.8 create mode 100644 static/netbsd/man8/umount.8 create mode 100644 static/netbsd/man8/unlink.8 create mode 100644 static/netbsd/man8/usbdevs.8 create mode 100644 static/netbsd/man8/user.8 create mode 100644 static/netbsd/man8/useradd.8 create mode 100644 static/netbsd/man8/userdel.8 create mode 100644 static/netbsd/man8/userinfo.8 create mode 100644 static/netbsd/man8/usermod.8 create mode 100644 static/netbsd/man8/utmp_update.8 create mode 100644 static/netbsd/man8/veriexec.8 4.html create mode 100644 static/netbsd/man8/veriexecctl.8 create mode 100644 static/netbsd/man8/veriexecgen.8 create mode 100644 static/netbsd/man8/verify.8 create mode 100644 static/netbsd/man8/verify_krb5_conf.8 create mode 100644 static/netbsd/man8/vgcfgbackup.8 create mode 100644 static/netbsd/man8/vgcfgrestore.8 create mode 100644 static/netbsd/man8/vgchange.8 create mode 100644 static/netbsd/man8/vgck.8 create mode 100644 static/netbsd/man8/vgconvert.8 create mode 100644 static/netbsd/man8/vgcreate.8 create mode 100644 static/netbsd/man8/vgdisplay.8 create mode 100644 static/netbsd/man8/vgexport.8 create mode 100644 static/netbsd/man8/vgextend.8 create mode 100644 static/netbsd/man8/vgimport.8 create mode 100644 static/netbsd/man8/vgimportclone.8 create mode 100644 static/netbsd/man8/vgmerge.8 create mode 100644 static/netbsd/man8/vgmknodes.8 create mode 100644 static/netbsd/man8/vgreduce.8 create mode 100644 static/netbsd/man8/vgremove.8 create mode 100644 static/netbsd/man8/vgrename.8 create mode 100644 static/netbsd/man8/vgs.8 create mode 100644 static/netbsd/man8/vgscan.8 create mode 100644 static/netbsd/man8/vgsplit.8 create mode 100644 static/netbsd/man8/vipw.8 create mode 100644 static/netbsd/man8/virecover.8 create mode 100644 static/netbsd/man8/virtual.8 create mode 100644 static/netbsd/man8/vnconfig.8 create mode 100644 static/netbsd/man8/wakeonlan.8 create mode 100644 static/netbsd/man8/wdogctl.8 create mode 100644 static/netbsd/man8/wg-keygen.8 create mode 100644 static/netbsd/man8/wg-userspace.8 create mode 100644 static/netbsd/man8/wgconfig.8 create mode 100644 static/netbsd/man8/wiconfig.8 create mode 100644 static/netbsd/man8/wire-test.8 create mode 100644 static/netbsd/man8/wizd.8 4.html create mode 100644 static/netbsd/man8/wlanctl.8 create mode 100644 static/netbsd/man8/wpa_background.8 create mode 100644 static/netbsd/man8/wpa_cli.8 create mode 100644 static/netbsd/man8/wpa_gui.8 create mode 100644 static/netbsd/man8/wpa_passphrase.8 create mode 100644 static/netbsd/man8/wpa_priv.8 create mode 100644 static/netbsd/man8/wpa_supplicant.8 create mode 100644 static/netbsd/man8/wsconscfg.8 create mode 100644 static/netbsd/man8/wsconsctl.8 create mode 100644 static/netbsd/man8/wsfontload.8 create mode 100644 static/netbsd/man8/wsmoused.8 create mode 100644 static/netbsd/man8/wsmuxctl.8 create mode 100644 static/netbsd/man8/ypbind.8 create mode 100644 static/netbsd/man8/ypinit.8 create mode 100644 static/netbsd/man8/yppoll.8 create mode 100644 static/netbsd/man8/yppush.8 create mode 100644 static/netbsd/man8/ypserv.8 create mode 100644 static/netbsd/man8/ypset.8 create mode 100644 static/netbsd/man8/yptest.8 create mode 100644 static/netbsd/man8/ypxfr.8 create mode 100644 static/netbsd/man8/zdb.8 create mode 100644 static/netbsd/man8/zdump.8 create mode 100644 static/netbsd/man8/zfs.8 create mode 100644 static/netbsd/man8/zic.8 create mode 100644 static/netbsd/man8/zpool.8 (limited to 'static/netbsd/man8') diff --git a/static/netbsd/man8/MAKEDEV.8 4.html b/static/netbsd/man8/MAKEDEV.8 4.html new file mode 100644 index 00000000..786c20ed --- /dev/null +++ b/static/netbsd/man8/MAKEDEV.8 4.html @@ -0,0 +1,815 @@ + + + + + + +
MAKEDEV(8)System Manager's ManualMAKEDEV(8)
+
+
+

+

MAKEDEV — create + system and device special files

+
+
+

+ + + + + +
MAKEDEV[-fMsu] [-m + mknod] [-p + pax] [-t + mtree] {special | + device} [...]
+
+
+

+

MAKEDEV is used to create system and + device special files. As arguments it takes the names of known devices, like + sd0, or of special targets, like + all or std, which create a + collection of device special files, or local, which + invokes MAKEDEV.local(8) with the + all argument.

+

The script is in /dev/MAKEDEV. Devices are + created in the current working directory; in normal use, + MAKEDEV should be invoked with + /dev as the current working directory.

+

Supported options are:

+
+
+
Force permissions to be updated on existing devices. This works only if + MAKEDEV invokes mknod(8); it is + not compatible with the -p, + -s, or -t options.
+
+
Create a memory file system, union mounted over the current directory, to + contain the device special files. The memory file system is created using + mount_tmpfs(8) or mount_mfs(8), in + that order of preference. +

If the -M flag is specified more than + once, then MAKEDEV assumes that it is being + invoked from init(8) to populate a memory file system + for /dev. In this case, + MAKEDEV will also redirect its output to the + system console.

+
+
+ mknod
+
Force the use of mknod(8), and specify the name or path + to the mknod(8) program. [Usually, $TOOL_MKNOD or + mknod.]
+
+ pax
+
Force the use of pax(1), and specify the name or path to + the pax(1) program. [Usually, $TOOL_PAX or pax.]
+
+
Generate an mtree(8) specfile instead of creating + devices.
+
+ mtree
+
Force the use of mtree(8), and specify the name or path + to the mtree(8) program. [Usually, $TOOL_MTREE or + mtree.]
+
+
Don't re-create devices that already exist.
+
+

MAKEDEV has several possible methods of + creating device nodes:

+
    +
  • By invoking the mknod(8) command once for each device + node. This is the traditional method, but it is slow because each device + node is created using a new process. +

    The -m option forces + MAKEDEV to use the mknod(8) + method.

    +
    • +
  • By internally creating a specfile in a format usable by + mtree(8), and providing the specfile on standard input + to a pax(1) or mtree(8) command, + invoked with options that request it to create the device nodes as well as + any necessary subdirectories. This is much faster than creating device + nodes with mknod(8), because it requires much fewer + processes; however, it's not compatible with the + -f option. +

    The -p or -t + options force MAKEDEV to use the + pax(1) or mtree(8) methods.

    +
    • +
  • If the -s option is specified, then + MAKEDEV will not create device nodes at all, but + will output a specfile in a format usable by + mtree(8).
    • +
+

The -m, -p, + -s, and -t flags are + mutually exclusive. If none of these flags is specified, then + MAKEDEV will use mtree(8), + pax(1), or mknod(8), in that order of + preference, depending on which commands appear to be available and usable. + In normal use, it's expected that mtree(8) will be + available, so it will be chosen. If MAKEDEV is + invoked by init(8), it's expected that + mtree(8) will not be available, but + pax(1) may be available.

+

The special targets supported on NetBSD + are:

+

+
+
all
+
Makes all known devices, including local devices. Tries to make the + 'standard' number of each type.
+
init
+
A set of devices that is used for MFS /dev by init. May be equal to + ``all''.
+
floppy
+
Devices to be put on install floppies
+
ramdisk
+
Devices to be put into INSTALL kernel ramdisks.
+
std
+
Standard devices
+
local
+
Configuration specific devices
+
lua
+
Lua device
+
wscons
+
Make wscons devices
+
usbs
+
Make USB devices
+
+

Please note that any hash marks (“#”) in the + following list of supported device targets must be replaced by digits when + calling MAKEDEV:

+
+
Tapes:
+
+
+
st#
+
SCSI tapes, see st(4)
+
wt#
+
QIC-interfaced (e.g. not SCSI) 3M cartridge tape, see + wt(4)
+
ht#
+
MASSBUS TM03 and TU??, see vax/ht(4)
+
mt#
+
MSCP tapes (e.g. TU81, TK50), see vax/mt(4)
+
tm#
+
UNIBUS TM11 and TE10 emulations (e.g. Emulex TC-11), see + vax/tm(4)
+
ts#
+
UNIBUS TS11, see vax/ts(4)
+
ut#
+
UNIBUS TU45 emulations (e.g. si 9700), see + vax/ut(4)
+
uu#
+
TU58 cassettes on DL11 controller, see + vax/uu(4)
+
+
+
Disks:
+
+
+
dk#
+
Wedge disk slices, see dk(4)
+
ccd#
+
Concatenated disk devices, see ccd(4)
+
cd#
+
SCSI or ATAPI CD-ROM, see cd(4)
+
cgd#
+
Cryptographic disk devices, see cgd(4)
+
raid#
+
RAIDframe disk devices, see raid(4)
+
sd#
+
SCSI disks, see sd(4)
+
wd#
+
``winchester'' disk drives (ST506,IDE,ESDI,RLL,...), see + wd(4)
+
bmd#
+
Nereid bank memory disks, see x68k/bmd(4)
+
ed#
+
IBM PS/2 ESDI disk devices, see edc(4)
+
fd#
+
``floppy'' disk drives (3 1/2", 5 1/4"), see + amiga/fdc(4), sparc64/fdc(4), + x86/fdc(4)
+
fss#
+
Files system snapshot devices, see fss(4)
+
gdrom#
+
Dreamcast ``gigadisc'' CD-ROM drive, see + dreamcast/gdrom(4)
+
hk#
+
UNIBUS RK06 and RK07, see vax/hk(4)
+
hp#
+
MASSBUS RM??, see vax/hp(4)
+
ld#
+
Logical disk devices (e.g., hardware RAID), see + ld(4)
+
mcd#
+
Mitsumi CD-ROM, see mcd(4)
+
md#
+
Memory pseudo-disk devices, see md(4)
+
ofdisk#
+
OpenFirmware disk devices
+
ra#
+
MSCP disks (RA??, RD??)
+
rb#
+
730 IDC w/ RB80 and/or RB02
+
rd#
+
HDC9224 RD disks on VS2000, see hp300/rd(4)
+
rl#
+
UNIBUS RL02, see vax/rl(4)
+
rx#
+
MSCP floppy disk (RX33/50/...)
+
up#
+
Other UNIBUS devices (e.g. on Emulex SC-21V controller), see + vax/up(4)
+
vnd#
+
``file'' pseudo-disks, see vnd(4)
+
xbd#
+
Xen virtual disks, see xbd(4)
+
xd#
+
Xylogic 753/7053 disks, see sparc/xd(4)
+
xy#
+
Xylogic 450/451 disks, see sparc/xy(4)
+
+
+
Pointing devices:
+
+
+
wsmouse#
+
wscons mouse events, see wsmouse(4)
+
lms#
+
Logitech bus mouse, see i386/lms(4)
+
mms#
+
Microsoft bus mouse, see dreamcast/mms(4), + i386/mms(4)
+
qms#
+
``quadrature mouse'', see acorn32/qms(4)
+
pms#
+
PS/2 mouse
+
mouse
+
Mouse (provides events, for X11)
+
+
+
Keyboard devices:
+
+
+
wskbd#
+
wscons keyboard events, see wskbd(4)
+
kbd
+
Raw keyboard (provides events, for X11), see + sparc/kbd(4), sun2/kbd(4), + sun3/kbd(4)
+
kbdctl
+
Keyboard control
+
+
+
Terminals/Console ports:
+
+
+
tty[01]#
+
Standard serial ports, see tty(4)
+
tty0#
+
SB1250 (``sbscn'') serial ports (sbmips), see + tty(4)
+
ttyE#
+
wscons - Workstation console (``wscons'') glass-tty emulators
+
ttyCZ?
+
Cyclades-Z multiport serial boards. Each ``unit'' makes 64 ports., see + cz(4)
+
ttyCY?
+
Cyclom-Y multiport serial boards. Each ``unit'' makes 32 ports., see + cy(4)
+
ttye#
+
ITE bitmapped consoles, see amiga/ite(4)
+
ttyv0
+
pccons
+
ttyC?
+
NS16550 (``com'') serial ports
+
ttyS#
+
SA1110 serial port (hpcarm)
+
ttyTX?
+
TX39 internal serial ports (hpcmips)
+
ttyB?
+
DEC 3000 ZS8530 (``scc'') serial ports (alpha)
+
ttyA#
+
Mfc serial ports (amiga)
+
ttyB#
+
Msc serial ports (amiga)
+
ttyC#
+
Com style serial ports (DraCo, HyperCom) (amiga) On the DraCo, units 0 + and 1 are the built-in ``modem'' and ``mouse'' ports, if + configured.
+
ttyA0
+
8530 Channel A (formerly ser02) (atari)
+
ttyA1
+
8530 Channel B (formerly mdm02) (atari)
+
ttyB0
+
UART on first 68901 (formerly mdm01) (atari)
+
ixpcom
+
IXP12x0 COM ports
+
epcom
+
EP93xx COM ports
+
plcom
+
ARM PL01[01] serial ports
+
wmcom
+
EPOC Windermere COM ports
+
ttyM?
+
HP200/300 4 port serial mux interface (hp300)
+
ttya
+
``ttya'' system console (luna68k)
+
ttyb
+
Second system serial port (luna68k)
+
tty#
+
Onboard serial ports (mvme68k) On the mvme147 these are: ttyZ1, ttyZ2 + and ttyZ3. On the mvme167, and '177: ttyC1, ttyC2 and ttyC3. Note that + tty[CZ]0 is grabbed by the console device so is not created by + default, see tty(4)
+
dc#
+
PMAX 4 channel serial interface (kbd, mouse, modem, printer)
+
scc#
+
82530 serial interface (pmax)
+
ttyZ#
+
Zilog 8530 (``zstty'') serial ports, see + zstty(4)
+
tty[abcd]
+
Built-in serial ports (sparc)
+
tty#
+
Z88530 serial controllers (sparc64), see tty(4)
+
ttyh#
+
SAB82532 serial controllers (sparc64), see + sparc64/sab(4)
+
tty[a-j]
+
Built-in serial ports (sun2, sun3)
+
ttyC?
+
pccons (arc)
+
dz#
+
UNIBUS DZ11 and DZ32 (vax), see emips/dz(4), + vax/dz(4)
+
dh#
+
UNIBUS DH11 and emulations (e.g. Able DMAX, Emulex CS-11) (vax), see + vax/dh(4)
+
dmf#
+
UNIBUS DMF32 (vax), see vax/dmf(4)
+
dhu#
+
UNIBUS DHU11 (vax), see vax/dhu(4)
+
dmz#
+
UNIBUS DMZ32 (vax), see vax/dmz(4)
+
dl#
+
UNIBUS DL11 (vax), see vax/dl(4)
+
xencons
+
Xen virtual console
+
+
+
Terminal multiplexors:
+
+
+
dc#
+
4 channel serial interface (keyboard, mouse, modem, printer)
+
dh#
+
UNIBUS DH11 and emulations (e.g. Able DMAX, Emulex CS-11), see + vax/dh(4)
+
dhu#
+
UNIBUS DHU11, see vax/dhu(4)
+
dl#
+
UNIBUS DL11, see vax/dl(4)
+
dmf#
+
UNIBUS DMF32, see vax/dmf(4)
+
dmz#
+
UNIBUS DMZ32, see vax/dmz(4)
+
dz#
+
UNIBUS DZ11 and DZ32, see emips/dz(4), + vax/dz(4)
+
scc#
+
82530 serial interface
+
+
+
Call units:
+
+
+
dn#
+
UNIBUS DN11 and emulations (e.g. Able Quadracall), see + vax/dn(4)
+
+
+
Pseudo terminals:
+
+
+
ptm
+
Pty multiplexor device, and pts directory, see + ptm(4)
+
pty#
+
Set of 16 master and slave pseudo terminals, see + pty(4)
+
opty
+
First 16 ptys, to save inodes on install media
+
ipty
+
First 2 ptys, for install media use only
+
+
+
Printers:
+
+
+
arcpp#
+
Archimedes parallel port
+
lpt#
+
Stock lp, see lpt(4), + acorn32/lpt(4), mvme68k/lpt(4), + x86/lpt(4)
+
lpa#
+
Interruptless lp
+
par#
+
Amiga motherboard parallel port
+
cpi#
+
Macintosh Nubus CSI parallel printer card, see + mac68k/cpi(4)
+
+
+
USB devices:
+
+
+
usb#
+
USB control devices, see usb(4)
+
uhid#
+
USB generic HID devices, see uhid(4)
+
ulpt#
+
USB printer devices, see ulpt(4)
+
ugen#
+
USB generic devices, see ugen(4)
+
uscanner#
+
USB scanners, see uscanner(4)
+
ttyHS#
+
USB Option N.V. modems
+
ttyU#
+
USB modems, see ucom(4)
+
ttyY#
+
USB serial adapters
+
+
+
Video devices:
+
+
+
bwtwo#
+
Monochromatic frame buffer, see sparc/bwtwo(4), + sun2/bwtwo(4), sun3/bwtwo(4)
+
cgtwo#
+
8-bit color frame buffer, see sparc/cgtwo(4), + sun3/cgtwo(4)
+
cgthree#
+
8-bit color frame buffer, see sparc/cgthree(4)
+
cgfour#
+
8-bit color frame buffer, see sparc/cgfour(4), + sun3/cgfour(4)
+
cgsix#
+
Accelerated 8-bit color frame buffer, see + sparc/cgsix(4)
+
cgeight#
+
24-bit color frame buffer, see sparc/cgeight(4)
+
etvme
+
Tseng et-compatible cards on VME (atari)
+
ik#
+
UNIBUS interface to Ikonas frame buffer, see + vax/ik(4)
+
leo
+
Circad Leonardo VME-bus true color (atari)
+
ps#
+
UNIBUS interface to Picture System 2, see + vax/ps(4)
+
qv#
+
QVSS (MicroVAX) display
+
tcx#
+
Accelerated 8/24-bit color frame buffer, see + sparc/tcx(4)
+
+
+
Maple bus devices:
+
+
+
maple
+
Maple bus control devices, see + dreamcast/maple(4)
+
mlcd#
+
Maple bus LCD devices, see dreamcast/mlcd(4)
+
mmem#
+
Maple bus storage devices, see + dreamcast/mmem(4)
+
+
+
IEEE1394 bus devices:
+
+
+
fw#
+
IEEE1394 bus generic node access devices
+
fwmem#
+
IEEE1394 bus physical memory of the remote node access devices
+
+
+
Special purpose devices:
+
+
+
ad#
+
UNIBUS interface to Data Translation A/D converter, see + vax/ad(4)
+
agp#
+
AGP GART devices, see agp(4)
+
altq
+
ALTQ control interface, see altq(4)
+
amr#
+
AMI MegaRaid control device, see amr(4)
+
apm
+
Power management device, see i386/apm(4)
+
audio#
+
Audio devices, see audio(4)
+
bell#
+
OPM bell device (x68k)
+
bktr
+
Brooktree 848/849/878/879 based TV cards, see + bktr(4)
+
bpf
+
Packet filter, see bpf(4)
+
bthub
+
Bluetooth Device Hub control interface, see + bthub(4)
+
cfs#
+
Coda file system device
+
ch#
+
SCSI media changer, see ch(4)
+
cir#
+
Consumer IR, see cir(4)
+
clockctl
+
Clock control for non root users, see + clockctl(4)
+
cpuctl
+
CPU control
+
crypto
+
Hardware crypto access driver, see crypto(4)
+
dmoverio
+
Hardware-assisted data movers, see dmoverio(4)
+
dpt#
+
DPT/Adaptec EATA RAID management interface, see + dpt(4)
+
dpti#
+
DPT/Adaptec I2O RAID management interface, see + dpti(4)
+
drm#
+
Direct Rendering Manager interface, see drm(4)
+
dtv#
+
Digital TV interface, see dtv(4)
+
fb#
+
PMAX generic framebuffer pseudo-device
+
fd
+
File descriptors
+
gpiopps#
+
1PPS signals on GPIO pins, see gpiopps(4)
+
grf#
+
Graphics frame buffer device, see amiga/grf(4)
+
hdaudio#
+
High Definition audio control device, see + hdaudio(4)
+
hdmicec#
+
HDMI CEC devices
+
hil
+
HP300 HIL input devices, see hil(4)
+
icp
+
ICP-Vortex/Intel RAID control interface, see + icp(4)
+
iic#
+
IIC bus device, see iic(4)
+
io
+
X86 IOPL access for COMPAT_10, COMPAT_FREEBSD, see + hppa/io(4), i386/io(4)
+
iop#
+
I2O IOP control interface, see iop(4)
+
ipmi#
+
OpenIPMI compatible interface, see ipmi(4)
+
ipl
+
IP Filter
+
irframe#
+
IrDA physical frame, see irframe(4)
+
ite#
+
Terminal emulator interface to HP300 graphics devices, see + amiga/ite(4)
+
joy#
+
Joystick device, see joy(4)
+
kttcp
+
Kernel ttcp helper device, see kttcp(4)
+
lockstat
+
Kernel locking statistics
+
magma#
+
Magma multiport serial/parallel cards, see + sparc/magma(4)
+
midi#
+
MIDI, see midi(4)
+
mfi#
+
LSI MegaRAID/MegaSAS control interface, see + mfi(4)
+
mlx#
+
Mylex DAC960 control interface, see mlx(4)
+
mly#
+
Mylex AcceleRAID/eXtremeRAID control interface, see + mly(4)
+
np#
+
UNIBUS Ethernet co-processor interface, for downloading., see + vax/np(4)
+
npf
+
NPF packet filter
+
nsmb#
+
SMB requester, see nsmb(4)
+
nvme#
+
Non-Volatile Memory Host Controller Interface device driver, see + nvme(4)
+
nvme#ns*
+
Non-Volatile Memory namespace
+
nvmm
+
NetBSD Virtual Machine Monitor, see nvmm(4)
+
openfirm
+
OpenFirmware accessor
+
pad#
+
Pseudo-audio device driver, see pad(4)
+
pci#
+
PCI bus access devices, see pci(4)
+
pf
+
PF packet filter
+
putter
+
Pass-to-Userspace Transporter
+
px#
+
PixelStamp Xserver access, see px(4)
+
qemufwcfg#
+
QEMU Firmware Configuration, see qemufwcfg(4)
+
radio#
+
Radio devices, see radio(4)
+
random
+
Random number generator, see rnd(4)
+
rtc#
+
RealTimeClock, see atari/rtc(4), + evbppc/rtc(4), hp300/rtc(4)
+
scsibus#
+
SCSI busses, see scsi(4)
+
se#
+
SCSI Ethernet, see se(4)
+
ses#
+
SES/SAF-TE SCSI Devices, see ses(4)
+
speaker
+
PC speaker, see speaker(4)
+
spi#
+
SPI bus device, see spi(4)
+
sram
+
Battery backuped memory (x68k)
+
srt#
+
Source-address based routing, see srt(4)
+
ss#
+
SCSI scanner, see ss(4)
+
stic#
+
PixelStamp interface chip
+
sysmon
+
System Monitoring hardware, see envsys(4)
+
tap#
+
Virtual Ethernet device, see tap(4)
+
tprof
+
Task profiler, see tprof(4)
+
tun#
+
Network tunnel driver, see tun(4)
+
twa
+
3ware Apache control interface, see twa(4)
+
twe
+
3ware Escalade control interface, see twe(4)
+
uk#
+
Unknown SCSI device, see uk(4)
+
veriexec
+
Veriexec fingerprint loader, see veriexec(4)
+
vhci
+
Virtual host controller interface
+
video#
+
Video capture devices, see video(4)
+
view#
+
Generic interface to graphic displays (Amiga)
+
wsfont#
+
Console font control, see wsfont(4)
+
wsmux#
+
wscons event multiplexor, see wsmux(4)
+
xenevt
+
Xen event interface
+
+
+
iSCSI communication devices
+
+
+
iscsi#
+
ISCSI driver and /sbin/iscsid communication
+
+
+
Trusted Computing devices
+
+
+
tpm
+
Trusted Platform Module, see tpm(4)
+
+
+
Debugging and tracing
+
+
+
dtrace
+
Dynamic tracing framework
+
+
+
+
+
+

+

The following environment variables affect the execution of + MAKEDEV:

+
+
+
If this is set, then MAKEDEV will define several + shell functions and then return, ignoring all its command line options and + arguments. This is used to enable MAKEDEV.local(8) to + use the shell functions defined in MAKEDEV.
+
+
+
+

+
+
/dev
+
special device files directory
+
/dev/MAKEDEV
+
script described in this man page
+
/dev/MAKEDEV.local
+
script for site-specific devices
+
+
+
+

+

If the script reports an error that is difficult to understand, + you can get more debugging output by using

+
sh + -x MAKEDEV + argument
+. +
+
+

+

config(1), pax(1), + intro(4), diskless(8), + init(8), MAKEDEV.local(8), + mknod(8), mount_mfs(8), + mount_tmpfs(8), mtree(8)

+
+
+

+

The MAKEDEV command appeared in + 4.2BSD. The -f, + -m, and -s options were + added in NetBSD 2.0. The -p, + -t, and -M options were + added in NetBSD 5.0. The ability to be used as a + function library was added in NetBSD 5.0.

+
+
+

+

The -f option is not compatible with the + use of mtree(8) or pax(1).

+
+
+

+

Not all devices listed in this manpage are supported on all + platforms.

+

This man page is generated automatically from the same sources as + /dev/MAKEDEV, in which the device files are not + always sorted, which may result in an unusual (non-alphabetical) order.

+

In order to allow a diskless NetBSD client + to obtain its /dev directory from a file server + running a foreign operating system, one of the following techniques may be + useful to populate a directory of device nodes on the foreign server:

+
    +
  • If the foreign server is sufficiently similar to + NetBSD, run MAKEDEV in an + appropriate directory of the foreign server, using the + -m flag to refer to a script that converts from + command line arguments that would be usable with the + NetBSD mknod(8) command to the + equivalent commands for the foreign server.
    • +
  • Run MAKEDEV with the + -s flag to generate an mtree(8) + specification file; this can be done on any host with a POSIX-compliant + shell and a few widely-available utilities. Use the + pax(1) command with the -w + -M flags to convert the mtree(8) + specification file into an archive in a format that supports device nodes + (such as ustar format); this can be done on a + NetBSD host, or can be done in a cross-build + environment using + /bin/nbpax. + Finally, use appropriate tools on the foreign server to unpack the archive + and create the device nodes.
    • +
+
+
+ + + + + +
April 1, 2020NetBSD 10.1
diff --git a/static/netbsd/man8/MAKEDEV.local.8 4.html b/static/netbsd/man8/MAKEDEV.local.8 4.html new file mode 100644 index 00000000..d5bd6117 --- /dev/null +++ b/static/netbsd/man8/MAKEDEV.local.8 4.html @@ -0,0 +1,92 @@ + + + + + + +
MAKEDEV.LOCAL(8)System Manager's ManualMAKEDEV.LOCAL(8)
+
+
+

+

MAKEDEV.local — + create site-specific device special files

+
+
+

+ + + + + +
MAKEDEV.local[-fMsu] [-m + mknod] [-p + pax] [-t + mtree] {all | + site-specific-argument} + [...]
+
+
+

+

MAKEDEV.local is used to create + site-specific device special files. Each argument may be the word + all or a site-specific argument. By default, there + are no valid site-specific arguments, and the all + argument has no effect; This may be changed by editing the script.

+

The script is in /dev/MAKEDEV.local. + Devices are created in the current working directory; in normal use, + MAKEDEV.local should be invoked with + /dev as the current working directory.

+

Supported options for MAKEDEV.local are + the same as for MAKEDEV(8).

+
+
+

+
+
/dev
+
special device files directory
+
/dev/MAKEDEV
+
script that invokes MAKEDEV.local with the + all argument.
+
/dev/MAKEDEV.local
+
script described in this man page
+
+
+
+

+

config(1), intro(4), + MAKEDEV(8), mknod(8)

+
+
+

+

The MAKEDEV.local command appeared in + 4.2BSD. Handling of the same command line options as + MAKEDEV(8), and the use of MAKEDEV(8) as + a function library, was added in NetBSD 5.0.

+
+
+

+

The relationship between MAKEDEV.local and + MAKEDEV(8) is complex:

+
    +
  • If MAKEDEV(8) is invoked with the + all or local argument, + then it will invoke MAKEDEV.local as a child + process, with options similar to those that were originally passed to + MAKEDEV(8), and with the all + argument.
    • +
  • MAKEDEV.local uses shell functions defined in + MAKEDEV(8). This is done by loading + MAKEDEV(8) using the shell “.” command, + with the MAKEDEV_AS_LIBRARY variable set (to + inform MAKEDEV(8) that it should behave as a function + library, not as an independent program).
    • +
+
+
+ + + + + +
August 6, 2011NetBSD 10.1
diff --git a/static/netbsd/man8/RELEASE_NOTES-2.8 b/static/netbsd/man8/RELEASE_NOTES-2.8 new file mode 100644 index 00000000..622577fb --- /dev/null +++ b/static/netbsd/man8/RELEASE_NOTES-2.8 @@ -0,0 +1,383 @@ +The stable Postfix release is called postfix-2.8.x where 2=major +release number, 8=minor release number, x=patchlevel. The stable +release never changes except for patches that address bugs or +emergencies. Patches change the patchlevel and the release date. + +New features are developed in snapshot releases. These are called +postfix-2.9-yyyymmdd where yyyymmdd is the release date (yyyy=year, +mm=month, dd=day). Patches are never issued for snapshot releases; +instead, a new snapshot is released. + +The mail_release_date configuration parameter (format: yyyymmdd) +specifies the release date of a stable release or snapshot release. + +If you upgrade from Postfix 2.6 or earlier, read RELEASE_NOTES-2.7 +before proceeding. + +Major changes - restart Postfix +------------------------------- + +If you upgrade from Postfix 2.6 or earlier, you must execute "postfix +stop" and "postfix start" before you can use the postscreen(8) +daemon. This is needed because the Postfix 2.6 "pass" master service +type did not work reliably on some systems. + +If you upgrade from Postfix 2.7, or from Postfix 2.8 before July +25, 2010, you must execute "postfix reload" (or "postfix stop" +followed by "postfix start"). This is needed because the queue +manager to delivery agent protocol has changed. Failure to do this +results in repeated logging of warnings with: + + warning: unexpected attribute rewrite_context ... + +If the warning does not go away after restarting Postfix, examine +the output from this command: + + strings -af /usr/libexec/postfix/* | grep mail_version= + +(where /usr/libexec/postfix is the value of main.cf:daemon_directory) +and update the executables that have a version string that differs +from the other programs. + +Major changes - DNSBL/DNSWL support +----------------------------------- + +[Feature 20101126] Support for address patterns in DNS blacklist +and whitelist lookup results. + +For example, "reject_rbl_client example.com=127.0.0.[2;4;6..8]" +will reject clients when the lookup result is 127.0.0.2, 127.0.0.4, +127.0.0.6, 127.0.0.7, or 127.0.0.8. + +The setting "postscreen_dnsbl_sites = example.com=127.0.0.[2;4;6..8]" +rejects the same clients. + +An IPv4 address pattern has four fields separated by ".". Each +field is either a decimal number, or a sequence inside "[]" that +contains one or more ";"-separated decimal numbers or number..number +ranges. + +Thus, any pattern field can be a sequence inside "[]", but a "[]" +sequence cannot span multiple address fields, and a pattern field +cannot contain both a number and a "[]" sequence at the same time. + +This means that the pattern 1.2.[3.4] is not valid (the sequence +[3.4] cannot span two address fields) and the pattern 1.2.3.3[6..9] +is also not valid (the last field cannot be both number 3 and +sequence [6..9] at the same time). + +The syntax for IPv4 patterns is as follows: + +v4pattern = v4field "." v4field "." v4field "." v4field +v4field = v4octet | "[" v4sequence "]" +v4octet = any decimal number in the range 0 through 255 +v4sequence = v4seq_member | v4sequence ";" v4seq_member +v4seq_member = v4octet | v4octet ".." v4octet + +[Feature 20101105] The Postfix SMTP server now supports DNS-based +whitelisting with several safety features: permit_dnswl_client +whitelists a client by IP address, and permit_rhswl_client whitelists +a client by its hostname. These features use the same syntax as +reject_rbl_client and reject_rhsbl_client, respectively. The main +difference is that they return PERMIT instead of REJECT. + +Whitelisting is primarily a tool to reduce the false positive rate +of DNS blocklist lookups. Client name whitelisting should not be +used to make exceptions to access rules. The reason is that client +name lookup can fail unpredictably due to some temporary outage. + +For safety reasons, permit_dnswl_client and permit_rhswl_client are +silently ignored when they would override reject_unauth_destination. +Also for safety reasons, the result is DEFER_IF_REJECT when DNS +whitelist lookup fails (this result will be made configurable). + +Major changes - sqlite support +------------------------------ + +[Feature 20100617] Support for read-only sqlite database access, +with code by Axel Steiner and documentation by Jesus Garcia Crespo. +See SQLITE_README and sqlite_table(5) for details. + +Major changes - Milter support +------------------------------- + +[Incompat 20101103] Postfix now requests default delivery status +notifications when adding a recipient with the Milter smfi_addrcpt +action, instead of "never notify" as with Postfix automatically-added +recipients (always_bcc and sender/recipient_bcc_maps). + +Major changes - alias expansion +------------------------------- + +[Incompat 20101202] Postfix now reports a temporary delivery error +when the result of virtual alias expansion would exceed the +virtual_alias_recursion_limit or virtual_alias_expansion_limit. +Previously, Postfix would silently drop the excess recipients and +deliver the message. + +[Incompat 20101006] To avoid repeated delivery to mailing lists +with pathological nested alias configurations, the local(8) delivery +agent now keeps the owner-alias attribute of a parent alias, when +delivering mail to a child alias that does not have its own owner +alias. + +With this change, local addresses from that child alias will be +written to a new queue file, and a temporary error with one local +address will no longer result in repeated delivery to other mailing +list members. Specify "reset_owner_alias = yes" for the older, +more fragile, behavior. + +The postconf(5) manpage entry for "reset_owner_alias" has more +background information on this issue. + +Major changes - dns lookup +-------------------------- + +[Incompat 20100827] The Postfix SMTP client no longer appends the +local domain when looking up a DNS name without ".". Specify +"smtp_dns_resolver_options = res_defnames" to get the old behavior, +which may produce unexpected results. + +Major changes - logging +----------------------- + +[Incompat 20100728] The format of the "postfix/smtpd[pid]: queueid: +client=host[addr]" logfile record has changed. When available, the +before-filter client information and the before-filter queue ID are +now appended to the end of the record. + +[Feature 20100728] Improved message tracking across SMTP-based +content filters. The logging example below is from an after-filter +SMTP server. Here, 951F692462F is a before-filter queue ID, +hades.porcupine.org is a before-filter SMTP client, while 6B4A9924782 +is the after-filter queue ID, and localhost[127.0.0.1] is the +SMTP-based content filter that sends mail into the after-filter +SMTP server. + + postfix/smtpd[4074]: 6B4A9924782: + client=localhost[127.0.0.1], + orig_queue_id=951F692462F + orig_client=hades.porcupine.org[168.100.189.10] + +Major changes - reply footer +---------------------------- + +[Feature 20110105] The SMTP server now supports contact information +that is appended to "reject" responses. This includes SMTP server +responses that aren't logged to the maillog file, such as responses +to syntax errors, or unsupported commands. + +Example: + smtpd_reject_footer = For assistance, call 800-555-0101. + +Server response: + 550-5.5.1 Recipient address rejected: User unknown + 550 5.5.1 For assistance, call 800-555-0101. + +This feature supports macro expansion ($client_address, $localtime, +etc.), as documented in the postconf(5) manpage. + +This feature is also supported as postscreen_reject_footer using +the same setting as smtpd_reject_footer by default. + +Major changes - rfc compliance +------------------------------ + +[Incompat 20101206] Postfix by default no longer adds a "To: +undisclosed-recipients:;" header when no recipient specified in the +message header. The Internet mail RFCs have supported messages +without recipient header for almost 10 years now. + +For backwards compatibility, specify: + +/etc/postfix/main.cf + undisclosed_recipients_header = To: undisclosed-recipients:; + +Note: both the ":" and ";" are required. + +Major changes - tls support +--------------------------- + +[Incompat 20110102] The Postfix SMTP server now always re-computes +the SASL mechanism list after successful completion of the STARTTLS +command. Earlier versions only re-computed the mechanism list when +the values of smtp_sasl_tls_security_options and smtp_sasl_security_options +differ. This could produce incorrect results, because the Dovecot +authentication server may change responses when the SMTP session +is encrypted. + +[Incompat 20110102] The smtpd_starttls_timeout default value is now +stress-dependent. By default, TLS negotiations must now complete +under overload in 10s instead of 300s. + +[Feature 20101223] The new tls_disable_workarounds parameter specifies +a list or bit-mask of OpenSSL bug work-arounds to disable. This may +be necessary if one of the work-arounds enabled by default in OpenSSL +proves to pose a security risk, or introduces an unexpected +interoperability issue. Some bug work-arounds known to be problematic +are disabled in the default value of the parameter when linked with +an OpenSSL library that could be vulnerable. See postconf(5) and +TLS_README for details. + +With "tls_preempt_cipherlist = yes" the Postfix SMTP server will +choose its most preferred cipher that is supported (offered) by the +client. This can lead to a more secure or performant cipher choice, +but may also introduce interoperability problems when a client +announces support for a cipher that does not work. See postconf(5) +and TLS_README for details. + +[Feature 20101217] The lower-level code in the TLS engine was +simplified by removing an unnecessary layer of data copying. OpenSSL +now writes directly to the network. The difference in performance +should be hardly noticeable. + +[Incompat 20100610] Postfix no longer appends the system-supplied +default CA certificates to the lists specified with *_tls_CAfile +or with *_tls_CApath. This prevents third-party certificates from +getting mail relay permission with the permit_tls_all_clientcerts +feature. + +Unfortunately this change may cause compatibility problems when +configurations rely on certificate verification for other purposes. +Specify "tls_append_default_CA = yes" for backwards compatibility. + +Major changes - postscreen +-------------------------- + +See html/POSTSCREEN_README.html for an introduction to postscreen +(or the text version, README_FILES/POSTSCREEN_README). The text +below summarizes milestones in reverse chronological order. + +[Incompat 20110111] The postscreen_access_list feature replaces the +postscreen_whitelist_networks and postscreen_blacklist_networks +features. Reason: CIDR-style access maps are some 100x faster than +the code that implemented the postscreen_white/blacklist_networks +support. CIDR maps can match about 100 million CIDR patterns/second +on a modern CPU, which is not blindingly fast but adequate for the +near future. + +[Feature 20110102] STARTTLS support for the postscreen(8) daemon. +This is implemented by a new tlsproxy(8) daemon that you will need +to enable in master.cf (see POSTSCREEN_README for instructions). +tlsproxy(8) implements its own tlsproxy_mumble versions of TLS-related +smtpd_mumble parameters. This leaves no confusion about which +parameters will affect tlsproxy(8) behavior, but it adds another +25 parameters to the documentation. + +[Incompat 20100912] If your DNSBL queries have a "secret" in the +domain name, you must now censor this information from the postscreen(8) +SMTP replies. For example: + + /etc/postfix/main.cf: + postscreen_dnsbl_reply_map = texthash:/etc/postfix/dnsbl_reply + + /etc/postfix/dnsbl_reply: + # Secret DNSBL name Name in postscreen(8) replies + secret.zen.spamhaus.org zen.spamhaus.org + +The texthash: format is similar to hash: except that there is no need to +run postmap(1) before the file can be used, and that it does not detect +changes after the file is read. It is new with Postfix version 2.8. + +[Incompat 20100912] The postscreen "continue" action is now called +"ignore". The old name is still supported but no longer documented. + +[Incompat 20100912] The postscreen_hangup_action parameter was +removed. Postscreen now always behaves as if "postscreen_hangup_action += drop". + +[Incompat 20100912] The postscreen_cache_retention_time default was +increased from 1d to 7d, to avoid deleting results from expensive +deep SMTP protocol tests too quickly. + +[Feature 20100912] SMTP protocol engine for deep protocol tests, +and for logging the helo/sender/recipient information when postscreen +rejects an attempt to deliver mail. + +The postscreen SMTP protocol engine implements a number of deep +protocol tests and defers or rejects all attempts to deliver mail. +The first test detects unauthorized SMTP command pipelining (an +SMTP client sends multiple commands, instead of sending one command +and waiting for the server response); a second deep protocol test +implements the Postfix SMTP server's smtpd_forbidden_commands feature +(a client sends commands such as CONNECT, GET, POST); and a third +deep protocol test detects spambots that send SMTP commands that +end in newline instead of carriage-return/newline. Real spambots +rarely make this mistake, but poorly-written software often does. + +Deep protocol tests are disabled by default, because the built-in +SMTP engine cannot not hand off the "live" connection from a good +SMTP client to a Postfix SMTP server process. To work around this, +postscreen(8) defers attempts to deliver mail with a 4XX status, +and waits for the client to disconnect. The next time a good client +connects, it will be allowed to talk to a Postfix SMTP server process +to deliver mail. + +[Feature 20100830] Postscreen DNSBL support is extended with optional +fixed-string filters, with optional integral weight factors, and +with an adjustable threshold to block SMTP clients with DNSBL score +>= that threshold. Reply filters will be implemented later. + +The updated postscreen configuration syntax is: + + postscreen_dnsbl_sites = domain[=ipaddr][*weight] ... + postscreen_dnsbl_threshold = score + +Elements inside [] are optional, ipaddr is an IPv4 address, and +weight and score are integral numbers. The [] are not part of the +postscreen_dnsbl_sites input. By default, weight and score are +equal to 1, and entries without filter will match any non-error +DNSBL reply. Use a negative weight value for whitelisting. + +Examples: + +To use example.com as a high-confidence blocklist, and to block +mail with example.net and example.org only when both agree, use: + + postscreen_dnsbl_threshold = 2 + postscreen_dnsbl_sites = example.com*2, example.net, example.org + +To filter only DNSBL replies containing 127.0.0.4, use: + + postscreen_dnsbl_sites = example.com=127.0.0.4 + +See also postconf(5) for the fine details. + +[Incompat 20100101] When periodic cache cleanup is enabled (the +default), the postscreen(8) server now requires that the cache +database supports the "delete" and "sequence" operations. To disable +periodic cache cleanup specify a zero postscreen_cache_cleanup_interval +value. + +[Feature 20100101] Periodic cache cleanup for the postscreen(8) +cache database. The time between cache cleanup runs is controlled +with the postscreen_cache_cleanup_interval (default: 12h) parameter. +Cache cleanup increases the database access latency, so this should +not be run more often than necessary. + +In addition, the postscreen_cache_retention_time (default: 1d) +parameter specifies how long to keep an expired entry in the cache. +This prevents a client from being logged as "NEW" after its record +expired only a little while ago. + +[Feature 20091008] Prototype postscreen(8) server that runs a number +of time-consuming checks in parallel for all incoming SMTP connections, +before clients are allowed to talk to a real Postfix SMTP server. +It detects clients that start talking too soon, or clients that +appear on DNS blocklists, or clients that hang up without sending +any command. + +By doing these checks in a single postscreen(8) process, Postfix +can avoid wasting one SMTP server process per connection. A side +benefit of postscreen(8)'s DNSBL lookups is that DNS records are +already cached before the Postfix SMTP server looks them up later. + +postscreen(8) maintains a temporary whitelist of positive decisions. +Once an SMTP client is whitelisted, it is immediately forwarded to +a real Postfix SMTP server process without further checking. + +By default, the program logs only statistics, and it does not run +any checks on clients in mynetworks (primarily, to avoid problems +with buggy SMTP implementations in network appliances). The logging +function alone is already useful for research. + diff --git a/static/netbsd/man8/RELEASE_NOTES-3.8 b/static/netbsd/man8/RELEASE_NOTES-3.8 new file mode 100644 index 00000000..2944830f --- /dev/null +++ b/static/netbsd/man8/RELEASE_NOTES-3.8 @@ -0,0 +1,128 @@ +This is the Postfix 3.8 stable release. + +The stable Postfix release is called postfix-3.8.x where 3=major +release number, 8=minor release number, x=patchlevel. The stable +release never changes except for patches that address bugs or +emergencies. Patches change the patchlevel and the release date. + +New features are developed in snapshot releases. These are called +postfix-3.9-yyyymmdd where yyyymmdd is the release date (yyyy=year, +mm=month, dd=day). Patches are never issued for snapshot releases; +instead, a new snapshot is released. + +The mail_release_date configuration parameter (format: yyyymmdd) +specifies the release date of a stable release or snapshot release. + +If you upgrade from Postfix 3.6 or earlier, please read RELEASE_NOTES-3.7 +before proceeding. + +Dual license +------------ + +As of Postfix 3.2.5 this software is distributed with a dual license: +in addition to the historical IBM Public License (IPL) 1.0, it is +now also distributed with the more recent Eclipse Public License +(EPL) 2.0. Recipients can choose to take the software under the +license of their choice. Those who are more comfortable with the +IPL can continue with that license. + +Major changes - documentation and code cleanup +---------------------------------------------- + +There are numerous small fixes to Postfix documentation, and small +code-health changes that should not affect documented behavior but +may improve Postfix behavior for malformed input, or that make +Postfix easier to maintain. See the HISTORY file for details. + +Major changes - SRV support +--------------------------- + +[Feature 20230214] Support to look up DNS SRV records in the Postfix +SMTP/LMTP client, Based on code by Tomas Korbar (Red Hat). + +For example, with "use_srv_lookup = submission" and "relayhost = +example.com:submission", the Postfix SMTP client will look up DNS +SRV records for _submission._tcp.example.com, and will relay email +through the hosts and ports that are specified with those records. + +See https://www.postfix.org/postconf.5.html#use_srv_lookup for more +details, including how to selectively use SRV in a configuration +that connects to multiple ISP accounts. + +SRV support may also be useful inside a cloud-based infrastructure +when Postfix needs to deliver mail to services that run on a +dynamically-allocated port. + +Major changes - TLS support +--------------------------- + +[Incompat 20230304] This introduces the following changes: + +- Postfix treats the "export" and "low" cipher grade settings as + "medium". The "export" and "low" grades are no longer supported + in OpenSSL 1.1.1, the minimum version that Postfix requires. + +- Postfix default settings now exclude the following deprecated or + unused ciphers (SEED, IDEA, 3DES, RC2, RC4, RC5), digest (MD5), + key exchange algorithms (DH, ECDH), and public key algorithm + (DSS). + +[Feature 20230108] New configuration parameter tls_ffdhe_auto_groups +for finite-field Diffie-Hellman ephemeral (FFDHE) support in TLS +1.3 with OpenSSL 3.0. + +Major changes - attack resistance +--------------------------------- + +[Feature 20240312] the Postfix SMTP server can now aggregate +smtpd_client_*_rate and smtpd_client_*_count statistics by network +block, as specified with smtpd_client_ipv4_prefix_length (default +32, no aggregation) and smtpd_client_ipv6_prefix_length (default +84, aggregation by /84 network blocks). The latter raises the bar +for a memory exhaustion attack. + +[Feature 20221023] Unconditionally disable a CPU resource attack +requesting TLS renegotiation. There's no good reason to support +this in the middle of an SMTP connection. + +Major changes - bit rot +----------------------- + +[Incompat 20221228] Postfix documentation and code have been converted +to use "grep -E" and "grep -F" instead of the historical forms +"egrep" and "fgrep". To build Postfix on a system that supports +only the historical forms, run the script auxiliary/fix-grep/fix-grep.sh +to revert this change. + +Major changes - configuration checks +------------------------------------ + +[Feature 20240406] The postconf command now warns for #comment in +or after a Postfix parameter value. Postfix programs do not support +#comment after other text, and treat that as input. + +Major changes - database support +-------------------------------- + +[Incompat 20220509] The PostgreSQL client encoding is now configurable +with the "encoding" Postfix configuration file attribute. The default +is "UTF8". Previously the encoding was hard-coded as "LATIN1". + +Major changes - logging +----------------------- + +[Incompat 20230308] The postfix(1) and postlog(1) commands now +produce stderr logging even when stderr is not connected to a +terminal. This eliminates an inconsistency, and makes these programs +easier to use in some automated procedures. The canonical example +is to capture output from "postmulti -p status" to figure out which +instances are or are not running. + +Major changes - source code organization +---------------------------------------- + +[Incompat 20220507] Most global/mkmap*.[hc] files are moved to the +util directory; only global/mkmap_proxy.* remains. The old file +organization was designed before support for dynamically-loadable +databases was added, and that code suffered from complexity. + diff --git a/static/netbsd/man8/ac.8 b/static/netbsd/man8/ac.8 new file mode 100644 index 00000000..1abcb9dd --- /dev/null +++ b/static/netbsd/man8/ac.8 @@ -0,0 +1,147 @@ +.\" $NetBSD: ac.8,v 1.19 2017/07/03 21:35:29 wiz Exp $ +.\" +.\" Copyright (c) 1980, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" Copyright (c) 1994 Simon J. Gerraty +.\" Copyright (c) 1994 Christopher G. Demetriou +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgements: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" This product includes software developed by Christopher G. Demetriou. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)ac.8 8.2 (Berkeley) 4/19/94 +.\" +.Dd April 19, 1994 +.Dt AC 8 +.Os +.Sh NAME +.Nm ac +.Nd display connect time accounting +.Sh SYNOPSIS +.Nm +.Op Fl d | p +.Op Fl t Ar tty +.Op Fl w Ar file +.Op Ar users ... +.Sh DESCRIPTION +If the file +.Pa /var/log/wtmp +exists, +a record of individual +login and logout times are written to it by +.Xr login 1 +and +.Xr init 8 , +respectively. +The program +.Nm +examines these +records and writes the accumulated connect time for all logins to the +standard output. +.Pp +Options available: +.Bl -tag -width indentXXX +.It Fl d +Display the connect times in 24 hour chunks. +.It Fl p +Display individual user totals. +.It Fl t Ar tty +Only do accounting logins on certain ttys. +The +.Ar tty +specification can start with +.Ql \&! +to indicate not this +.Ar tty +and end with +.Ql * +to indicate all similarly named ttys. +Multiple +.Fl t +flags may be specified. +.It Fl w Ar file +Read raw connect time data from +.Ar file +instead of the default file +.Pa /var/log/wtmp . +.It Ar users ... +Display totals for the given individuals +only. +.El +.Pp +If no arguments are given, +.Nm +displays the total amount of login time for all active accounts on the +system. +.Pp +The default +.Pa wtmp +file is an infinitely increasing file +unless frequently truncated. +This is normally done by the daily daemon scripts scheduled by +.Xr cron 8 , +which rename and rotate the +.Pa wtmp +files before truncating them (and keep about a week's worth on hand). +No login times are collected, however, if the file does not exist. +.Pp +For example, +.Bd -literal -offset indent +ac -p -t "ttyd*" > modems +ac -p -t "!ttyd*" > other +.Ed +.Pp +allows times recorded in +.Pa modems +to be charged out at a different rate than +.Pa other . +.Sh FILES +.Bl -tag -width /var/log/wtmp.[0-7] -compact +.It Pa /var/log/wtmp +connect time accounting file +.It Pa /var/log/wtmp.[0-7] +rotated files +.El +.Sh EXIT STATUS +.Ex -std ac +.Sh SEE ALSO +.Xr login 1 , +.Xr utmp 5 , +.Xr init 8 , +.Xr sa 8 +.Sh HISTORY +An +.Nm +command appeared in +.At v6 . +This version of +.Nm +was written for +.Nx 1.0 +from the specification provided by various systems' manual pages. diff --git a/static/netbsd/man8/accton.8 b/static/netbsd/man8/accton.8 new file mode 100644 index 00000000..1b135c4e --- /dev/null +++ b/static/netbsd/man8/accton.8 @@ -0,0 +1,82 @@ +.\" $NetBSD: accton.8,v 1.14 2011/04/25 22:32:27 wiz Exp $ +.\" +.\" Copyright (c) 1993 Christopher G. Demetriou +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed for the +.\" NetBSD Project. See http://www.NetBSD.org/ for +.\" information about NetBSD. +.\" 4. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" <> +.\" +.Dd January 23, 2008 +.Dt ACCTON 8 +.Os +.Sh NAME +.Nm accton +.Nd enable/disable system accounting +.Sh SYNOPSIS +.Nm +.Op Ar file +.Sh DESCRIPTION +With an argument naming an existing +.Ar file , +.Nm +causes system accounting information for every process executed +to be placed at the end of the file. +If no argument is given, accounting is turned off. +.Pp +The default accounting file is +.Pa /var/account/acct . +Typically, accounting is enabled by rc scripts during the boot process. +In +.Nx , +one may enable accounting by setting the variable +.Dq accounting +to +.Dq YES +in +.Pa /etc/rc.conf . +.Pp +Note that, traditionally, the system accounting log file can not be rotated +cleanly by +.Xr newsyslog 8 . +Instead, a default installation of +.Nx +rotates +.Pa /var/account/acct +using the +.Pa /etc/daily +script. +.Sh FILES +.Bl -tag -width /var/account/acct -compact +.It Pa /var/account/acct +Default accounting file. +.El +.Sh SEE ALSO +.Xr lastcomm 1 , +.Xr acct 5 , +.Xr sa 8 diff --git a/static/netbsd/man8/acpidump.8 b/static/netbsd/man8/acpidump.8 new file mode 100644 index 00000000..8d4bc318 --- /dev/null +++ b/static/netbsd/man8/acpidump.8 @@ -0,0 +1,231 @@ +.\" $NetBSD: acpidump.8,v 1.17 2020/12/06 02:57:30 jmcneill Exp $ +.\" ACPI (ACPI Package) +.\" +.\" Copyright (c) 1999 Doug Rabson +.\" Copyright (c) 2000 Mitsuru IWASAKI +.\" Copyright (c) 2000 Yasuo YOKOYAMA +.\" Copyright (c) 2000 Hiroki Sato +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD: head/usr.sbin/acpi/acpidump/acpidump.8 267668 2014-06-20 09:57:27Z bapt $ +.\" +.Dd December 4, 2020 +.Dt ACPIDUMP 8 +.Os +.Sh NAME +.Nm acpidump +.Nd dump ACPI tables and ASL +.Sh SYNOPSIS +.Nm +.Op Fl cdhstv +.Op Fl f Ar dsdt_input +.Op Fl o Ar dsdt_output +.Sh DESCRIPTION +The +.Nm +utility analyzes ACPI tables in physical memory and can dump them to a file. +In addition, +.Nm +can call +.Xr iasl 8 +to disassemble AML +(ACPI Machine Language) +found in these tables and dump them as ASL +(ACPI Source Language) +to stdout. +.Pp +ACPI tables have an essential data block (the DSDT, +Differentiated System Description Table) +that includes information used on the kernel side such as +detailed information about PnP hardware, procedures for controlling +power management support, and so on. +The +.Nm +utility can extract the DSDT data block from physical memory and store it into +an output file and optionally also disassemble it. +If any Secondary System Description Table +(SSDT) +entries exist, they will also be included in the output file and disassembly. +.Pp +When +.Nm +is invoked without the +.Fl f +option, it will read ACPI tables from physical memory via +.Pa /dev/acpi . +First it searches for the RSDP +(Root System Description Pointer), +which has the signature +.Qq RSD PTR\ \& , +and then gets the RSDT +(Root System Description Table), +which includes a list of pointers to physical memory addresses +for other tables. +The RSDT itself and all other tables linked from RSDT are generically +called SDTs +(System Description Tables) +and their header has a common format which consists of items +such as Signature, Length, Revision, Checksum, OEMID, OEM Table ID, +OEM Revision, Creator ID and Creator Revision. +When invoked with the +.Fl t +flag, the +.Nm +utility dumps contents of the following tables: +.Pp +.Bl -tag -offset indent -width 12345 -compact +.It APIC +.It BERT +.It BGRT +.It BOOT +.It CPEP +.It CSRT +.It DBG2 +.It DBGP +.It DMAR +.It DSDT +.It ECDT +.It EINJ +.It ERST +.It FACS +.It FADT +.It GTDT +.It HEST +.It HPET +.It IORT +.It LPIT +.It MADT +.It MCFG +.It MSCT +.It NFIT +.It PPTT +.It RSD PTR +.It RSDT +.It SBST +.It SLIT +.It SPCR +.It SPMI +.It SRAT +.It TCPA +.It TPM2 +.It UEFI +.It WAET +.It WDAT +.It WDDT +.It WDRT +.El +.Pp +The RSDT contains a pointer to the physical memory address of the FACP +(Fixed ACPI Description Table). +The FACP defines static system information about power management support +(ACPI Hardware Register Implementation) +such as interrupt mode (INT_MODEL), +SCI interrupt number, SMI command port (SMI_CMD) +and the location of ACPI registers. +The FACP also has a pointer to a physical memory address for the DSDT. +While the other tables are fixed format, +the DSDT consists of free-formatted AML data. +.Sh OPTIONS +The following options are supported by +.Nm : +.Bl -tag -width indent +.It Fl c +Dump unknown table data as characters instead of hex. +.It Fl d +Disassemble the DSDT into ASL using +.Xr iasl 8 +and print the results to stdout. +.It Fl f Ar dsdt_input +Load the DSDT from the specified file instead of physical memory. +Since only the DSDT is stored in the file, the +.Fl t +flag may not be used with this option. +.It Fl h +Displays usage and exit. +.It Fl o Ar dsdt_output +Store the DSDT data block from physical memory into the specified file. +.It Fl s +Skip tables with bad checksums. +.It Fl t +Dump the contents of the various fixed tables listed above. +.It Fl v +Enable verbose messages. +.El +.Sh FILES +.Bl -tag -width /dev/acpi +.It Pa /dev/acpi +.El +.Sh EXAMPLES +If a developer requests a copy of your ASL, please use the following +command to dump all tables and compress the result. +.Bd -literal -offset indent +# acpidump -dt | gzip -c9 > my_computer.asl.gz +.Ed +.Pp +This example dumps the DSDT from physical memory to foo.dsdt. +It also prints the contents of various system tables and disassembles +the AML contained in the DSDT to stdout, redirecting the output +to foo.asl. +.Bd -literal -offset indent +# acpidump -t -d -o foo.dsdt > foo.asl +.Ed +.Pp +This example reads a DSDT file and disassembles it to stdout. +Verbose messages are enabled. +.Bd -literal -offset indent +# acpidump -v -d -f foo.dsdt +.Ed +.Sh SEE ALSO +.Xr acpi 4 , +.\" .Xr mem 4 , +.\" .Xr acpiconf 8 , +.Xr amldb 8 , +.Xr iasl 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Fx 5.0 +and was rewritten to use +.Xr iasl 8 +for +.Fx 5.2 . +.Sh AUTHORS +.An Doug Rabson Aq Mt dfr@FreeBSD.org +.An Mitsuru IWASAKI Aq Mt iwasaki@FreeBSD.org +.An Yasuo YOKOYAMA Aq Mt yokoyama@jp.FreeBSD.org +.An Nate Lawson Aq Mt njl@FreeBSD.org +.Pp +.An -nosplit +Some contributions made by +.An Chitoshi Ohsawa Aq Mt ohsawa@catv1.ccn-net.ne.jp , +.An Takayasu IWANASHI Aq Mt takayasu@wendy.a.perfect-liberty.or.jp , +.An Yoshihiko SARUMARU Aq Mt mistral@imasy.or.jp , +.An Hiroki Sato Aq Mt hrs@FreeBSD.org , +.An Michael Lucas Aq Mt mwlucas@blackhelicopters.org +and +.An Michael Smith Aq Mt msmith@FreeBSD.org . +.Sh BUGS +The current implementation does not dump +some miscellaneous tables. diff --git a/static/netbsd/man8/afterboot.8 4.html b/static/netbsd/man8/afterboot.8 4.html new file mode 100644 index 00000000..870e185b --- /dev/null +++ b/static/netbsd/man8/afterboot.8 4.html @@ -0,0 +1,795 @@ + + + + + + +
AFTERBOOT(8)System Manager's ManualAFTERBOOT(8)
+
+
+

+

afterboot — things + to check after the first complete boot

+
+
+

+
+

+

This document attempts to list items for the system administrator + to check and set up after the installation and first complete boot of the + system. The idea is to create a list of items that can be checked off so + that you have a warm fuzzy feeling that something obvious has not been + missed. A basic knowledge of UNIX is assumed.

+

Complete instructions for correcting and fixing items is not + provided. There are manual pages and other methodologies available for doing + that. For example, to view the man page for the ls(1) + command, type:

+
+
man 1 ls
+
+

Administrators will rapidly become more familiar with + NetBSD if they get used to using the manual + pages.

+
+
+

+

On a fresh install with no other user accounts, login as + “root”. You can do so on the console, + or over the network using ssh(1). If you have enabled the + SSH daemon (see sshd(8)) and wish to allow root logins + over the network, edit the /etc/ssh/sshd_config file + and set “PermitRootLogin” to “yes” (see + sshd_config(5)). The default is to not permit root logins + over the network after fresh install in NetBSD.

+

Upon successful login on the console, you may see the message + “We recommend creating a non-root account...”. For security + reasons, it is bad practice to login as root during regular use and + maintenance of the system. In fact, the system will only let you login as + root on a secure terminal. By default, only the console is considered to be + a secure terminal. Instead, administrators are encouraged to add a + “regular” user, add said user to the “wheel” + group, then use the su(1) command when root privileges are + required:

+
+
useradd -G wheel -m myuser
+passwd myuser
+
+
+
+

+

Change the password for the root user. (Note that throughout the + documentation, the term “superuser” is a synonym for the root + user.) Choose a password that has numbers, digits, and special characters + (not space) as well as from the upper and lower case alphabet. Do not choose + any word in any language. It is common for an intruder to use dictionary + attacks. Type the command /usr/bin/passwd to change + it.

+

It is a good idea to always specify the full path name for both + the passwd(1) and su(1) commands as this + inhibits the possibility of files placed in your execution + PATH for most shells. Furthermore, the superuser's + PATH should never contain the current directory + (“.”).

+
+
+

+

Check the system date with the date(1) command. + If needed, change the date, and/or change the symbolic link of + /etc/localtime to the correct time zone in the + /usr/share/zoneinfo directory.

+

Examples:

+
+
+
Set the current date to October 5th, 2020 6:20pm.
+
+
Set the time zone to Eastern Europe Summer Time.
+
+
+
+

+

One of the first things you will likely need to do is to set up + your keyboard map (and maybe some other aspects about the system console). + To change your keyboard layout, edit the + “encoding” variable found in + /etc/wscons.conf.

+

wscons.conf(5) contains more information about + this file.

+
+
+

+

All significant and easily fixed problems will be reported at + the security + advisories web page. It is recommended that you check this page + regularly.

+

Additionally, you should set + “fetch_pkg_vulnerabilities=YES” in + /etc/daily.conf to allow your system to + automatically update the local database of known vulnerable packages to the + latest version available on-line. The system will later check, on a daily + basis, if any of your installed packages are vulnerable based on the + contents of this database. See daily.conf(5) and + security.conf(5) for more details.

+
+
+

+

If your machine does not have a hardware random number generator, + it may not be safe to use on the internet until it has enough entropy to + generate unpredictable secrets for programs like web browsers and + ssh(1). You can use rndctl(8) to list + the entropy sources with rndctl -l, or save entropy + from another machine running NetBSD with + rndctl -S and load it on this one with + rndctl -L (as long as there are no eavesdroppers on + the medium between the two machines). See entropy(7) for + more details.

+
+
+

+

Use the hostname command to verify that + the name of your machine is correct. See the man page for + hostname(1) if it needs to be changed. You will also need + to change the contents of the “hostname” + variable in /etc/rc.conf or edit the + /etc/myname file to have it stick around for the + next reboot. Note that “hostname” is + supposed include a domainname, and that this should not be confused with YP + (NIS) domainname(1). If you are using + dhcpcd(8) to configure network interfaces, it might + override these local hostname settings if your DHCP server specifies + client's hostname with other network configurations.

+
+
+

+

The first thing to do is an ifconfig -a to + see if the network interfaces are properly configured. Correct by editing + /etc/ifconfig.interface or the + corresponding + “ifconfig_interface” + variable in rc.conf(5) (where + interface is the interface name, e.g., + “le0”) and then using ifconfig(8) to + manually configure it if you do not wish to reboot.

+

Alternatively, many networks allow interfaces to be configured + automatically via DHCP. To get dhcpcd(8) to start + automatically on boot, you will need to have this line in + /etc/rc.conf:

+

+
dhcpcd=YES
+

See dhcpcd(8) and + dhcpcd.conf(5) for more information on setting up a DHCP + client. For information on setting up Wi-Fi, see + Wireless networking.

+

You can add new “virtual interfaces” by adding the + required entries to + /etc/ifconfig.interface. Read + the ifconfig.if(5) man page for more information on the + format of + /etc/ifconfig.interface files. + The loopback interface will look something like:

+
+
lo0: flags=8009<UP,LOOPBACK,MULTICAST> mtu 32972
+	inet 127.0.0.1 netmask 0xff000000
+	inet6 fe80::1%lo0 prefixlen 64 scopeid 0x3
+	inet6 ::1 prefixlen 128
+
+

an Ethernet interface something like:

+
+
le0: flags=9863<UP,BROADCAST,NOTRAILERS,RUNNING,SIMPLEX,MULTICAST>
+	inet 192.168.4.52 netmask 0xffffff00 broadcast 192.168.4.255
+	inet6 fe80::5ef0:f0f0%le0 prefixlen 64 scopeid 0x1
+
+

and a PPP interface something like:

+
+
ppp0: flags=8051<UP,POINTOPOINT,RUNNING,MULTICAST>
+        inet 203.3.131.108 --> 198.181.0.253 netmask 0xffff0000
+
+

See mrouted(8) for instructions on configuring + multicast routing.

+
+
+

+

Issue a netstat -rn command. The output + will look something like:

+
+
Routing tables
+
+Internet:
+Destination    Gateway           Flags  Refs     Use  Mtu  Interface
+default        192.168.4.254     UGS      0 11098028    -  le0
+127            127.0.0.1         UGRS     0        0    -  lo0
+127.0.0.1      127.0.0.1         UH       3       24    -  lo0
+192.168.4      link#1            UC       0        0    -  le0
+192.168.4.52   8:0:20:73:b8:4a   UHL      1     6707    -  le0
+192.168.4.254  0:60:3e:99:67:ea  UHL      1        0    -  le0
+
+Internet6:
+Destination        Gateway       Flags  Refs  Use     Mtu  Interface
+::/96              ::1           UGRS     0     0   32972  lo0 =>
+::1                ::1           UH       4     0   32972  lo0
+::ffff:0.0.0.0/96  ::1           UGRS     0     0   32972  lo0
+fc80::/10          ::1           UGRS     0     0   32972  lo0
+fe80::/10          ::1           UGRS     0     0   32972  lo0
+fe80::%le0/64      link#1        UC       0     0    1500  le0
+fe80::%lo0/64      fe80::1%lo0   U        0     0   32972  lo0
+ff01::/32          ::1           U        0     0   32972  lo0
+ff02::%le0/32      link#1        UC       0     0    1500  le0
+ff02::%lo0/32      fe80::1%lo0   UC       0     0   32972  lo0
+
+

The default gateway address is stored in the + “defaultroute” variable in + /etc/rc.conf, or in the file + /etc/mygate. If you need to edit this file, a + painless way to reconfigure the network afterwards is to issue

+
+
service network restart
+
+

Or, you may prefer to manually configure using a series of + route add and route delete + commands (see route(8)). If you run + dhcpcd(8) you will have to kill it by running

+
+
service dhcpcd stop
+
+

before you flush the routes.

+

If you wish to route packets between interfaces, add one or both + of the following directives (depending on whether IPv4 or IPv6 routing is + required) to /etc/sysctl.conf:

+

+
net.inet.ip.forwarding=1
+
net.inet6.ip6.forwarding=1
+

As an alternative, compile a new kernel with the + “GATEWAY” option. Packets are not forwarded by default, due to + RFC requirements.

+
+
+

+

By default, nodes are created in /dev for + a fairly typical number of devices.

+

However, if this system has a large number of devices connected + (e.g. for large scale storage), you may want to enable + devpubd(8) to ensure a sufficient number of nodes are + available. Set “devpubd=YES” in + /etc/rc.conf to create nodes automatically during + system runtime. You can also run the node creation script by hand:

+
+
cd /dev && sh MAKEDEV
+
+
+
+

+

By default, all services are disabled in a fresh + NetBSD installation, and SSH is no exception. You + may wish to enable it so you can remotely control your system. Set + “sshd=YES” in + /etc/rc.conf and then starting the server with the + command

+
+
service sshd start
+
+

The first time the server is started, it will generate a new + keypair, which will be stored inside the directory + /etc/ssh.

+
+
+

+

The system resolves host names according the rules for hosts in + the name service switch configuration at + /etc/nsswitch.conf. By default, it will query + /etc/hosts first, and then the DNS resolver + specified in /etc/resolv.conf.

+

Multicast DNS and DNS Service Discovery are usually not enabled by + default on a fresh NetBSD system, and can be enabled + by setting “mdnsd=YES” in + /etc/rc.conf, and either rebooting or running the + following command:

+
+
service mdnsd start
+
+

You may also wish to enable mdnsd as a source for host lookups in + /etc/nsswitch.conf, see + nsswitch.conf(5).

+

If your network does not have a usable DNS resolver, e.g. one + provided by DHCP, you can run a local caching recursive resolver by setting + “named=YES” in /etc/rc.conf and either + rebooting or running the following command:

+
+
service named start
+
+

named(8) is configured in + /etc/named.conf by default to run as a local caching + recursive resolver. Then, to make the system use it, put the following in + /etc/resolv.conf:

+
+
nameserver 127.0.0.1
+
+
+
+

+

To configure the system to connect to a Wi-Fi network with a + password using WPA:

+
+
wpa_passphrase networkname password >> /etc/wpa_supplicant.conf
+
+

To configure the system to connect to an open wireless network + with no password, edit /etc/wpa_supplicant.conf + instead of using wpa_passphrase(8):

+
+
network={
+	ssid="Public-WiFi"
+	key_mgmt=NONE
+	priority=100
+}
+
+

Then bring up the interface and start the necessary daemons:

+
+
ifconfig iwm0 up
+service wpa_supplicant onestart
+service dhcpcd onestart
+
+

To automatically connect at boot, add the following to + /etc/rc.conf:

+

+
ifconfig_iwm0="up"
+
dhcpcd=YES
+
wpa_supplicant=YES
+

While using wpa_supplicant(8), you can easily + retrieve network scan results with wpa_cli(8):

+
+
wpa_cli scan_results
+
+

Or trigger a rescan:

+
+
wpa_cli scan
+
+
+
+

+

Several services depend on the RPC portmapper + rpcbind(8) - formerly known as + portmap - being running for proper operation. This + includes YP (NIS) and NFS exports, among other services. To get the RPC + portmapper to start automatically on boot, you will need to have this line + in /etc/rc.conf:

+

+
rpcbind=YES
+
+
+

+

Check the YP domain name with the domainname(1) + command. If necessary, correct it by editing the + /etc/defaultdomain file or by setting the + “domainname” variable in + /etc/rc.conf. The + /etc/rc.d/network script reads this file on bootup + to determine and set the domain name. You may also set the running system's + domain name with the domainname(1) command. To start YP + client services, simply run ypbind, then perform the + remaining YP activation as described in passwd(5) and + group(5).

+

In particular, to enable YP passwd support, you'll need to update + /etc/nsswitch.conf to include “nis” + for the “passwd” and “group” entries. A + traditional way to accomplish the same thing is to add following entry to + local passwd database via vipw(8):

+
+
+:*::::::::
+
+

Note this entry has to be the very last one. This traditional way + works with the default nsswitch.conf(5) setting of + “passwd”, which is “compat”.

+

There are many more YP man pages available to help you. You can + find more information by starting with nis(8).

+
+
+

+

Check that the disks are mounted correctly by comparing the + /etc/fstab file against the output of the + mount(8) and df(1) commands. + Example:

+
+
# cat /etc/fstab
+/dev/sd0a / ffs     rw              1 1
+/dev/sd0b none swap sw
+/dev/sd0e /usr ffs  rw              1 2
+/dev/sd0f /var ffs  rw              1 3
+/dev/sd0g /tmp ffs  rw              1 4
+/dev/sd0h /home ffs rw              1 5
+
+# mount
+/dev/sd0a on / type ffs (local)
+/dev/sd0e on /usr type ffs (local)
+/dev/sd0f on /var type ffs (local)
+/dev/sd0g on /tmp type ffs (local)
+/dev/sd0h on /home type ffs (local)
+
+# df
+Filesystem  1024-blocks     Used    Avail Capacity  Mounted on
+/dev/sd0a         22311    14589     6606    69%    /
+/dev/sd0e        203399   150221    43008    78%    /usr
+/dev/sd0f         10447      682     9242     7%    /var
+/dev/sd0g         18823        2    17879     0%    /tmp
+/dev/sd0h          7519     5255     1888    74%    /home
+
+# pstat -s
+Device      512-blocks     Used    Avail Capacity  Priority
+/dev/sd0b       131072    84656    46416    65%    0
+
+

Edit /etc/fstab and use the + mount(8) and umount(8) commands as + appropriate. Refer to the above example and fstab(5) for + information on the format of this file.

+

You may wish to do NFS mounts now too, or you can do them + later.

+
+
+

+

In order to make sure the system clock is synchronized to that of + a publicly accessible NTP server, make sure that + /etc/rc.conf contains the following:

+

+
ntpdate=YES
+
ntpd=YES
+

See date(1), ntpdate(8), + ntpd(8), rdate(8), and + timed(8) for more information on setting the system's + date.

+
+
+

+

The NetBSD packages collection, pkgsrc, + includes a large set of third-party software. A lot of it is available as + binary packages that you can download from + https://cdn.NetBSD.org/pub/pkgsrc/packages/NetBSD/ + or a mirror.

+

For most users, using pkgin to manage binary packages is + recommended.

+

To install pkgin, if it was not done by the installer:

+
+
PKG_PATH=https://cdn.NetBSD.org/pub/pkgsrc/packages/NetBSD/[...]
+export PKG_PATH
+pkg_add pkgin
+pkgin update
+pkgin install bash mpg123 fluxbox ...
+
+

See + https://www.pkgsrc.org/ and + pkgsrc/doc/pkgsrc.txt for more details.

+
+
+
+

+

The system should be usable now, but you may wish to do more + customizing, such as adding users, etc. Many of the following sections may + be skipped if you are not using that package (for example, skip the + Kerberos section if you won't be using + Kerberos). We suggest that you cd /etc and edit most + of the files in that directory.

+

Note that the /etc/motd file is modified + by /etc/rc.d/motd whenever the system is booted. To + keep any custom message intact, ensure that you leave two blank lines at the + top, or your message will be overwritten.

+
+

+

To add new users and groups, there are + useradd(8) and groupadd(8); see also + user(8) for further programs for user and group + manipulation. You may use vipw(8) to add users to the + /etc/passwd file and edit + /etc/group by hand to add new groups. The manual + page for su(1), tells you to make sure to put people in + the ‘wheel’ group if they need root access (non-Kerberos). For + example:

+
+
wheel:*:0:root,myself
+
+

Follow instructions for kerberos(8) if using + Kerberos for authentication.

+
+
+

+

/etc/rc and the + /etc/rc.d/* scripts are invoked at boot time after + single user mode has exited, and at shutdown. The whole process is + controlled by the master script /etc/rc. This script + should not be changed by administrators.

+

The directory /etc/rc.d contains a series + of scripts used at startup/shutdown, called by + /etc/rc. /etc/rc is in turn + influenced by the configuration variables present in + /etc/rc.conf.

+

The script /etc/rc.local is run as the + last thing during multiuser boot, and is provided to allow any other local + hooks necessary for the system.

+
+
+

+

To enable or disable various services on system startup, + corresponding entries can be made in /etc/rc.conf. + You can take a look at /etc/defaults/rc.conf to see + a list of default system variables, which you can override in + /etc/rc.conf. Note you are + supposed + to change /etc/defaults/rc.conf directly, edit only + /etc/rc.conf. See rc.conf(5) for + further information.

+
+
+

+

To use the amd(8) automounter, create the + /etc/amd directory, copy example config files from + /usr/share/examples/amd to + /etc/amd and customize them as needed. + Alternatively, you can get your maps with YP.

+
+
+

+

If you are using ccd(4) concatenated disks, edit + /etc/ccd.conf. You may wish to take a look to + ccdconfig(8) for more information about this file. Use the + ccdconfig -U command to unload and the + ccdconfig -C command to create tables internal to + the kernel for the concatenated disks. You then mount(8), + umount(8), and edit /etc/fstab as + needed.

+
+
+

+

npf(7) is the default firewall used on + NetBSD. You may wish to enable it if your machine is + connected directly to the internet. To do this, edit + /etc/npf.conf and set “npf=YES” in + /etc/rc.conf. Configuration examples for NPF can be + found in /usr/share/examples/npf. Before installing + a configuration, you can validate it with npfctl(8).

+
+
+

+

If you've installed X, you may want to turn on + xdm(1), the X Display Manager. To do this, set + “xdm=YES” in /etc/rc.conf.

+
+
+

+

Edit /etc/printcap and + /etc/hosts.lpd to get any printers set up. Consult + lpd(8) and printcap(5) if needed.

+
+
+

+

Various internet services can be enabled in + /etc/inetd.conf, including + httpd(8) and finger(1). Note that by + default all services are disabled for security reasons. Only add things that + are really needed.

+
+
+

+

If you are going to use Kerberos for authentication, see + kerberos(8) and “info heimdal” for more + information. If you already have a Kerberos master, change directory to + /etc/kerberosV and configure. Remember to get a + srvtab from the master so that the remote commands + work.

+
+
+

+

Check /etc/mail/aliases and update + appropriately if you want e-mail to be routed to non-local addresses or to + different users.

+

Run newaliases(1) after changes.

+
+
+

+

NetBSD uses Postfix as its Mail Transfer + Agent. Postfix is started by default, but its initial configuration does not + cause it to listen on the network for incoming connections. To configure + Postfix, see /etc/postfix/main.cf and + /etc/postfix/master.cf. If you wish to use a + different MTA (e.g., sendmail), install your MTA of choice and edit + /etc/mailer.conf to point to the proper + binaries.

+
+
+

+

If this is a DHCP server, edit + /etc/dhcpd.conf and + /etc/dhcpd.interfaces as needed. You will have to + make sure /etc/rc.conf has “dhcpd=YES” + or run dhcpd(8) manually.

+
+
+

+

If this is a Bootparam server, edit + /etc/bootparams as needed. You will have to turn it + on in /etc/rc.conf by adding + “bootparamd=YES”.

+
+
+

+

If this is an NFS server, make sure + /etc/rc.conf has:

+
+
nfs_server=YES
+mountd=YES
+rpcbind=YES
+
+

Edit /etc/exports and get it correct. + After this, you can start the server by issuing:

+
+
service rpcbind start
+service mountd start
+service nfsd start
+
+which will also start dependencies. +
+
+

+

Edit /etc/rbootd.conf if needed for remote + booting. If you do not have HP computers doing remote booting, do not enable + this.

+
+
+

+

Look at and possibly edit the + /etc/daily.conf, + /etc/weekly.conf, and + /etc/monthly.conf configuration files. You can check + which values you can set by looking to their matching files in + /etc/defaults. Your site specific things should go + into /etc/daily.local, + /etc/weekly.local, and + /etc/monthly.local.

+

These scripts have been limited so as to keep the system running + without filling up disk space from normal running processes and database + updates. (You probably do not need to understand them.)

+
+
+

+

Look at the other files in /etc and edit + them as needed. (Do not edit files ending in .db + — like pwd.db, + spwd.db, nor localtime, nor + rmt, nor any directories.)

+
+
+

+

Check what is running by typing crontab -l + as root and see if anything unexpected is present. Do you need anything + else? Do you wish to change things? For example, if you do not like root + getting standard output of the daily scripts, and want only the security + scripts that are mailed internally, you can type crontab + -e and change some of the lines to read:

+
+
30  1  *  *  *   /bin/sh /etc/daily 2>&1 > /var/log/daily.out
+30  3  *  *  6   /bin/sh /etc/weekly 2>&1 > /var/log/weekly.out
+30  5  1  *  *   /bin/sh /etc/monthly 2>&1 > /var/log/monthly.out
+
+

See crontab(5).

+
+
+

+

After the first night's security run, change ownerships and + permissions on files, directories, and devices; root should have received + mail with subject: "<hostname> daily insecurity output.". + This mail contains a set of security recommendations, presented as a list + looking like this:

+
+
var/mail:
+        permissions (0755, 0775)
+etc/daily:
+        user (0, 3)
+
+

The best bet is to follow the advice in that list. The recommended + setting is the first item in parentheses, while the current setting is the + second one. This list is generated by mtree(8) using + /etc/mtree/special. Use chmod(1), + chgrp(1), and chown(8) as needed.

+
+
+
+

+

At this point, the system should be fully configured to your + liking. It is now a good time to ensure that the system behaves according to + its specifications and that it is stable on your hardware. Please refer to + tests(7) for details on how to do so.

+

You can use ps(1), netstat(1), + and fstat(1) to check on running processes, network + connections, and opened files, respectively. Other tools you may find useful + are systat(1) and top(1).

+
+
+

+

chgrp(1), chmod(1), + config(1), crontab(1), + date(1), df(1), + domainname(1), fstat(1), + hostname(1), make(1), + man(1), netstat(1), + newaliases(1), passwd(1), + pkg_add(1), ps(1), + ssh(1), su(1), + systat(1), top(1), + xdm(1), ccd(4), + aliases(5), crontab(5), + dhcpcd.conf(5), exports(5), + fstab(5), group(5), + hosts(5), ifconfig.if(5), + mailer.conf(5), named.conf(5), + nsswitch.conf(5), passwd(5), + printcap(5), rc.conf(5), + resolv.conf(5), sshd_config(5), + wpa_supplicant.conf(5), wscons.conf(5), + hier(7), hostname(7), + pkgsrc(7), tests(7), + amd(8), ccdconfig(8), + chown(8), devpubd(8), + dhcpcd(8), dhcpd(8), + dmesg(8), groupadd(8), + ifconfig(8), inetd(8), + kerberos(8), lpd(8), + mdnsd(8), mount(8), + mrouted(8), mtree(8), + named(8), nis(8), + ntpd(8), ntpdate(8), + rbootd(8), rc(8), + rdate(8), rmt(8), + route(8), rpc.bootparamd(8), + rpcbind(8), sshd(8), + timed(8), umount(8), + useradd(8), vipw(8), + wpa_cli(8), wpa_supplicant(8), + yp(8), ypbind(8)

+
+
+

+

This document first appeared in OpenBSD + 2.2. It has been adapted to NetBSD and first + appeared in NetBSD 2.0.

+
+
+ + + + + +
June 4, 2021NetBSD 10.1
diff --git a/static/netbsd/man8/ahdilabel.8 b/static/netbsd/man8/ahdilabel.8 new file mode 100644 index 00000000..379f723f --- /dev/null +++ b/static/netbsd/man8/ahdilabel.8 @@ -0,0 +1,178 @@ +.\" $NetBSD: ahdilabel.8,v 1.14 2017/07/03 21:31:00 wiz Exp $ +.\" +.\" +.\" Copyright (c) 1999 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Julian Coleman and Leo Weppelman. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.Dd February 17, 2017 +.Dt AHDILABEL 8 atari +.Os +.Sh NAME +.Nm ahdilabel +.Nd modify AHDI partitions +.Sh SYNOPSIS +.Nm +.Ar disk +.Sh DESCRIPTION +.Nm +allows you to modify the AHDI partition table on a disk partitioned with +AHDI or an AHDI compatible formatter. The AHDI partition format is usually +only present on disks shared between +.Nx +and some other OS. The partition identifiers are used by +.Nx +as a guideline to emulate a disklabel on such a disk. +.Pp +.Nm +supports the following options: +.Pp +.Bl -tag -width disk +.It Ar disk +The name of the disk you want to edit. +.Nm +will first try to open a disk of this name. If this cannot +be opened, it will attempt to open +.Ar r Ns Ns Ar c . +Finally, if this also cannot be opened, it will attempt to open +.Ar /dev/r Ns Ns Ar c . +.El +.Pp +.Nm +will display information about the number of sectors, tracks +and sectors on the disk, as well as the current AHDI partition information. +It will then prompt for input. The input choices are: +.Pp +.Bl -tag -width a-p +.It Ar a-p +Modify a partition. You will be prompted for a partition id, root, start +and size. +.Nx +recognises the following partition id's: +.Pp +.Bl -tag -width "GEM or BGM" -compact +.It NBD +Partition is reserved for +.Nx . +This can be either a root or an user partition. The first NBD +partition on a disk will be mapped to +.Nx +partition letter +.Em a . +The following NBD partitions will be mapped from letter +.Em d +up. +The filesystem type is ffs by default. +.It SWP +The first SWP partition is mapped to partition +.Em b . +.It GEM or BGM +These partitions are mapped from +.Em d +up. The filesystem type is msdos. +.El +.Pp +The root, start and size parameters can be entered using sector, +cylinder/track/sector or megabyte notations. Whole numbers of cylinders can +be entered using the shorthand /. Likewise, whole numbers of tracks +can be entered using the shorthand //. Megabytes are entered +using the suffix +.Em M . +.Pp +The following can also be used to enter partition parameters: +.Pp +.Bl -tag -width "-N (start)" -compact +.It \-N (root) +Position the root sector for this partition immediately after partition N. +.It \-N (start) +Make this partition start after partition N (leaving a gap of 1 sector for a +root sector, if necessary). +.It \-N (size) +Make this partition end immediately before partition N. +.It -1 (size) +Make this partition extend to the end of the disk. +.El +.Pp +The sector holding the primary AHDI partition table only has space for four +partitions. Thus, if a disk has more than four partitions, the extra +partition information is held in auxiliary root sectors. There is one +auxiliary root for each additional partition (and also for the fourth +partition, if the disk has more than four partitions). +.It Ar r +Recalculate the root sectors. This will automatically assign auxiliary +root sectors if the disk has more than 4 partitions. The auxiliary root +sectors will be positioned in a default location preceding the relevant +partition. +.It Ar s +Show the current partition information. +.It Ar u +Toggle the unit display between sector and cylinder/track/sector notation. +.It Ar w +Write the AHDI partition table to the disk. +.It Ar z +Options for zero'ing the boot sector and bad sector lists. The default is to +preserve them both. +.It Ar q +Quit +.El +.Sh EXAMPLES +.Dl ahdilabel sd0 +Edit the AHDI label for disk sd0. +.Sh SEE ALSO +.Xr atari/bootpref 8 , +.Xr atari/installboot 8 , +.Xr disklabel 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 1.5 . +.Sh BUGS +The changes made to the AHDI partitions will become active on the next +.Em first open +of the disk. You are advised to use +.Nm +only on a disk without any mounted or otherwise active partitions. This +is not enforced by +.Nm . +.Pp +Because of way +.Nx +interprets AHDI partition tables to create the +.Nx +disklabel, the +.Nx +partition ordering may change if partitions labelled NBD are created or +removed. +.Pp +Creating an AHDI partition table on a disk that previously did not have +one will almost certainly overwrite any existing partition information +and/or data on that disk. This is especially the case if auxiliary root +sectors are needed for the AHDI partition table. +.Pp +As soon as a disk contains at least one NBD partition, you are allowed to +write +.Nx +disklabels and install bootstraps. diff --git a/static/netbsd/man8/altboot.8 b/static/netbsd/man8/altboot.8 new file mode 100644 index 00000000..177b15ed --- /dev/null +++ b/static/netbsd/man8/altboot.8 @@ -0,0 +1,288 @@ +.\" $NetBSD: altboot.8,v 1.11 2020/08/29 13:32:27 fcambus Exp $ +.\" +.\" Copyright (c) 2011 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Tohru Nishimura. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd October 7, 2013 +.Dt ALTBOOT 8 sandpoint +.Os +.Sh NAME +.Nm altboot +.Nd program to boot +.Nx +kernel from disk or network +.Sh DESCRIPTION +.Nm +is a standalone program which works on top of a +.Tn NAS +product's bootloader. +It is capable of loading a +.Nx +kernel from an +.Tn IDE +or +.Tn SATA +disk drive, or via network with +.Tn NFS +or +.Tn TFTP +protocol. +.Nm +can be stored in flash ROM. +Typically you will first copy it from flash into RAM and then invoke +it there to boot the +.Nx +kernel. +.Pp +.Nm +runs in conjunction with popular +.Tn U-Boot/PPCBoot +bootloaders used by +.Tn NAS +products. +With an appropriate boot command line, saved in the environment, +.Nm +can load and start a +.Nx +kernel without manual intervention. +The original +.Tn U-Boot/PPCBoot +bootloaders remain useful and altboot works as a functional extension +of them. +.Sh EXAMPLES +.Nm +occupies less than 128KB in volume and can be stored to any vacant +space of the system's flash. +It is made to run at RAM address offset 0x0100'0000. +.Tn U-Boot/PPCboot +is instructed to copy the program to RAM in this way: +.Pp +.Dl => cp.b fffe0000 1000000 20000 +.Pp +Here 0xfffe'0000 is the flash address where +.Nm +is stored while 0x0100'0000 is the RAM address to copy to. +.Pp +The invocation syntax is: +.Pp +.Dl => go 1000000 Ar ide:N Ar opt1 Ar opt2 ... Ar bootname +.Bl -tag -width xx +.It Va ide:N +where +.Ar N +is a string of digits, which defines the number of connected drives on each +PATA channel. +This option is useful to avoid the delays, when +.Nm +is trying to detect a non-existing drive. +Examples: +.Bl -tag -width xx +.It ide: Ns Ar 10 +A single master drive on the first channel. +Nothing on the second channel. +.It ide: Ns Ar 22 +A master and slave drive on both channels of the first controller. +.It ide: Ns Ar 1111 +A master drive on each channel. +The first two digits belong to the first +controller, the last two to the second controller. +.El +.Pp +Unspecified digits will be read as +.Ar 0 . +The +.Ar ide +option has only a meaning for PATA disks. +Omitting it makes it default to +.Ar ide:10 . +.Pp +.It Va optN +multi, auto, ask, single, ddb, userconf, norm, quiet, verb, +silent, debug +.Pp +Omitting optN makes +.Nm +default to multi-user mode boot. +.Pp +N.B., the maximum number of allowed go command arguments varies +and depends on the +.Tn U-Boot/PPCBoot +buildtime configuration. +.It Va bootname +One of the following: +.Pp +.Dl nfs: Ns Ar filename +.Dl nfs: +.Dl tftp: Ns Ar filename +.Dl tftp: +.Dl wd Ns Ar Np : Ns Ar filename +.Dl wd Ns Ar Np : +.Dl mem: Ns Ar address +.Dl net: +.Pp +The last one is a synonym for +.Dq nfs . +.It nfs: Ns Va filename +issue a +.Tn DHCP +request to determine the +.Tn IP +address and download +.Ar filename +from the +.Tn NFS +server. +.It nfs: +target file is determined by +.Sy filename +field of +.Pa /etc/dhcpd.conf +.It tftp: Ns Va filename +issue a +.Tn DHCP +request to determine +.Tn IP +address and download +.Ar filename +from the +.Tn TFTP +server. +.It tftp: +target file is determined by +.Sy filename +field of +.Pa /etc/dhcpd.conf +.It wd Ns Va Np : Ns Va filename +load the +.Tn ELF +.Nx +kernel +.Ar filename +from an +.Tn FFSv2 +or +.Tn FFSv1 +filesystem. +.Ar N +is a number to distinguish the target drive. +.Ar p +is a partition specifier. +When omitted, partition +.Sq a +is assumed. +.Dq wd0a +means partition +.Sq a +of the first disk drive. +.It wd Ns Va Np : +use filename +.Dq netbsd +for booting the +.Tn ELF +.Nx +kernel. +.It mem: Ns Va address +boots the +.Tn ELF +.Nx +kernel from any address in memory. +The +.Ar address +argument has to be specified as a hexadecimal number and denotes the +start address of the +.Tn ELF +image in memory. +.El +.Pp +.Nm +can boot from RAID 1 partitions, but only if the RAID partition is the +first partition on the disk. +.Pp +.Tn U-Boot/PPCBoot +provides a way to run a short list of commands right after power-on. +The following is a procedure to setup the system for starting +.Nx +after a 5 second delay, allowing the user to break into interactive +mode. +Note that a backslashed +.Sq \&; +is necessary to enter the script correctly. +.Bd -literal -offset indent +=> setenv bootcmd cp.b fffe0000 1000000 20000\e; go 1000000 wd0: +=> setenv bootdelay 5 +=> saveenv +.Ed +.Pp +When +.Tn U-Boot/PPCBoot +is lacking important commands like +.Tn cp +or +.Tn go , +or is unable to save the environment, then there is still the option to +replace the +.Tn Linux +kernel module by +.Pa altboot.img +and save it to the same address in flash ROM. +In this case you have only two options left to pass arguments: +.Pp +.Bl -bullet -compact +.It +Enter the interactive command line mode, after +.Nm +has started. +This requires a serial console. +.It +Write a fixed command line into flash, replacing the +.Tn Linux +initrd image. +The command line is a normal +.Tn ASCII +file, started by the identifier +.Em altboot: +and terminated by any control character between 0 and 31. +Example: +.Dl altboot:silent ide:1111 wd0:netbsd +.El +.Sh SEE ALSO +.Xr dhcpd 8 , +.Xr diskless 8 , +.Xr nfsd 8 , +.Xr raidctl 8 , +.Xr tftpd 8 +.Sh HISTORY +The +.Nx Ns Tn /sandpoint +.Nm +first appeared in +.Nx 6.0 . +.Sh BUGS +The Realtek Gigabit Ethernet driver does not work correctly at 1000 Mbps. +Another known problem of this driver is that it runs into a timeout after +a coldstart. +The system has to be rebooted at least once to make it work. diff --git a/static/netbsd/man8/altqd.8 b/static/netbsd/man8/altqd.8 new file mode 100644 index 00000000..8c9d0bdd --- /dev/null +++ b/static/netbsd/man8/altqd.8 @@ -0,0 +1,111 @@ +.\" $NetBSD: altqd.8,v 1.12 2023/11/15 02:23:52 gutteridge Exp $ +.\" $KAME: altqd.8,v 1.9 2002/01/23 06:56:27 itojun Exp $ +.\" +.\" Copyright (C) 2000 +.\" Sony Computer Science Laboratories Inc. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd November 26, 2006 +.Dt ALTQD 8 +.Os +.Sh NAME +.Nm altqd +.Nd ALTQ daemon +.Sh SYNOPSIS +.Nm altqd +.Op Fl dv +.Op Fl f Ar conf_file +.Sh DESCRIPTION +.Nm +is a daemon program that reads a configuration file and then sets up +the ALTQ state of network interfaces. +After configuring the ALTQ state, +.Nm +will detach and become a daemon. +.Pp +The signals +.Dv SIGINT +or +.Dv SIGTERM +will shut down +.Nm , +and the signal +.Dv SIGHUP +will restart +.Nm . +.Pp +The following options are available: +.Bl -tag -width Fl +.It Fl d +Debug mode. +.Nm +does not detach and goes into the command mode. +.It Fl f Ar conf_file +Specify a configuration file to read instead of the default. +The default file is +.Pa /etc/altq.conf . +.It Fl v +Print debugging information. +This option implies +.Fl d . +.El +.Sh COMMANDS +When +.Fl d +option is provided, +.Nm +goes into the command mode after reading the configuration file and +setting up the ALTQ state. +Each command is a single line, starting with the command verb. +.Pp +The basic commands are as follows: +.Bl -tag -width help +.It Cm help | \&? +Display a complete list of commands and their syntax. +.It Cm quit +Exit. +.It Cm altq Ar reload +Reload the configuration file and reinitialize ALTQ. +.It Cm altq Ar interface Op enable|disable +Enables or disables ALTQ on the interface named +.Em interface . +When +.Nm +enters the command mode, ALTQ is enabled on all the +interfaces listed in the configuration file. +.El +.Sh FILES +.Bl -tag -width /var/run/altqd.pid -compact +.It Pa /etc/altq.conf +configuration file +.It Pa /var/run/altqd.pid +pid of the running +.Nm +.It Pa /var/run/altq_quip +Unix domain socket for communicating with +.Xr altqstat 1 +.El +.Sh SEE ALSO +.Xr altqstat 1 , +.Xr altq.conf 5 , +.Xr altq 9 diff --git a/static/netbsd/man8/amd.8 b/static/netbsd/man8/amd.8 new file mode 100644 index 00000000..dd25ac60 --- /dev/null +++ b/static/netbsd/man8/amd.8 @@ -0,0 +1,369 @@ +.\" $NetBSD: amd.8,v 1.4 2015/01/17 17:46:31 christos Exp $ +.\" +.\" +.\" Copyright (c) 1997-2014 Erez Zadok +.\" Copyright (c) 1989 Jan-Simon Pendry +.\" Copyright (c) 1989 Imperial College of Science, Technology & Medicine +.\" Copyright (c) 1989 The Regents of the University of California. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to Berkeley by +.\" Jan-Simon Pendry at Imperial College, London. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" +.\" File: am-utils/amd/amd.8 +.\" +.TH AMD 8 "3 November 1989" +.SH NAME +amd \- automatically mount file systems +.SH SYNOPSIS +.B amd +.B \-H +.br +.B amd +[ +.BI \-F " conf_file" +] +.br +.B amd +[ +.B \-nprvHS +] [ +.BI \-a " mount_point" +] [ +.BI \-c " duration" +] [ +.BI \-d " domain" +] [ +.BI \-k " kernel-arch" +] [ +.BI \-l " logfile" +] [ +.BI \-o " op_sys_ver" +] [ +.BI \-t " interval.interval" +] [ +.BI \-w " interval" +] [ +.BI \-x " log-option" +] [ +.BI \-y " YP-domain" +] [ +.BI \-A " arch" +] [ +.BI \-C " cluster-name" +] [ +.BI \-D " option" +] [ +.BI \-F " conf_file" +] [ +.BI \-O " op_sys_name" +] [ +.BI \-T " tag" +] +[ +.I directory +.I mapname +.RI [ " \-map-options " ] +] .\|.\|. +.SH DESCRIPTION +.B Amd +is a daemon that automatically mounts filesystems +whenever a file or directory +within that filesystem is accessed. +Filesystems are automatically unmounted when they +appear to have become quiescent. +.LP +.B Amd +operates by attaching itself as an +.SM NFS +server to each of the specified +.IB directories . +Lookups within the specified directories +are handled by +.BR amd , +which uses the map defined by +.I mapname +to determine how to resolve the lookup. +Generally, this will be a host name, some filesystem information +and some mount options for the given filesystem. +.LP +In the first form depicted above, +.B amd +will print a short help string. In the second form, if no options are +specified, or the +.B -F +is used, +.B amd +will read configuration parameters from the file +.I conf_file +which defaults to +.BR /etc/amd.conf . +The last form is described below. +.SH OPTIONS + +.\"*******************************************************" + +.TP +.BI \-a " temporary-directory" +Specify an alternative location for the real mount points. +The default is +.BR /a . + +.TP +.BI \-c " duration" +Specify a +.IR duration , +in seconds, that a looked up name remains +cached when not in use. The default is 5 minutes. + +.TP +.BI \-d " domain" +Specify the local domain name. If this option is not +given the domain name is determined from the hostname. + +.TP +.BI \-k " kernel-arch" +Specifies the kernel architecture. This is used solely +to set the ${karch} selector. + +.TP +.BI \-l " logfile" +Specify a logfile in which to record mount and unmount events. +If +.I logfile +is the string +.B syslog +then the log messages will be sent to the system log daemon by +.IR syslog (3). +The default syslog facility used is LOG_DAEMON. If you +wish to change it, append its name to the log file name, delimited by a +single colon. For example, if +.I logfile +is the string +.B syslog:local7 +then +.B Amd +will log messages via +.IR syslog (3) +using the LOG_LOCAL7 facility (if it exists on the system). + +.TP +.B \-n +Normalize hostnames. +The name refereed to by ${rhost} is normalized relative to the +host database before being used. The effect is to translate +aliases into ``official'' names. + +.TP +.BI \-o " op_sys_ver" +Override the compiled-in version number of the operating system. Useful +when the built in version is not desired for backward compatibility reasons. +For example, if the build in version is ``2.5.1'', you can override it to +``5.5.1'', and use older maps that were written with the latter in mind. + +.TP +.B \-p +Print PID. +Outputs the process-id of +.B amd +to standard output where it can be saved into a file. + +.TP +.B \-r +Restart existing mounts. +.B Amd +will scan the mount file table to determine which filesystems +are currently mounted. Whenever one of these would have +been auto-mounted, +.B amd +.I inherits +it. + +.TP +.BI \-t " timeout.retransmit" +Specify the NFS timeout +.IR interval , +in tenths of a second, between NFS/RPC retries (for UDP only). The default +is 0.8 seconds. The second value alters the retransmit counter, which +defaults to 11 retransmissions. Both of these values are used by the kernel +to communicate with amd. Useful defaults are supplied if either or both +values are missing. + +Amd relies on the kernel RPC retransmit mechanism to trigger mount retries. +The values of these parameters change the overall retry interval. Too long +an interval gives poor interactive response; too short an interval causes +excessive retries. + +.TP +.B \-v +Version. Displays version and configuration information on standard error. + +.TP +.BI \-w " interval" +Specify an +.IR interval , +in seconds, between attempts to dismount +filesystems that have exceeded their cached times. +The default is 2 minutes. + +.TP +.BI \-x " options" +Specify run-time logging options. The options are a comma separated +list chosen from: fatal, error, user, warn, info, map, stats, defaults, and +all. Note that "fatal" and "error" are mandatory and cannot be turned off. + +.TP +.BI \-y " domain" +Specify an alternative NIS domain from which to fetch the NIS maps. +The default is the system domain name. This option is ignored if NIS +support is not available. + +.TP +.BI \-A " arch" +Specifies the OS architecture. This is used solely to set the ${arch} +selector. + +.TP +.BI \-C " cluster-name" +Specify an alternative HP-UX cluster name to use. + +.TP +.BI \-D " option" +Select from a variety of debug options. Prefixing an +option with the strings +.B no +reverses the effect of that option. Options are cumulative. +The most useful option is +.BR all . +Since +.I \-D +is only used for debugging other options are not documented here: +the current supported set of options is listed by the \-v option +and a fuller description is available in the program source. + +.TP +.BI \-F " conf_file" +Specify an amd configuration file to use. See +.BR amd.conf (5) +for description of this file's format. This configuration file is used to +specify any options in lieu of typing many of them on the command line. The +.I amd.conf +file includes directives for every command line option amd has, and many +more that are only available via the configuration file facility. The +configuration file specified by this option is processed after all other +options had been processed, regardless of the actual location of this option +on the command line. + +.TP +.B \-H +Print help and usage string. + +.TP +.BI \-O " op_sys_name" +Override the compiled-in name of the operating system. Useful when the +built in name is not desired for backward compatibility reasons. For +example, if the build in name is ``sunos5'', you can override it to +``sos5'', and use older maps which were written with the latter in mind. + +.TP +.B \-S +Do not lock the running executable pages of amd into memory. To improve +amd's performance, systems that support the +.BR plock (3) +call, could lock the amd process into memory. This way there is less chance +the operating system will schedule, page out, and swap the amd process as +needed. This tends improves amd's performance, at the cost of reserving the +memory used by the amd process (making it unavailable for other processes). +If this behavior is not desired, use the +.B \-S +option. + +.TP +.BI \-T " tag" +Specify a tag to use with +.BR amd.conf (5). +All map entries tagged with +.I tag +will be processed. Map entries that are not tagged are always processed. +Map entries that are tagged with a tag other than +.I tag +will not be processed. + +.SH FILES +.TP 5 +.B /a +directory under which filesystems are dynamically mounted +.TP 5 +.B /etc/amd.conf +default configuration file +.SH CAVEATS +Some care may be required when creating a mount map. +.LP +Symbolic links on an NFS filesystem can be incredibly inefficient. +In most implementations of NFS, their interpolations are not cached +by the kernel and each time a symlink is encountered during a +.I lookuppn +translation it costs an RPC call to the NFS server. +It would appear that a large improvement in real-time +performance could be gained by adding a cache somewhere. +Replacing symlinks with a suitable incarnation of the auto-mounter +results in a large real-time speedup, but also causes a large +number of process context switches. +.LP +A weird imagination is most useful to gain full advantage of all +the features. +.SH "SEE ALSO" +.BR domainname (1), +.BR hostname (1), +.BR syslog (3). +.BR amd.conf (5), +.BR mtab (5), +.BR amq (8), +.\" .BR automount (8), +.BR mount (8), +.BR umount (8), +.LP +``am-utils'' +.BR info (1) +entry. +.LP +.I "Linux NFS and Automounter Administration" +by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001). +.LP +.I http://www.am-utils.org +.LP +.I "Amd \- The 4.4 BSD Automounter" +.SH AUTHORS +Jan-Simon Pendry , Department of Computing, Imperial College, London, UK. +.P +Erez Zadok , Computer Science Department, Stony Brook +University, Stony Brook, New York, USA. +.P +Other authors and contributors to am-utils are listed in the +.B AUTHORS +file distributed with am-utils. diff --git a/static/netbsd/man8/amldb.8 b/static/netbsd/man8/amldb.8 new file mode 100644 index 00000000..f92afd32 --- /dev/null +++ b/static/netbsd/man8/amldb.8 @@ -0,0 +1,363 @@ +.\" $NetBSD: amldb.8,v 1.8 2021/08/17 22:00:33 andvar Exp $ +.\" ACPI (ACPI Package) +.\" +.\" Copyright (c) 2000 Takanori Watanabe +.\" Copyright (c) 2000 Mitsuru IWASAKI +.\" Copyright (c) 2000 Yasuo YOKOYAMA +.\" Copyright (c) 2000 Norihiro KUMAGAI +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD: src/usr.sbin/acpi/amldb/amldb.8,v 1.10 2002/08/13 16:07:26 ru Exp $ +.\" +.Dd August 31, 2000 +.Dt AMLDB 8 +.Os +.Sh NAME +.Nm amldb +.Nd executing and debugging AML interpreter +(with DSDT files) +.Sh SYNOPSIS +.Nm +.Op Fl dhst +.Ar dsdt_file ... +.Sh DESCRIPTION +The +.Nm +utility parses the DSDT +(Differentiated System Description Table) +files, which usually are acquired from ACPI BIOS, and executes +the sequence of ACPI Control Methods described in AML +(ACPI Machine Language) +with its AML interpreter. +The +.Nm +utility also has a simple ACPI virtual machine. +During execution of the +Control Methods each access to the region, such as +SystemMemory, SystemIO, PCI_Config, does not affect the real +hardware but only the virtual machine. +Because the sequence of virtual accesses is maintained in user space, +AML interpreter developers need not worry about any effect on hardware +when they analyze DSDT data files. +They can develop and debug the +interpreter, even if the machine has no ACPI BIOS. +.Pp +The developer will need to acquire a DSDT data file from any machine +with ACPI BIOS through +.Xr acpidump 8 . +The DSDT is a table, a part of the whole ACPI memory table +located in somewhere in the BIOS area +.Pq Li 0xa0000 \- 0x100000 . +It includes such information as the detailed hardware information +for PnP, and the set of procedures which perform power management from +the OS. +The information is stored in AML format. +.Pp +The AML interpreter can execute any of the Control Methods specified +by users. +When executed, it interprets the byte sequence in the +Control Method of DSDT, and disassembles the opcodes that it +recognizes into ASL +(ACPI Source Language) +format to be displayed. +.Pp +If it encounters one of more accesses to the region such as +SystemMemory in executing the Control Methods, its ACPI Virtual +Machine simulates the input/output operations to the resources in the +region. +In writing to a certain region, the ACPI Virtual Machine +prepares a piece of memory corresponding to its address, +if necessary, and holds the specified value in the memory as the +.Em region contents . +In reading from a certain region, it fetches the value in the memory +.Pq Em region contents , +prompts with it as the following: +.Bd -literal -offset indent +DEBUG[read(0, 0x100b6813)&mask:0x1](default: 0x1 / 1) >> +.Ed +.Pp +for users to have the opportunity to modify it, and hands it to +the AML interpreter. +In case that there is no corresponding region +in the AML Virtual Machine, the value zero is handed. +.Pp +The interpreter continues to maintain all of the +.Em region contents +until +.Nm +terminates. +You can specify their initial values with the file +.Pa region.ini +in the current directory. +If it is executed with +.Fl d +option, it dumps the final status of all of its +.Em region contents +to the file +.Pa region.dmp +when it terminates. +Each line of there files consists of the following +fields, separated by tabs; region type, address, and value. +Region types are specified as follows; +.Bl -tag -width "Value" -compact -offset indent +.It Sy Value +.Sy Region type +.It 0 +SystemMemory +.It 1 +SystemIO +.It 2 +PCI_Config +.It 3 +EmbeddedControl +.It 4 +SMBus +.El +.Pp +Interactive commands are described below: +.Bl -tag -width indent +.It Cm s +.Em Single step : +Performs single-step execution of the current Control Method. +If the next instruction is an invocation of another Control Method, +the step execution will continue in the following Control Method. +.It Cm n +.Em Step program : +Performs single-step execution of the current Control Method. +Even if the next instruction is an invocation of another Control +Method, the step execution will not continue. +.It Cm c +.Em Continue program being debugged : +Resumes execution of the AML interpreter. +Because the current +.Nm +has no way of breakpoint, this command might not so much useful. +.It Cm q +.Em Quit method execution : +Terminates execution of the current Control Method. +If +.Nm +is not in execution, this command causes to input the next +DSDT data file. +If there are no next DSDT data files, it terminates +.Nm +itself. +.It Cm t +.Em Show local name space tree and variables : +Displays the structure of the ACPI namespace tree. +If +.Nm +is in execution, this command displays the structure that relates +to the objects, arguments, and local variables below the scope of the +current Control Method. +.It Cm i +.Em Toggle region input prompt : +Switches whether the prompt for modifying the value read from the +.Em region contents +be showed or not. +Default is On. +.It Cm o +.Em Toggle region output prompt : +Switches whether the prompt for modifying the value to be written +to the region contents will be shown or not. +The default is Off. +.It Cm m +.Em Show memory management statistics : +Displays the current statistics of the memory management system +on the AML interpreter. +.It Cm r Ar method +.Em Run specified method : +Executes the specified Control Method. +If it requires one or +more arguments, a prompt such as the following appears; +.Bd -literal +Method: Arg 1 From 0x280626ce To 0x28062775 + Enter argument values (ex. number 1 / string foo). 'q' to quit. + Arg0 ? +.Ed +.Pp +For each argument, a pair of type string and value delimited by +one or more spaces can be entered. +Now only +.Ic number +and +.Ic string +can be specified as the type string. +In the current implementation, only the first character of the type +string, such as +.Ic n +or +.Ic s , +is identified. +For example, we can enter as follows: +.Bd -literal + Arg0 ? n 1 +.Ed +.Pp +.It Cm f Ar string +.Em Find named objects from namespace : +Lists the named objects that includes the specified string as the +terminate elements searching from the ACPI namespace. +For the namespace is expressed as the sequence of four-character +elements, appropriate number of additional underscore +.Pq Ql _ +characters are necessary for specifying objects which have less than four +character string. +Unless additional underscores specified, matching +occurs as the beginning of word with the specified number of characters. +.It Cm h +.Em Show help message : +Displays the command summary of +.Nm . +.El +.Sh OPTIONS +Exactly one of the following options must be specified. +Otherwise, +.Nm +shows its usage and terminates. +.Bl -tag -width indent +.It Fl d +Dump the final status of all of the +.Em region contents +in the ACPI Virtual Machine to the file +.Pa region.dmp . +.It Fl h +Terminate with the usage of this command. +.It Fl s +Display the statistics of the memory management system on the +AML interpreter when +.Nm +terminates. +.It Fl t +Display the tree structure of ACPI namespace after the +DSDT data file is read. +.El +.Sh FILES +.Bl -tag -width region.ini -compact +.It Pa region.ini +.It Pa region.dmp +.El +.Sh EXAMPLES +The following is an example including, invoking the +.Nm , +searching +.Li _PRS +(Possible Resource Settings) +objects, and executing the +.Li _PTS +(Prepare To Sleep) +Control Method by the AML interpreter. +.Bd -literal -offset indent +% amldb p2b.dsdt.dat +Loading p2b.dsdt.dat...done +AML>f _PRS +\\_SB_.PCI0.ISA_.PS2M._PRS. +\\_SB_.PCI0.ISA_.IRDA._PRS. +\\_SB_.PCI0.ISA_.UAR2._PRS. +\\_SB_.PCI0.ISA_.UAR1._PRS. +\\_SB_.PCI0.ISA_.ECP_._PRS. +\\_SB_.PCI0.ISA_.LPT_._PRS. +\\_SB_.PCI0.ISA_.FDC0._PRS. +\\_SB_.LNKD._PRS. +\\_SB_.LNKC._PRS. +\\_SB_.LNKB._PRS. +\\_SB_.LNKA._PRS. +AML>r _PTS +Method: Arg 1 From 0x2805f0a3 To 0x2805f0db + Enter argument values (ex. number 1 / string foo). 'q' to quit. + Arg0 ? n 5 +==== Running _PTS. ==== +AML>s +[\\_PTS. START] +If(LNot(LEqual(Arg0, 0x5))) +AML> +If(LEqual(Arg0, 0x1)) +AML> +If(LEqual(Arg0, 0x2)) +AML> +Store(One, TO12) +[aml_region_write(1, 1, 0x1, 0xe42c, 0x18, 0x1)] +amldb: region.ini: No such file or directory + [1:0x00@0xe42f]->[1:0x01@0xe42f] +[write(1, 0x1, 0xe42f)] +[aml_region_read(1, 1, 0xe42c, 0x18, 0x1)] + [1:0x01@0xe42f] +DEBUG[read(1, 0xe42f)&mask:0x1](default: 0x1 / 1) >> +[read(1, 0xe42f)->0x1] +AML> +Or(Arg0, 0xf0, Local2)[Copy number 0xf5] +AML>t +_PTS Method: Arg 1 From 0x2805f0a3 To 0x2805f0db + Arg0 Num:0x5 + Local2 Num:0xf5 +AML>s +Store(Local2, DBG1) +[aml_region_write(1, 1, 0xf5, 0x80, 0x0, 0x8)] + [1:0x00@0x80]->[1:0xf5@0x80] +[write(1, 0xf5, 0x80)] +[aml_region_read(1, 1, 0x80, 0x0, 0x8)] + [1:0xf5@0x80] +DEBUG[read(1, 0x80)&mask:0xf5](default: 0xf5 / 245) >> +[read(1, 0x80)->0xf5] +AML> +[\\_PTS. END] +_PTS Method: Arg 1 From 0x2805f0a3 To 0x2805f0db +NO object +==== _PTS finished. ==== +AML>q +% +.Ed +.Sh SEE ALSO +.Xr acpi 4 , +.\" .Xr acpiconf 8 , +.Xr acpidump 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 5.0 . +.Sh AUTHORS +.An Takanori Watanabe Aq Mt takawata@FreeBSD.org +.An Mitsuru IWASAKI Aq Mt iwasaki@FreeBSD.org +.An Yasuo YOKOYAMA Aq Mt yokoyama@jp.FreeBSD.org +.Pp +Some contributions made by +.An Chitoshi Ohsawa Aq Mt ohsawa@catv1.ccn-net.ne.jp , +.An Takayasu IWANASHI Aq Mt takayasu@wendy.a.perfect-liberty.or.jp , +.An Norihiro KUMAGAI Aq Mt kumagai@home.com , +.An Kenneth Ingham Aq Mt ingham@I-pi.com , +and +.An Michael Lucas Aq Mt mwlucas@blackhelicopters.org . +.Sh BUGS +The ACPI virtual machine does not completely simulate the behavior +of a machine with an ACPI BIOS. +In the current implementation, the +ACPI virtual machine only reads or writes the stored values by +emulating access to regions such as SystemMemory. +.Pp +Because the AML interpreter interprets and disassembles +simultaneously, it is impossible to implement such features as setting +breakpoints with the specified line number in ASL. +Setting breakpoints +at certain Control Methods, which is not very difficult, has not +yet implemented because nobody has ever needed it. diff --git a/static/netbsd/man8/amq.8 b/static/netbsd/man8/amq.8 new file mode 100644 index 00000000..21cd8667 --- /dev/null +++ b/static/netbsd/man8/amq.8 @@ -0,0 +1,281 @@ +.\" $NetBSD: amq.8,v 1.4 2015/01/17 17:46:31 christos Exp $ +.\" +.\" +.\" Copyright (c) 1997-2014 Erez Zadok +.\" Copyright (c) 1990 Jan-Simon Pendry +.\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine +.\" Copyright (c) 1990 The Regents of the University of California. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to Berkeley by +.\" Jan-Simon Pendry at Imperial College, London. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" +.\" File: am-utils/amq/amq.8 +.\" +.TH AMQ 8 "15 September 2011" +.SH NAME +amq \- automounter query tool +.SH SYNOPSIS +.B amq +[ +.BI \-fimpqsvwHTU +] [ +.BI \-h " hostname" +] [ +.BI \-l " log_file" +] [ +.BI \-x " log_options" +] [ +.BI \-D " debug_options" +] [ +.BI \-P " program_number" +] [[ +.B \-u +] +.I directory .\|.\|. +] +.SH DESCRIPTION +.B Amq +provides a simple way of determining the current state of +.B amd +program. +Communication is by +.SM RPC. +Three modes of operation are supported by the current protocol. By default +a list of mount points and auto-mounted filesystems is output. An +alternative host can be specified using the +.I \-h +option. +.LP +If +.I directory +names are given, as output by default, then per-filesystem +information is displayed. +.SH OPTIONS + +.TP +.B \-f +Ask the automounter to flush the internal caches and reload all the maps. + +.TP +.BI \-h " hostname" +Specify an alternate host to query. By default the local host is used. In +an +.SM HP-UX +cluster, the root server is queried by default, since that is the system on +which the automounter is normally run. + +.TP +.BI \-i +Print information about the mount maps. + +.TP +.BI \-l " log_file" +Tell amd to use +.I log_file +as the log file name. For security reasons, this must be the same log file +which amd used when started. This option is therefore only useful to +refresh amd's open file handle on the log file, so that it can be rotated +and compressed via daily cron jobs. + +.TP +.B \-m +Ask the automounter to provide a list of mounted filesystems, including the +number of references to each filesystem and any error which occurred while +mounting. + +.TP +.B \-p +Return the process ID of the remote or locally running amd. Useful when you +need to send a signal to the local amd process, and would rather not have to +search through the process table. This option is used in the +.I ctl-amd +script. + +.TP +.B \-q +Suppress error messages produced when attempting synchronous unmounts +with the +.B \-u +option. + +.TP +.B \-s +Ask the automounter to provide system-wide mount statistics. + +.TP +.B \-u +Ask the automounter to unmount the filesystems named in +.I directory +instead of providing +information about them. Unmounts are requested, not forced. They merely +cause the mounted filesystem to timeout, which will be picked up by +.BR amd 's +main scheduler thus causing the normal timeout action to be taken. +If the +.B \-u +option is repeated, +.B amq +will attempt to unmount the file system synchronously by waiting until +the timeout action is taken and returning an error if the unmount +fails. +Any error messages produced may be suppressed with the +.B \-q +option. + +.TP +.B \-v +Ask the automounter for its version information. This is a subset of the +information output by +.BR amd 's +.I -v +option. + +.TP +.B \-w +Translate a full pathname as returned by +.IR getcwd (3) +into a short +.B Amd +pathname that goes through its mount points. This option requires that +.B Amd +is running. + +.TP +.BI \-x " log_options" +Ask the automounter to use the logging options specified in +.I log_options +from now on. Note that the "fatal" and "error" options cannot be turned +off. + +.TP +.BI \-D " debug_options" +Ask the automounter to use the debugging options specified in +.I debug_options +from now on. + +.TP +.B \-H +Display short usage message. + +.TP +.BI \-P " program_number" +Contact an alternate running amd that had registered itself on a different +RPC +.I program_number +and apply all other operations to that instance of the automounter. This is +useful when you run multiple copies of amd, and need to manage each +one separately. If not specified, amq will use the default program number +for amd, 300019. For security reasons, the only alternate program numbers +amd can use range from 300019 to 300029, inclusive. + +.TP +.B \-T +Contact +.B amd +using the TCP transport only. Normally +.B amq +will try TCP, and if that failed, will try UDP. + +.TP +.B \-U +Contact +.B amd +using UDP (connectionless) transport only. Normally +.B amq +will try TCP, and if that failed, will try UDP. + +.SH FILES +.TP 20 +.B amq.x +.SM RPC +protocol description. + +.SH CAVEATS +.B Amq +uses a Sun registered +.SM RPC +program number (300019 decimal) which may not +be in the /etc/rpc database. +.PP +If the TCP wrappers library is available, and the +.B use_tcpwrappers +global +.B amd.conf +option is set to ``yes'', then +.B amd +will verify that the host running +.B amq +is authorized to connect. The +.I amd +service name must used in the +.B /etc/hosts.allow +and +.B /etc/hosts.deny +files. For example, to allow only localhost to connect to +.B amd, +add this line to +.B /etc/hosts.allow: +.PP +.RS +amd: localhost +.RE +.PP +and this line to +.B /etc/hosts.deny: +.PP +.RS +amd: ALL +.RE + +.SH "SEE ALSO" +.BR amd (8), +.\" .BR ctl-amd (8), +.BR amd.conf (5), +.BR hosts_access (5). +.LP +``am-utils'' +.BR info (1) +entry. +.LP +.I "Linux NFS and Automounter Administration" +by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001). +.LP +.I http://www.am-utils.org +.LP +.I "Amd \- The 4.4 BSD Automounter" + +.SH AUTHORS +Jan-Simon Pendry , Department of Computing, Imperial College, London, UK. +.P +Erez Zadok , Computer Science Department, Stony Brook +University, Stony Brook, New York, USA. +.P +Other authors and contributors to am-utils are listed in the +.B AUTHORS +file distributed with am-utils. diff --git a/static/netbsd/man8/amrctl.8 b/static/netbsd/man8/amrctl.8 new file mode 100644 index 00000000..59cb9bc4 --- /dev/null +++ b/static/netbsd/man8/amrctl.8 @@ -0,0 +1,98 @@ +.\" $NetBSD: amrctl.8,v 1.4 2016/09/11 00:52:39 sevan Exp $ +.\" +.\" Copyright (c) 2006 Manuel Bouyer. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 11, 2016 +.Dt AMRCTL 8 +.Os +.Sh NAME +.Nm amrctl +.Nd Control utility for AMI MegaRaid controllers +.Sh SYNOPSIS +.Nm +.Ar stat +.Op Fl bgv +.Op Fl a Ar attempts +.Op Fl f Ar device +.Op Fl l Ar volno +.Op Fl p Ar driveno +.Op Fl s Ar busno +.Op Fl s Ar busno:driveno +.Op Fl t Ar microseconds +.Sh DESCRIPTION +The +.Nm +queries or controls AMI MegaRaid controllers supported +by the +.Xr amr 4 +driver. +.Pp +Only the +.Ar stat +subcommand is currently implemented, and reports status of the controller. +The options for the +.Ar stat +subcommand are as follows: +.Bl -tag -offset indent -width XpXperiodXX +.It Fl a Ar attempts +Number of retries for a command before giving up. +Default 5. +.It Fl b +Report battery status. +.It Fl f Ar device +Device to use. +Default to +.Pa /dev/amr0 . +.It Fl g +Report global parameters for the controller. +.It Fl l Ar volno +Report status of a logical drive. +.It Fl p Ar driveno +Report status of a physical drive. +.It Fl s Ar busno +Report status of all physical drives on the specified bus. +.It Fl s Ar busno:driveno +Report status of the specified physical drive on the specified bus. +.It Fl t Ar microseconds +Delay between retries for a command. +.It Fl v +Increase verbosity level by one. +.El +.Sh SEE ALSO +.Xr amr 4 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 4.0 . +.Sh AUTHORS +The +.Nm +command was written by +.An Pierre David +.Aq Pierre.David@crc.u-strasbg.fr +and +.An Jung-uk Kim +.Aq jkim@FreeBSD.org +for +.Fx . diff --git a/static/netbsd/man8/anvil.8 b/static/netbsd/man8/anvil.8 new file mode 100644 index 00000000..172c9c08 --- /dev/null +++ b/static/netbsd/man8/anvil.8 @@ -0,0 +1,304 @@ +.\" $NetBSD: anvil.8,v 1.3 2020/03/18 19:05:14 christos Exp $ +.\" +.TH ANVIL 8 +.ad +.fi +.SH NAME +anvil +\- +Postfix session count and request rate control +.SH "SYNOPSIS" +.na +.nf +\fBanvil\fR [generic Postfix daemon options] +.SH DESCRIPTION +.ad +.fi +The Postfix \fBanvil\fR(8) server maintains statistics about +client connection counts or client request rates. This +information can be used to defend against clients that +hammer a server with either too many simultaneous sessions, +or with too many successive requests within a configurable +time interval. This server is designed to run under control +by the Postfix \fBmaster\fR(8) server. + +In the following text, \fBident\fR specifies a (service, +client) combination. The exact syntax of that information +is application\-dependent; the \fBanvil\fR(8) server does +not care. +.SH "CONNECTION COUNT/RATE CONTROL" +.na +.nf +.ad +.fi +To register a new connection send the following request to +the \fBanvil\fR(8) server: + +.nf + \fBrequest=connect\fR + \fBident=\fIstring\fR +.fi + +The \fBanvil\fR(8) server answers with the number of +simultaneous connections and the number of connections per +unit time for the (service, client) combination specified +with \fBident\fR: + +.nf + \fBstatus=0\fR + \fBcount=\fInumber\fR + \fBrate=\fInumber\fR +.fi + +To register a disconnect event send the following request +to the \fBanvil\fR(8) server: + +.nf + \fBrequest=disconnect\fR + \fBident=\fIstring\fR +.fi + +The \fBanvil\fR(8) server replies with: + +.nf + \fBstatus=0\fR +.fi +.SH "MESSAGE RATE CONTROL" +.na +.nf +.ad +.fi +To register a message delivery request send the following +request to the \fBanvil\fR(8) server: + +.nf + \fBrequest=message\fR + \fBident=\fIstring\fR +.fi + +The \fBanvil\fR(8) server answers with the number of message +delivery requests per unit time for the (service, client) +combination specified with \fBident\fR: + +.nf + \fBstatus=0\fR + \fBrate=\fInumber\fR +.fi +.SH "RECIPIENT RATE CONTROL" +.na +.nf +.ad +.fi +To register a recipient request send the following request +to the \fBanvil\fR(8) server: + +.nf + \fBrequest=recipient\fR + \fBident=\fIstring\fR +.fi + +The \fBanvil\fR(8) server answers with the number of recipient +addresses per unit time for the (service, client) combination +specified with \fBident\fR: + +.nf + \fBstatus=0\fR + \fBrate=\fInumber\fR +.fi +.SH "TLS SESSION NEGOTIATION RATE CONTROL" +.na +.nf +.ad +.fi +The features described in this section are available with +Postfix 2.3 and later. + +To register a request for a new (i.e. not cached) TLS session +send the following request to the \fBanvil\fR(8) server: + +.nf + \fBrequest=newtls\fR + \fBident=\fIstring\fR +.fi + +The \fBanvil\fR(8) server answers with the number of new +TLS session requests per unit time for the (service, client) +combination specified with \fBident\fR: + +.nf + \fBstatus=0\fR + \fBrate=\fInumber\fR +.fi + +To retrieve new TLS session request rate information without +updating the counter information, send: + +.nf + \fBrequest=newtls_report\fR + \fBident=\fIstring\fR +.fi + +The \fBanvil\fR(8) server answers with the number of new +TLS session requests per unit time for the (service, client) +combination specified with \fBident\fR: + +.nf + \fBstatus=0\fR + \fBrate=\fInumber\fR +.fi +.SH "AUTH RATE CONTROL" +.na +.nf +.ad +.fi +To register an AUTH request send the following request +to the \fBanvil\fR(8) server: + +.nf + \fBrequest=auth\fR + \fBident=\fIstring\fR +.fi + +The \fBanvil\fR(8) server answers with the number of auth +requests per unit time for the (service, client) combination +specified with \fBident\fR: + +.nf + \fBstatus=0\fR + \fBrate=\fInumber\fR +.fi +.SH "SECURITY" +.na +.nf +.ad +.fi +The \fBanvil\fR(8) server does not talk to the network or to local +users, and can run chrooted at fixed low privilege. + +The \fBanvil\fR(8) server maintains an in\-memory table with +information about recent clients requests. No persistent +state is kept because standard system library routines are +not sufficiently robust for update\-intensive applications. + +Although the in\-memory state is kept only temporarily, this +may require a lot of memory on systems that handle connections +from many remote clients. To reduce memory usage, reduce +the time unit over which state is kept. +.SH DIAGNOSTICS +.ad +.fi +Problems and transactions are logged to \fBsyslogd\fR(8) +or \fBpostlogd\fR(8). + +Upon exit, and every \fBanvil_status_update_time\fR +seconds, the server logs the maximal count and rate values measured, +together with (service, client) information and the time of day +associated with those events. +In order to avoid unnecessary overhead, no measurements +are done for activity that isn't concurrency limited or +rate limited. +.SH BUGS +.ad +.fi +Systems behind network address translating routers or proxies +appear to have the same client address and can run into connection +count and/or rate limits falsely. + +In this preliminary implementation, a count (or rate) limited server +process can have only one remote client at a time. If a +server process reports +multiple simultaneous clients, state is kept only for the last +reported client. + +The \fBanvil\fR(8) server automatically discards client +request information after it expires. To prevent the +\fBanvil\fR(8) server from discarding client request rate +information too early or too late, a rate limited service +should always register connect/disconnect events even when +it does not explicitly limit them. +.SH "CONFIGURATION PARAMETERS" +.na +.nf +.ad +.fi +On low\-traffic mail systems, changes to \fBmain.cf\fR are +picked up automatically as \fBanvil\fR(8) processes run for +only a limited amount of time. On other mail systems, use +the command "\fBpostfix reload\fR" to speed up a change. + +The text below provides only a parameter summary. See +\fBpostconf\fR(5) for more details including examples. +.IP "\fBanvil_rate_time_unit (60s)\fR" +The time unit over which client connection rates and other rates +are calculated. +.IP "\fBanvil_status_update_time (600s)\fR" +How frequently the \fBanvil\fR(8) connection and rate limiting server +logs peak usage information. +.IP "\fBconfig_directory (see 'postconf -d' output)\fR" +The default location of the Postfix main.cf and master.cf +configuration files. +.IP "\fBdaemon_timeout (18000s)\fR" +How much time a Postfix daemon process may take to handle a +request before it is terminated by a built\-in watchdog timer. +.IP "\fBipc_timeout (3600s)\fR" +The time limit for sending or receiving information over an internal +communication channel. +.IP "\fBmax_idle (100s)\fR" +The maximum amount of time that an idle Postfix daemon process waits +for an incoming connection before terminating voluntarily. +.IP "\fBmax_use (100)\fR" +The maximal number of incoming connections that a Postfix daemon +process will service before terminating voluntarily. +.IP "\fBprocess_id (read\-only)\fR" +The process ID of a Postfix command or daemon process. +.IP "\fBprocess_name (read\-only)\fR" +The process name of a Postfix command or daemon process. +.IP "\fBsyslog_facility (mail)\fR" +The syslog facility of Postfix logging. +.IP "\fBsyslog_name (see 'postconf -d' output)\fR" +A prefix that is prepended to the process name in syslog +records, so that, for example, "smtpd" becomes "prefix/smtpd". +.PP +Available in Postfix 3.3 and later: +.IP "\fBservice_name (read\-only)\fR" +The master.cf service name of a Postfix daemon process. +.SH "SEE ALSO" +.na +.nf +smtpd(8), Postfix SMTP server +postconf(5), configuration parameters +master(5), generic daemon options +.SH "README FILES" +.na +.nf +.ad +.fi +Use "\fBpostconf readme_directory\fR" or +"\fBpostconf html_directory\fR" to locate this information. +.na +.nf +TUNING_README, performance tuning +.SH "LICENSE" +.na +.nf +.ad +.fi +The Secure Mailer license must be distributed with this software. +.SH HISTORY +.ad +.fi +.ad +.fi +The anvil service is available in Postfix 2.2 and later. +.SH "AUTHOR(S)" +.na +.nf +Wietse Venema +IBM T.J. Watson Research +P.O. Box 704 +Yorktown Heights, NY 10598, USA + +Wietse Venema +Google, Inc. +111 8th Avenue +New York, NY 10011, USA diff --git a/static/netbsd/man8/apm.8 b/static/netbsd/man8/apm.8 new file mode 100644 index 00000000..ec1e0d97 --- /dev/null +++ b/static/netbsd/man8/apm.8 @@ -0,0 +1,158 @@ +.\" $NetBSD: apm.8,v 1.22 2026/02/27 02:23:58 gutteridge Exp $ +.\" +.\" Copyright (c) 1996, 2010 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by John Kohl. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd March 20, 2010 +.Dt APM 8 +.Os +.Sh NAME +.Nm apm , +.Nm zzz +.Nd Advanced Power Management control program +.Sh SYNOPSIS +.Nm +.Op Fl abdlmSsvz +.Op Fl f Ar sockname +.Nm zzz +.Op Fl Sz +.Op Fl f Ar sockname +.Sh DESCRIPTION +The +.Nm +program communicates with the Advanced Power Management +.Pq Tn APM +daemon, +.Xr apmd 8 , +making requests of the current power status or placing the system either +into suspend or stand-by state. +The +.Nm +tool is only installed on supported platforms. +.Pp +With no flags, +.Nm +displays the current power management state in verbose form. +.Pp +Available command-line flags are: +.Bl -tag -width "-f sockname" -compact +.It Fl a +Display the external charger (A/C status): 0 means disconnected, 1 +means connected, 2 means backup power source, and 255 means unknown. +.It Fl b +Display the battery status: +0 means high, 1 means low, 2 means critical, 3 means charging, +4 means absent, and 255 means unknown. +.It Fl d +Do not communicate with the APM daemon; attempt instead to manipulate +the APM control device directly. +.It Fl f Ar sockname +Set the name of the socket via which to contact +.Xr apmd 8 +to +.Pa sockname . +.It Fl l +Display the estimated battery lifetime in percent. +.It Fl m +Display the estimated battery lifetime in minutes. +.It Fl S +Put the system into stand-by (light sleep) mode. +.It Fl s +Display if power management is enabled. +.It Fl v +Request more verbose description of the displayed states. +.It Fl z +Put the system into suspend (deep sleep) mode. +.El +.Pp +The +.Nm zzz +variant of this command is an alternative for suspending the system. +With no arguments, +.Nm zzz +places the system into suspend mode. +The command line flags serve the same purpose as for the +.Nm +variant of this command. +.Pp +This command does not wait for positive confirmation that the requested +mode has been entered; to do so would mean the command does not return +until the system resumes from its sleep state. +.Sh FILES +.Pa /var/run/apmdev +is the default UNIX-domain socket used for communication with +.Xr apmd 8 . +The +.Fl f +flag may be used to specify an alternate socket name. +The protection modes on this socket govern which users may access the +APM functions. +.Pp +.Pa /dev/apmctl +is the control device which is used when the +.Fl d +flag is specified; it must be writable for the +.Fl d +flag to work successfully. +.Pa /dev/apm +is the status device used when the socket is not accessible; it must be +readable to provide current APM status. +.Sh SEE ALSO +.Xr acpi 4 , +.Xr apm 4 , +.Xr apmd 8 +.Rs +.%A Intel Corporation +.%A Microsoft Corporation +.%T Advanced Power Management (APM) BIOS Interface Specification +.%N Revision 1.2 +.%D February 1996 +.Re +.Sh HISTORY +The +.Nm +command appeared in +.Nx 1.3 . +.Pp +The +.Tn APM +specification first appeared in 1992. +The last update to the standard was made in 1996 - +the same year when it was superseded by the +.Tn ACPI 1.0 +standard. +Thereafter power management on IBM-compatible personal computers has relied on +.Tn ACPI , +implemented in +.Nx +by the +.Xr acpi 4 +subsystem. +The +.Xr acpi 4 +provides an emulation layer for the legacy +.Nm . diff --git a/static/netbsd/man8/apmd.8 b/static/netbsd/man8/apmd.8 new file mode 100644 index 00000000..a6f9e7f4 --- /dev/null +++ b/static/netbsd/man8/apmd.8 @@ -0,0 +1,224 @@ +.\" $NetBSD: apmd.8,v 1.22 2012/04/08 22:00:40 wiz Exp $ +.\" +.\" Copyright (c) 1996, 2010 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by John Kohl. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd March 20, 2010 +.Dt APMD 8 +.Os +.Sh NAME +.Nm apmd +.Nd Advanced Power Management monitor daemon +.Sh SYNOPSIS +.Nm +.Op Fl adlqsv +.Op Fl f Ar devname +.Op Fl m Ar sockmode +.Op Fl o Ar sockowner:sockgroup +.Op Fl S Ar sockname +.Op Fl t Ar rate +.Sh DESCRIPTION +The +.Nm +daemon monitors the Advanced Power Management +.Pq Tn APM +pseudo-device, acting on +signaled events and upon user requests as sent by the +.Xr apm 8 +utility. +The +.Nm +daemon is only installed on supported platforms. +.Pp +.Em The +.Nm +.Em is largely deprecated. +Modern systems supporting +.Tn ACPI +should rely on +.Xr acpi 4 , +.Xr powerd 8 , +and the +.Xr envsys 4 +framework instead. +.Pp +For suspend and standby request events delivered by the BIOS, or via +.Xr apm 8 , +.Nm +runs the appropriate configuration program (if one exists), +syncs the buffer cache to disk and initiates the requested mode. +When resuming after suspend or standby, +.Nm +runs the appropriate configuration utility (if one exists). +For power status change events, +.Nm +fetches the current status and reports it via +.Xr syslog 3 +with logging facility +.Dv LOG_DAEMON . +.Pp +.Nm +announces the transition to standby mode with a single high tone on the +speaker (using the +.Pa /dev/speaker +device). +Suspends are announced with two high tones. +.Pp +.Nm +periodically polls the +.Tn APM +driver for the current power state. +If the battery charge level changes substantially or the external power +status changes, the new status is logged. +The polling rate defaults to +once per 10 minutes, but this may be altered by using the +.Fl t +command-line flag. +.Pp +.Nm +supports the following options: +.Bl -tag -width Fl +.It Fl a +Any BIOS-initiated suspend or standby requests are +ignored if the system is connected to line current and not running from +batteries (user requests are still honored). +.It Fl d +Enter debug mode, log to facility +.Dv LOG_LOCAL1 +and stay in the foreground on the controlling terminal. +.It Fl f Ar devname +Specify an alternate device file name. +.It Fl l +A low-battery event causes a suspend request to occur. +.It Fl m Ar sockmode +Use +.Ar sockmode +instead of +.Sq 0660 +for the mode of +.Pa /var/run/apmdev . +.It Fl o Ar sockowner:sockgroup +Use +.Ar sockowner:sockgroup +instead of +.Sq `0:0' +for the owner/group of +.Pa /var/run/apmdev . +.It Fl q +Do not announce suspend and standby requests on the speaker. +.It Fl S Ar sockname +Specify an alternate socket name (used by +.Xr apm 8 +to communicate with +.Nm ) . +.It Fl s +The current battery statistics are reported via +.Xr syslog 3 +and exit without monitoring the APM status. +.It Fl t Ar rate +Change the polling rate from 600 seconds to +.Ar rate +seconds. +.It Fl v +Periodically log the power status via +.Xr syslog 3 . +.El +.Pp +When a client requests a suspend or stand-by mode, +.Nm +does not wait for positive confirmation that the requested +mode has been entered before replying to the client; to do so would mean +the client does not get a reply until the system resumes from its sleep state. +Rather, +.Nm +replies with the intended state to the client and then places the system +in the requested mode after running the configuration script and +flushing the buffer cache. +.Pp +Actions can be configured for the five transitions: +.Cm suspend , +.Cm standby , +.Cm resume , +.Cm line +or +.Cm battery . +The suspend and standby actions are run prior to +.Nm +performing any other actions (such as disk syncs) and entering the new +mode. +The resume program is run after resuming from a stand-by or suspended state. +.Pp +The line and battery actions are run after switching power sources to +AC (line) or battery, respectively. +The appropriate line or battery action +is also run upon the startup of apmd based on the current power source. +.Sh FILES +.Bl -tag -width /etc/apm/suspend -compact +.It Pa /etc/apm/suspend +.It Pa /etc/apm/standby +.It Pa /etc/apm/resume +.It Pa /etc/apm/line +.It Pa /etc/apm/battery +Contain the host's customized actions. +Each file must be an executable binary or shell script suitable +for execution by the +.Xr execve 2 +function. +If you wish to have the same program or script control all transitions, it +may determine which transition is in progress by examining its +.Va argv[0] +which is set to one of +.Ar suspend , +.Ar standby , +.Ar resume , +.Ar line +or +.Ar battery . +See +.Pa /usr/share/examples/apm/script +for such an example script. +.Pp +.It Pa /var/run/apmdev +The default UNIX-domain socket used for communication with +.Xr apm 8 . +The socket is protected by default to mode 0660, UID 0, GID 0. +.Pp +.It Pa /dev/apmctl +The default device used to control the APM kernel driver. +.El +.Sh SEE ALSO +.Xr execve 2 , +.Xr syslog 3 , +.Xr apm 4 , +.Xr speaker 4 , +.Xr apm 8 , +.Xr syslogd 8 +.Sh HISTORY +The +.Nm +daemon appeared in +.Nx 1.3 . diff --git a/static/netbsd/man8/apmlabel.8 b/static/netbsd/man8/apmlabel.8 new file mode 100644 index 00000000..b7d06756 --- /dev/null +++ b/static/netbsd/man8/apmlabel.8 @@ -0,0 +1,100 @@ +.\" $NetBSD: apmlabel.8,v 1.3 2007/06/25 00:41:50 rumble Exp $ +.\" +.\" Copyright (C) 1998 Wolfgang Solfrank. +.\" Copyright (C) 1998 TooLs GmbH. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by TooLs GmbH. +.\" 4. The name of TooLs GmbH may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; +.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR +.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd May 19, 2007 +.Dt APMLABEL 8 +.Os +.Sh NAME +.Nm apmlabel +.Nd update disk label from Apple Partition Map +.Sh SYNOPSIS +.Nm +.Op Fl fqrw +.Ar device +.Sh DESCRIPTION +.Nm +is used to update a +.Nx +disk label from the Apple Partition Map found +on disks that were previously used on Mac OS systems (or +other APM using systems). +.Pp +.Nm +scans the APM contained in the first blocks of the disk and generates +additional partition entries for the disk from the entries found. +Driver and patches partitions are ignored. +.Pp +Each APM entry which does not have an equivalent partition in the +disk label (equivalent in having the same size and offset) is added to +the first free partition slot in the disk label. +A free partition slot is defined as one with an +.Dv fstype +of +.Sq Li unused +and a +.Dv size +of zero +.Pq Sq 0 . +If there are not enough free slots in the disk label, a warning +will be issued. +.Pp +The raw partition (typically partition +.Em c , +but +.Em d +on i386 and some other platforms) is left alone during this process. +.Pp +By default, the proposed changed disk label will be displayed and no +disk label update will occur. +.Pp +Available options: +.Pp +.Bl -tag -width sX +.It Fl f +Force an update, even if there has been no change. +.It Fl q +Performs operations in a quiet fashion. +.It Fl r +In conjunction with +.Fl w , +also update the on-disk label. +.It Fl w +Update the in-core label if it has been changed. +.El +.Sh SEE ALSO +.Xr disklabel 8 , +.Xr dkctl 8 , +.Xr pdisk 8 +.Sh HISTORY +The +.Nm +command appeared in +.Nx 5.0 . diff --git a/static/netbsd/man8/arp.8 b/static/netbsd/man8/arp.8 new file mode 100644 index 00000000..864d3c2f --- /dev/null +++ b/static/netbsd/man8/arp.8 @@ -0,0 +1,184 @@ +.\" $NetBSD: arp.8,v 1.27 2021/12/05 07:11:56 msaitoh Exp $ +.\" +.\" Copyright (c) 1985, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)arp.8 8.2 (Berkeley) 4/27/95 +.\" +.Dd December 5, 2021 +.Dt ARP 8 +.Os +.Sh NAME +.Nm arp +.Nd address resolution display and control +.Sh SYNOPSIS +.Nm +.Op Fl n +.Ar hostname +.Nm +.Op Fl nv +.Fl a +.Nm +.Op Fl v +.Fl d +.Fl a +.Nm +.Op Fl v +.Fl d Ar hostname +.Op Cm proxy +.Nm +.Fl s Ar hostname ether_addr +.Op Cm temp +.Op Cm pub Op Cm proxy +.Nm +.Fl f Ar filename +.Sh DESCRIPTION +The +.Nm +program displays and modifies the Internet-to-Ethernet address translation +tables used by the address resolution protocol +.Pq Xr arp 4 . +With no flags, the program displays the current +.Tn ARP +entry for +.Ar hostname . +The host may be specified by name or by number, +using Internet dot notation. +.Pp +The state of the arp entry is shown as a single letter preceded by the +time the state is applicable for: +.Bl -tag -width indent -compact +.It D +Delay +.It I +Incomplete +.It N +Nostate +.It P +Probe +.It R +Reachable +.It S +Stale +.It U +Unreachable +.It W +Waitdelete +.It ? +Unknown state (should never happen). +.El +.Pp +Available options: +.Bl -tag -width Ds +.It Fl a +The program displays all of the current +.Tn ARP +entries. +.It Fl d +A super-user may delete an entry for the host called +.Ar hostname +with the +.Fl d +flag. +If the +.Cm proxy +keyword is specified, only the published +.Dq proxy only +.Tn ARP +entry +for this host will be deleted. +If used with +.Fl a +instead of a +.Ar hostname , +it will delete all arp entries. +.It Fl f +Causes the file +.Ar filename +to be read and multiple entries to be set in the +.Tn ARP +tables. +Entries in the file should be of the form +.Pp +.Bd -filled -offset indent -compact +.Ar hostname ether_addr +.Op Cm temp +.Op Cm pub +.Ed +.Pp +with argument meanings as described below. +.It Fl n +Show network addresses as numbers (normally +.Nm +attempts to display addresses symbolically). +.It Fl s Ar hostname ether_addr +Create an +.Tn ARP +entry for the host called +.Ar hostname +with the Ethernet address +.Ar ether_addr . +The Ethernet address is given as six hex bytes separated by colons. +The entry will be permanent unless the word +.Cm temp +is given in the command. +If the word +.Cm pub +is given, the entry will be "published"; i.e., this system will +act as an +.Tn ARP +server, +responding to requests for +.Ar hostname +even though the host address is not its own. +.Pp +If the word +.Cm proxy +is also given, the published entry will be a +.Dq proxy only +entry. +In this case the +.Ar ether_addr +can be given as +.Cm auto +in which case the interfaces on this host will be examined, +and if one of them is found to occupy the same subnet, its +Ethernet address will be used. +.It Fl v +Display verbose information when adding or deleting +.Tn ARP +entries. +.El +.Sh SEE ALSO +.Xr inet 3 , +.Xr arp 4 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.3 . diff --git a/static/netbsd/man8/atactl.8 b/static/netbsd/man8/atactl.8 new file mode 100644 index 00000000..08c6839a --- /dev/null +++ b/static/netbsd/man8/atactl.8 @@ -0,0 +1,306 @@ +.\" $NetBSD: atactl.8,v 1.32 2022/05/24 06:27:59 andvar Exp $ +.\" +.\" Copyright (c) 1998, 2019 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Ken Hornstein and Matthew R. Green. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd March 2, 2019 +.Dt ATACTL 8 +.Os +.Sh NAME +.Nm atactl +.Nd a program to manipulate ATA (IDE) devices and busses +.Sh SYNOPSIS +.Nm +.Ar device +.Ar command +.Oo +.Ar arg Oo ... +.Oc +.Oc +.Sh DESCRIPTION +.Nm +allows a user or system administrator to issue commands to and otherwise +control devices which reside on standard IDE and ATA controllers, or +the ATA bus itself. +It is used by specifying a device or bus to manipulate, +the command to perform, and any arguments the command may require. +.Pp +You may also control devices which are inside a SCSI enclosure, this +includes many USB disks. +In this case ATA commands are passed through +the SCSI layer using SATL commands. +.Sh DEVICE COMMANDS +The following commands may be used on IDE and ATA devices. +Note that not all devices support all commands. +.Bl -tag -width setidleXX +.It Cm identify +Identify the specified device, displaying the device's vendor, product, +revision strings, and the device's capabilities. +.It Cm idle +Place the specified device into Idle mode. +This mode may consume less power than Active mode. +.It Cm standby +Place the specified device into Standby mode. +This mode will consume less power than Idle mode. +.It Cm sleep +Place the specified device into Sleep mode. +This mode will consume less power than Standby mode, +but requires a device reset to resume operation. +Typically the +.Xr wd 4 +driver performs this reset automatically, +but this should still be used with caution. +.It Cm setidle Ar idle-timer +Places the specified device into Idle mode, +and sets the Idle timer to +.Ar idle-timer +seconds. +A value of 0 will disable the Idle timer. +.It Cm setstandby Ar standby-timer +Places the specified device into Standby mode, +and sets the Standby timer to +.Ar standby-timer +seconds. +A value of 0 will disable the Standby timer. +.It Cm checkpower +Will print out if the device is in Active, Idle, or Standby power +management mode. +.It Cm apm Oo Ar disable | set # Oc +Controls the Advanced Power Management feature of the specified device. +Advanced Power Management is an optional feature used to specify a power +management level to balance between device performance and power consumption. +.Bl -tag -width selftestXlogXX +.It Ar disable +Disable the Advanced Power Management. +.It Ar set # +Enable the Advanced Power Management feature and set its level to the value #, +where # is an integer within the scale 0-253; being 0 the mode with the +lowest power consumption (and thus the worse performance) and 253 the mode +which provides the better performance at a cost of more power consumption. +.Pp +It should be noted that the effect of the value need not be continuous. +For example, a device might provide only two modes: one from 0 to 126 +and other from 127 to 253. +Per the specification, values of 127 and higher do not permit the device +to spin down to save power. +.El +.It Cm smart Oo Ar enable | disable | status Oo vendor Oc | offline # | error-log | selftest-log Oc +Controls SMART feature set of the specified device. +SMART stands for Self-Monitoring, Analysis, and Reporting Technology. +It provides an early warning system by comparing subtle operation +characteristics to those determined in vendor testing +to precede device failures. +.Bl -tag -width selftestXlogXX +.It Ar enable +Enables access to SMART capabilities within the device. +Prior to being enabled, a SMART capable device neither +monitors nor saves SMART attribute values. +The state of SMART, either enabled or disabled, will +be preserved by the device across power cycles. +.It Ar disable +Disables access to SMART capabilities within the device. +Attribute values will be saved, and will no longer be monitored. +.It Ar status Op Ar vendor +Reports whether SMART is supported by the device, and whether SMART is +enabled on the device (can only be determined on ATA6 or better devices). +If SMART is enabled, then a table of attribute information is printed. +Attributes are the specific performance or calibration parameters that +are used in analyzing the status of the device. +The specific set of attributes being used and the identity of +these attributes is vendor specific and proprietary. +.Pp +Attribute values are used to represent the relative reliability of +individual performance or calibration parameters. +The valid range of attribute values is from 1 to 253 decimal. +Lower values indicate that the analysis algorithms being used by the device +are predicting a higher probability of a degrading or faulty condition. +.Pp +Each attribute value has a corresponding threshold limit which is used for +direct comparison to the attribute value to indicate the existence of a +degrading or faulty condition. +The numerical value of the attribute thresholds are determined by the +device manufacturer through design and reliability testing and analysis. +Each attribute threshold represents the lowest limit to which its +corresponding attribute value can equal while still retaining a +positive reliability status. +.Pp +If the crit field is +.Dq yes +then negative reliability of this attribute +predicts imminent data loss. +Otherwise it merely indicates that the intended design life period +of usage or age has been exceeded. +The collect field indicates whether this attribute is updated while the +device is online. +The reliability field indicates whether the attribute +value is within the acceptable threshold. +.Pp +If the +.Ar vendor +argument is supplied, a vendor-specific table will be used for SMART +information if known to +.Nm . +Currently, only +.Dq micron +has a vendor-specific table. +If the vendor is not supplied, it may be guessed from devices' model +or other data available. +.It Ar offline # +Runs the numbered offline self-test on the drive. +.It Ar error-log +Prints the error log. +.It Ar selftest-log +Prints the self-test log. +.El +.It Cm security Oo Ar status | freeze | setpass | unlock | disable | erase Oc +Controls +.Dq security +(password protection) features of modern ATA drives. +The security commands are intended to be issued by low-level +software (firmware / BIOS) only. +Generally, the security status should be +.Dq frozen +before the operating system is started so that misbehaving or malicious +software cannot set or change a password. +Older and buggy BIOSes neglect to do so; in these cases it might make +sense to issue the +.Dq freeze +command early in the boot process. +.Bl -tag -width freezeXX +.It Ar status +displays the drive's security status +.It Ar freeze +freezes the drive's security status +.It Ar setpass Oo user | master Oc +sets the drive's user or master password +.It Ar unlock Oo user | master Oc +unlocks a password-protected drive +.It Ar disable Oo user | master Oc +disables password protection +.It Ar erase Oo user | master Oc +erases the device and clears security state, using enhanced erasure if +the drive supports it; may take a long time to run +.El +.Pp +Note that to erase a drive, it must have a password set and be +unfrozen. +If you can't persuade your firmware to leave the drive unfrozen on +boot, but it is a SATA drive, say +.Pa wd2 +at +.Pa atabus3 , +that you can safely physically disconnect and reconnect, then you may +be able to use SATA hot-plug to work around this: first run +.Bd -literal -offset indent +# drvctl -d wd2 +.Ed +.Pp +Then physically disconnect and reconnect the drive, and run +.Bd -literal -offset indent +# drvctl -r -a ata_hl atabus3 +.Ed +.Pp +After this, check that the security status does not list +.Dq frozen : +.Bd -literal -offset indent +# atactl wd2 security status + supported +# +.Ed +.El +.Sh BUS COMMANDS +The following commands may be used on IDE and ATA busses. +Note that not all devices support all commands. +.Bl -tag -width resetXX +.It Cm reset +Reset the bus. +This will reset all ATA devices present on the bus. +Any ATAPI device with pending commands will also be reset. +.El +.Sh EXAMPLES +To erase +.Pa wd2 +which is currently unfrozen and has no password set: +.Bd -literal -offset indent +# atactl wd2 security status + supported +# atactl wd2 security setpass user +Password: +Confirm password: +# atactl wd2 security status + supported + enabled +# atactl wd2 security erase user +Password: +Erasing may take up to 0h 2m 0s... +# +.Ed +.Sh SEE ALSO +.Xr ioctl 2 , +.Xr wd 4 , +.Xr dkctl 8 , +.Xr drvctl 8 , +.Xr scsictl 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 1.4 . +.Sh AUTHORS +.An -nosplit +The +.Nm +command was written by +.An Ken Hornstein . +It was based heavily on the +.Xr scsictl 8 +command written by +.An Jason R. Thorpe . +.An Matthew R. Green +significantly enhanced the +.Cm smart status +support. +.An Michael van Elst +added support for SATL. +.Sh BUGS +The output from the +.Cm identify +command is rather ugly. +.Pp +Support for master passwords is not implemented. +.Pp +The +.Nx +kernel behaves poorly with drives that have passwords set and are +locked. +.Pp +The +.Cm smart status +command currently guesses the vendor attribute name table to use, +and may be wrong or miss supported devices. +.Pp +SATL bus commands don't work yet. diff --git a/static/netbsd/man8/atrun.8 b/static/netbsd/man8/atrun.8 new file mode 100644 index 00000000..552bd407 --- /dev/null +++ b/static/netbsd/man8/atrun.8 @@ -0,0 +1,69 @@ +.\" $NetBSD: atrun.8,v 1.14 2014/03/18 18:20:38 riastradh Exp $ +.\" $OpenBSD: atrun.8,v 1.4 1998/05/22 22:16:29 deraadt Exp $ +.\" $FreeBSD: atrun.man,v 1.3 1997/02/22 14:20:55 peter Exp $ +.Dd April 12, 1995 +.Dt ATRUN 8 +.Os +.Sh NAME +.Nm atrun +.Nd run jobs queued for later execution +.Sh SYNOPSIS +.Nm +.Op Fl l Ar load_avg +.Op Fl d +.Sh DESCRIPTION +.Nm +runs jobs queued by +.Xr at 1 . +Root's +.Xr crontab 5 +must contain the line: +.Bd -literal +*/10 * * * * /usr/libexec/atrun +.Ed +.Pp +so that +.Nm +gets called every ten minutes. +.Pp +At every invocation, every job in lowercase queues whose starting time +has passed is started. +A maximum of one batch job (denoted by uppercase queues) is started +each time +.Nm +is invoked. +.Sh OPTIONS +.Bl -tag -width indent +.It Fl l Ar load_avg +Specifies a limiting load factor, over which batch jobs should +not be run, instead of the compiled-in value of 1.5. +.It Fl d +Debug; print error messages to standard error instead of using +.Xr syslog 3 . +.El +.Sh WARNINGS +For +.Nm +to work, a +.Xr cron 8 +daemon needs to be running. +.Sh FILES +.Bl -tag -width /var/at/spool -compact +.It Pa /var/at/spool +Directory containing output spool files +.It Pa /var/at/jobs +Directory containing job files +.El +.Sh SEE ALSO +.Xr at 1 , +.Xr crontab 1 , +.Xr syslog 3 , +.Xr crontab 5 , +.Xr cron 8 +.Sh AUTHORS +.An Thomas Koenig Aq Mt ig25@rz.uni-karlsruhe.de +.Sh BUGS +The functionality of +.Nm +should be merged into +.Xr cron 8 . diff --git a/static/netbsd/man8/audit-packages.8 b/static/netbsd/man8/audit-packages.8 new file mode 100644 index 00000000..f2266102 --- /dev/null +++ b/static/netbsd/man8/audit-packages.8 @@ -0,0 +1,66 @@ +.\" $NetBSD: audit-packages.8,v 1.3 2021/04/10 19:49:59 nia Exp $ +.\" +.\" Copyright (c) 2010 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Thomas Klausner. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd March 18, 2010 +.Dt AUDIT-PACKAGES 8 +.Os +.Sh NAME +.Nm audit-packages +.Nd report vulnerabilities for the installed packages +.Sh SYNOPSIS +.Nm +.Op Fl deqsVv +.Op Fl c Ar config_file +.Op Fl F Ar file +.Op Fl g Ar file +.Op Fl h Ar file +.Op Fl K Ar pkg_dbdir +.Op Fl n Ar package +.Op Fl p Ar package +.Op Fl Q Ar varname +.Op Fl t Ar type +.Sh DESCRIPTION +.Nm +is deprecated. +Please use the +.Cm audit , +.Cm audit-pkg , +.Cm audit-batch , +and +.Cm fetch-pkg-vulnerabilities +commands of +.Xr pkg_admin 1 +instead. +.Pp +The +.Nm +script is installed for backwards compatibility only and will +eventually be removed. +.Sh SEE ALSO +.Xr pkg_admin 1 diff --git a/static/netbsd/man8/authpf.8 b/static/netbsd/man8/authpf.8 new file mode 100644 index 00000000..a52d5a6c --- /dev/null +++ b/static/netbsd/man8/authpf.8 @@ -0,0 +1,526 @@ +.\" $NetBSD: authpf.8,v 1.10 2009/09/10 13:17:39 wiz Exp $ +.\" $OpenBSD: authpf.8,v 1.44 2007/05/31 19:20:22 jmc Exp $ +.\" +.\" Copyright (c) 1998-2007 Bob Beck (beck@openbsd.org>. All rights reserved. +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd May 31, 2007 +.Dt AUTHPF 8 +.Os +.Sh NAME +.Nm authpf +.Nd authenticating gateway user shell +.Sh SYNOPSIS +.Nm authpf +.Sh DESCRIPTION +.Nm +is a user shell for authenticating gateways. +It is used to change +.Xr pf 4 +rules when a user authenticates and starts a session with +.Xr sshd 8 +and to undo these changes when the user's session exits. +It is designed for changing filter and translation rules for an individual +source IP address as long as a user maintains an active +.Xr ssh 1 +session. +Typical use would be for a gateway that authenticates users before +allowing them Internet use, or a gateway that allows different users into +different places. +.Nm +logs the successful start and end of a session to +.Xr syslogd 8 . +This, combined with properly set up filter rules and secure switches, +can be used to ensure users are held accountable for their network traffic. +.Pp +.Nm +can add filter and translation rules using the syntax described in +.Xr pf.conf 5 . +.Nm +requires that the +.Xr pf 4 +system be enabled before use. +.Nm +can also maintain the list of IP address of connected users +in the "authpf_users" +.Pa table . +.Pp +.Nm +is meant to be used with users who can connect via +.Xr ssh 1 +only. +On startup, +.Nm +retrieves the client's connecting IP address via the +.Ev SSH_CLIENT +environment variable and, after performing additional access checks, +reads a template file to determine what filter and translation rules +(if any) to add. +On session exit the same rules that were added at startup are removed. +.Pp +Each +.Nm +process stores its rules in a separate ruleset inside a +.Xr pf 4 +.Pa anchor +shared by all +.Nm +processes. +By default, the +.Pa anchor +name "authpf" is used, and the ruleset names equal the username and PID of the +.Nm +processes as "username(pid)". +The following rules need to be added to the main ruleset +.Pa /etc/pf.conf +in order to cause evaluation of any +.Nm +rules: +.Bd -literal -offset indent +nat-anchor "authpf/*" +rdr-anchor "authpf/*" +binat-anchor "authpf/*" +anchor "authpf/*" +.Ed +.Pp +The "/*" at the end of the anchor name is required for +.Xr pf 4 +to process the rulesets attached to the anchor by +.Nm authpf . +.Sh FILTER AND TRANSLATION RULES +Filter and translation rules for +.Nm +use the same format described in +.Xr pf.conf 5 . +The only difference is that these rules may (and probably should) use +the macro +.Em user_ip , +which is assigned the connecting IP address whenever +.Nm +is run. +Additionally, the macro +.Em user_id +is assigned the user name. +.Pp +Filter and translation rules are stored in a file called +.Pa authpf.rules . +This file will first be searched for in +.Pa /etc/authpf/users/$USER/ +and then in +.Pa /etc/authpf/ . +Only one of these files will be used if both are present. +.Pp +Per-user rules from the +.Pa /etc/authpf/users/$USER/ +directory are intended to be used when non-default rules +are needed on an individual user basis. +It is important to ensure that a user can not write or change +these configuration files. +.Pp +The +.Pa authpf.rules +file must exist in one of the above locations for +.Nm +to run. +.Sh CONFIGURATION +Options are controlled by the +.Pa /etc/authpf/authpf.conf +file. +If the file is empty, defaults are used for all +configuration options. +The file consists of pairs of the form +.Li name=value , +one per line. +Currently, the allowed values are as follows: +.Bl -tag -width Ds +.It anchor=name +Use the specified +.Pa anchor +name instead of "authpf". +.It table=name +Use the specified +.Pa table +name instead of "authpf_users". +.El +.Sh USER MESSAGES +On successful invocation, +.Nm +displays a message telling the user he or she has been authenticated. +It will additionally display the contents of the file +.Pa /etc/authpf/authpf.message +if the file exists and is readable. +.Pp +There exist two methods for providing additional granularity to the control +offered by +.Nm +- it is possible to set the gateway to explicitly allow users who have +authenticated to +.Xr ssh 1 +and deny access to only a few troublesome individuals. +This is done by creating a file with the banned user's login name as the +filename in +.Pa /etc/authpf/banned/ . +The contents of this file will be displayed to a banned user, thus providing +a method for informing the user that they have been banned, and where they can +go and how to get there if they want to have their service restored. +This is the default behaviour. +.Pp +It is also possible to configure +.Nm +to only allow specific users access. +This is done by listing their login names, one per line, in +.Pa /etc/authpf/authpf.allow . +If "*" is found on a line, then all usernames match. +If +.Nm +is unable to verify the user's permission to use the gateway, it will +print a brief message and die. +It should be noted that a ban takes precedence over an allow. +.Pp +On failure, messages will be logged to +.Xr syslogd 8 +for the system administrator. +The user does not see these, but will be told the system is unavailable due to +technical difficulties. +The contents of the file +.Pa /etc/authpf/authpf.problem +will also be displayed if the file exists and is readable. +.Sh CONFIGURATION ISSUES +.Nm +maintains the changed filter rules as long as the user maintains an +active session. +It is important to remember however, that the existence +of this session means the user is authenticated. +Because of this, it is important to configure +.Xr sshd 8 +to ensure the security of the session, and to ensure that the network +through which users connect is secure. +.Xr sshd 8 +should be configured to use the +.Ar ClientAliveInterval +and +.Ar ClientAliveCountMax +parameters to ensure that a ssh session is terminated quickly if +it becomes unresponsive, or if arp or address spoofing is used to +hijack the session. +Note that TCP keepalives are not sufficient for +this, since they are not secure. +Also note that the various SSH tunnelling mechanisms, +such as +.Ar AllowTcpForwarding +and +.Ar PermitTunnel , +should be disabled for +.Nm +users to prevent them from circumventing restrictions imposed by the +packet filter ruleset. +.Pp +.Nm +will remove state table entries that were created during a user's +session. +This ensures that there will be no unauthenticated traffic +allowed to pass after the controlling +.Xr ssh 1 +session has been closed. +.Pp +.Nm +is designed for gateway machines which typically do not have regular +(non-administrative) users using the machine. +An administrator must remember that +.Nm +can be used to modify the filter rules through the environment in +which it is run, and as such could be used to modify the filter rules +(based on the contents of the configuration files) by regular +users. +In the case where a machine has regular users using it, as well +as users with +.Nm +as their shell, the regular users should be prevented from running +.Nm +by using the +.Pa /etc/authpf/authpf.allow +or +.Pa /etc/authpf/banned/ +facilities. +.Pp +.Nm +modifies the packet filter and address translation rules, and because +of this it needs to be configured carefully. +.Nm +will not run and will exit silently if the +.Pa /etc/authpf/authpf.conf +file does not exist. +After considering the effect +.Nm +may have on the main packet filter rules, the system administrator may +enable +.Nm +by creating an appropriate +.Pa /etc/authpf/authpf.conf +file. +.Sh FILES +.Bl -tag -width "/etc/authpf/authpf.conf" -compact +.It Pa /etc/authpf/authpf.conf +.It Pa /etc/authpf/authpf.allow +.It Pa /etc/authpf/authpf.rules +.It Pa /etc/authpf/authpf.message +.It Pa /etc/authpf/authpf.problem +.El +.Sh EXAMPLES +.Sy Control Files +\- To illustrate the user-specific access control +mechanisms, let us consider a typical user named bob. +Normally, as long as bob can authenticate himself, the +.Nm +program will load the appropriate rules. +Enter the +.Pa /etc/authpf/banned/ +directory. +If bob has somehow fallen from grace in the eyes of the +powers-that-be, they can prohibit him from using the gateway by creating +the file +.Pa /etc/authpf/banned/bob +containing a message about why he has been banned from using the network. +Once bob has done suitable penance, his access may be restored by moving or +removing the file +.Pa /etc/authpf/banned/bob . +.Pp +Now consider a workgroup containing alice, bob, carol and dave. +They have a +wireless network which they would like to protect from unauthorized use. +To accomplish this, they create the file +.Pa /etc/authpf/authpf.allow +which lists their login ids, one per line. +At this point, even if eve could authenticate to +.Xr sshd 8 , +she would not be allowed to use the gateway. +Adding and removing users from +the work group is a simple matter of maintaining a list of allowed userids. +If bob once again manages to annoy the powers-that-be, they can ban him from +using the gateway by creating the familiar +.Pa /etc/authpf/banned/bob +file. +Though bob is listed in the allow file, he is prevented from using +this gateway due to the existence of a ban file. +.Pp +.Sy Distributed Authentication +\- It is often desirable to interface with a +distributed password system rather than forcing the sysadmins to keep a large +number of local password files in sync. +The +.Xr login.conf 5 +mechanism in +.Ox +can be used to fork the right shell. +To make that happen, +.Xr login.conf 5 +should have entries that look something like this: +.Bd -literal -offset indent +shell-default:shell=/bin/csh + +default:\e + ... + :shell=/usr/sbin/authpf + +daemon:\e + ... + :shell=/bin/csh:\e + :tc=default: + +staff:\e + ... + :shell=/bin/csh:\e + :tc=default: +.Ed +.Pp +Using a default password file, all users will get +.Nm +as their shell except for root who will get +.Pa /bin/csh . +.Pp +.Sy SSH Configuration +\- As stated earlier, +.Xr sshd 8 +must be properly configured to detect and defeat network attacks. +To that end, the following options should be added to +.Xr sshd_config 5 : +.Bd -literal -offset indent +Protocol 2 +ClientAliveInterval 15 +ClientAliveCountMax 3 +.Ed +.Pp +This ensures that unresponsive or spoofed sessions are terminated within a +minute, since a hijacker should not be able to spoof ssh keepalive messages. +.Pp +.Sy Banners +\- Once authenticated, the user is shown the contents of +.Pa /etc/authpf/authpf.message . +This message may be a screen-full of the appropriate use policy, the contents +of +.Pa /etc/motd +or something as simple as the following: +.Bd -literal -offset indent +This means you will be held accountable by the powers that be +for traffic originating from your machine, so please play nice. +.Ed +.Pp +To tell the user where to go when the system is broken, +.Pa /etc/authpf/authpf.problem +could contain something like this: +.Bd -literal -offset indent +Sorry, there appears to be some system problem. To report this +problem so we can fix it, please phone 1-900-314-1597 or send +an email to remove@bulkmailerz.net. +.Ed +.Pp +.Sy Packet Filter Rules +\- In areas where this gateway is used to protect a +wireless network (a hub with several hundred ports), the default rule set as +well as the per-user rules should probably allow very few things beyond +encrypted protocols like +.Xr ssh 1 +or +.Xr ipsec 4 . +On a securely switched network, with plug-in jacks for visitors who are +given authentication accounts, you might want to allow out everything. +In this context, a secure switch is one that tries to prevent address table +overflow attacks. +.Pp +Example +.Pa /etc/pf.conf : +.Bd -literal +# by default we allow internal clients to talk to us using +# ssh and use us as a dns server. +internal_if="fxp1" +gateway_addr="10.0.1.1" +nat-anchor "authpf/*" +rdr-anchor "authpf/*" +binat-anchor "authpf/*" +block in on $internal_if from any to any +pass in quick on $internal_if proto tcp from any to $gateway_addr \e + port = ssh +pass in quick on $internal_if proto udp from any to $gateway_addr \e + port = domain +anchor "authpf/*" +.Ed +.Pp +.Sy For a switched, wired net +\- This example +.Pa /etc/authpf/authpf.rules +makes no real restrictions; it turns the IP address on and off, logging +TCP connections. +.Bd -literal +external_if = "xl0" +internal_if = "fxp0" + +pass in log quick on $internal_if proto tcp from $user_ip to any +pass in quick on $internal_if from $user_ip to any +.Ed +.Pp +.Sy For a wireless or shared net +\- This example +.Pa /etc/authpf/authpf.rules +could be used for an insecure network (such as a public wireless network) where +we might need to be a bit more restrictive. +.Bd -literal +internal_if="fxp1" +ipsec_gw="10.2.3.4" + +# rdr ftp for proxying by ftp-proxy(8) +rdr on $internal_if proto tcp from $user_ip to any port 21 \e + -\*[Gt] 127.0.0.1 port 8021 + +# allow out ftp, ssh, www and https only, and allow user to negotiate +# ipsec with the ipsec server. +pass in log quick on $internal_if proto tcp from $user_ip to any \e + port { 21, 22, 80, 443 } +pass in quick on $internal_if proto tcp from $user_ip to any \e + port { 21, 22, 80, 443 } +pass in quick proto udp from $user_ip to $ipsec_gw port = isakmp +pass in quick proto esp from $user_ip to $ipsec_gw +.Ed +.Pp +.Sy Dealing with NAT +\- The following +.Pa /etc/authpf/authpf.rules +shows how to deal with NAT, using tags: +.Bd -literal +ext_if = "fxp1" +ext_addr = 129.128.11.10 +int_if = "fxp0" +# nat and tag connections... +nat on $ext_if from $user_ip to any tag $user_ip -\*[Gt] $ext_addr +pass in quick on $int_if from $user_ip to any +pass out log quick on $ext_if tagged $user_ip +.Ed +.Pp +With the above rules added by +.Nm , +outbound connections corresponding to each users NAT'ed connections +will be logged as in the example below, where the user may be identified +from the ruleset name. +.Bd -literal +# tcpdump -n -e -ttt -i pflog0 +Oct 31 19:42:30.296553 rule 0.bbeck(20267).1/0(match): pass out on fxp1: \e +129.128.11.10.60539 > 198.137.240.92.22: S 2131494121:2131494121(0) win \e +16384 (DF) +.Ed +.Pp +.Sy Using the authpf_users table +\- Simple +.Nm +settings can be implemented without an anchor by just using the "authpf_users" +.Pa table . +For example, the following +.Xr pf.conf 5 +lines will give SMTP and IMAP access to logged in users: +.Bd -literal +table persist +pass in on $ext_if proto tcp from \e + to port { smtp imap } +.Ed +.Pp +It is also possible to use the "authpf_users" +.Pa table +in combination with anchors. +For example, +.Xr pf 4 +processing can be sped up by looking up the anchor +only for packets coming from logged in users: +.Bd -literal +table persist +anchor "authpf/*" from +rdr-anchor "authpf/*" from +.Ed +.Sh SEE ALSO +.Xr pf 4 , +.Xr pf.conf 5 , +.Xr ftp-proxy 8 +.Sh HISTORY +The +.Nm +program first appeared in +.Ox 3.1 . +.Sh BUGS +Configuration issues are tricky. +The authenticating +.Xr ssh 1 +connection may be secured, but if the network is not secured the user may +expose insecure protocols to attackers on the same network, or enable other +attackers on the network to pretend to be the user by spoofing their IP +address. +.Pp +.Nm +is not designed to prevent users from denying service to other users. diff --git a/static/netbsd/man8/automount.8 b/static/netbsd/man8/automount.8 new file mode 100644 index 00000000..58389145 --- /dev/null +++ b/static/netbsd/man8/automount.8 @@ -0,0 +1,134 @@ +.\" $NetBSD: automount.8,v 1.6 2019/11/21 15:24:17 tkusumi Exp $ +.\" Copyright (c) 2017 The NetBSD Foundation, Inc. +.\" Copyright (c) 2016 The DragonFly Project +.\" Copyright (c) 2014 The FreeBSD Foundation +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Tomohiro Kusumi. +.\" +.\" This software was developed by Edward Tomasz Napierala under sponsorship +.\" from the FreeBSD Foundation. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd November 25, 2017 +.Dt AUTOMOUNT 8 +.Os +.Sh NAME +.Nm automount +.Nd update autofs mounts +.Sh SYNOPSIS +.Nm +.Op Fl cfLuv +.Op Fl D Ar name=value +.Op Fl o Ar options +.Sh DESCRIPTION +When called without options, the +.Nm +command parses the +.Xr auto_master 5 +configuration file and any direct maps that it references, and mounts +or unmounts +.Xr autofs 5 +file systems to match. +These options are available: +.Bl -tag -width ".Fl v" +.It Fl c +Flush caches, discarding possibly stale information obtained from maps +and directory services. +.It Fl D +Define a variable. +It is only useful with +.Fl L . +.It Fl f +Force unmount, to be used with +.Fl u . +.It Fl L +Do not mount or unmount anything. +Instead parse +.Xr auto_master 5 +and any direct maps, then print them to standard output. +When specified more than once, all the maps, including indirect ones, +will be parsed and shown. +This is useful when debugging configuration problems. +.It Fl o +Specify mount options to be used along with the ones specified in the maps. +It is only useful with +.Fl L . +.It Fl u +Try to unmount file systems mounted by +.Xr automountd 8 . +.Xr autofs 5 +mounts are not unmounted. +To unmount all +.Xr autofs 5 +mounts, use +.Cm "umount -At autofs". +.It Fl v +Increase verbosity. +.El +.Sh EXIT STATUS +.Ex -std +.Sh EXAMPLES +Unmount all file systems mounted by +.Xr automountd 8 : +.Pp +.Dl Nm Fl u +.Sh SEE ALSO +.Xr auto_master 5 , +.Xr autofs 5 , +.Xr automountd 8 , +.Xr autounmountd 8 +.Sh HISTORY +The +.Nm +command appeared in +.Fx 10.1 . +The +.Nm +command appeared in +.Dx 4.5 . +The +.Nm +command appeared in +.Nx 9.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +was developed by +.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org +under sponsorship from the +.Fx +Foundation. +.Pp +The +.Nm +was ported to +.Dx +and +.Nx +by +.An Tomohiro Kusumi Aq Mt tkusumi@netbsd.org . diff --git a/static/netbsd/man8/automount2amd.8 b/static/netbsd/man8/automount2amd.8 new file mode 100644 index 00000000..9d903555 --- /dev/null +++ b/static/netbsd/man8/automount2amd.8 @@ -0,0 +1,118 @@ +.\" $NetBSD: automount2amd.8,v 1.1.1.3 2015/01/17 16:34:18 christos Exp $ +.\" +.\" +.\" Copyright (c) 1997-2014 Erez Zadok +.\" Copyright (c) 1990 Jan-Simon Pendry +.\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine +.\" Copyright (c) 1990 The Regents of the University of California. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to Berkeley by +.\" Jan-Simon Pendry at Imperial College, London. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" +.\" File: am-utils/scripts/automount2amd.8 +.\" +.TH AUTOMOUNT2AMD 8L "24 May 1993" +.SH NAME +automount2amd \- converts old Sun automount maps to Amd maps +.SH SYNOPSIS +.B automount2amd +.I auto.map +.SH DESCRIPTION +.LP +.B automount2amd +is used to convert an old Sun automount maps named +.I auto.map +to an Amd map. + +This perl script will use the following /default entry +.nf + type:=nfs;opts:=rw,grpid,nosuid,utimeout=600 +.fi +If you wish to override that, define the +.B $DEFAULTS +environment variable, or modify the script. + +If you wish to generate Amd maps using the +.I hostd +(host domain) Amd map syntax, then define the environment variable +.B $DOMAIN +or modify the script. + +.SH EXAMPLE +Say you have the Sun automount file auto.foo, with these two lines: +.nf + home earth:/home + moon -ro,intr server:/proj/images +.fi +Running +.nf + automount2amd auto.foo > amd.foo +.fi +will produce the Amd map +.I amd.foo +with this content: +.nf +# generated by automount2amd on Sat Aug 14 17:59:32 US/Eastern 1999 + +/defaults \\ + type:=nfs;opts:=rw,grpid,nosuid,utimeout=600 + +home \ + host==earth;type:=link;fs:=/home \\ + rhost:=earth;rfs:=/home + +moon \ + -addopts:=ro,intr \\ + host==server;type:=link;fs:=/proj/images \\ + rhost:=server;rfs:=/proj/images +.fi +.SH BUGS +.I automount2amd +does not understand newer Sun Automount map syntax, those used by autofs. +.SH "SEE ALSO" +.BR conv2amd (8), amd (8). +.LP +``am-utils'' +.BR info (1) +entry. +.LP +.I "Linux NFS and Automounter Administration" +by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001). +.LP +.I http://www.am-utils.org +.LP +.I "Amd \- The 4.4 BSD Automounter" +.SH AUTHORS +Original author Mike Walker . +Script modified by Erez Zadok , Computer Science +Department, Stony Brook University, Stony Brook, New York, USA. +.P +Other authors and contributors to am-utils are listed in the +.B AUTHORS +file distributed with am-utils. diff --git a/static/netbsd/man8/automountd.8 b/static/netbsd/man8/automountd.8 new file mode 100644 index 00000000..086b66c0 --- /dev/null +++ b/static/netbsd/man8/automountd.8 @@ -0,0 +1,130 @@ +.\" $NetBSD: automountd.8,v 1.5 2019/11/25 16:57:09 tkusumi Exp $ +.\" +.\" Copyright (c) 2017 The NetBSD Foundation, Inc. +.\" Copyright (c) 2016 The DragonFly Project +.\" Copyright (c) 2014 The FreeBSD Foundation +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Tomohiro Kusumi. +.\" +.\" This software was developed by Edward Tomasz Napierala under sponsorship +.\" from the FreeBSD Foundation. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd November 26, 2019 +.Dt AUTOMOUNTD 8 +.Os +.Sh NAME +.Nm automountd +.Nd daemon handling autofs mount requests +.Sh SYNOPSIS +.Nm +.Op Fl div +.Op Fl D Ar name=value +.Op Fl m Ar maxproc +.Op Fl o Ar options +.Sh DESCRIPTION +The +.Nm +daemon is responsible for handling +.Xr autofs 5 +mount requests, parsing maps, +and mounting file systems they specify. +On startup, +.Nm +forks into background and waits for kernel requests. +When a request is received, +.Nm +forks a child process. +The child process parses the appropriate map and mounts file systems accordingly. +Then it signals the kernel to release blocked processes that were waiting +for the mount. +.Bl -tag -width ".Fl v" +.It Fl D +Define a variable. +.It Fl d +Debug mode: increase verbosity and do not daemonize. +.It Fl i +For indirect mounts, only create subdirectories if there are no wildcard +entries. +Without +.Fl i , +.Nm +creates all the subdirectories it can. +Users may not realize that the wildcard map entry makes it possible to access +directories that have not yet been created. +.It Fl m Ar maxproc +Limit the number of forked +.Nm +processes, and thus the number of mount requests being handled in parallel. +The default is 30. +.It Fl o Ar options +Specify mount options. +Options specified here will be overridden by options entered in maps or +.Xr auto_master 5 . +.It Fl T +Increase verbosity. +For compatibility with other implementations, such as OS X. +.It Fl v +Increase verbosity. +.El +.Sh EXIT STATUS +.Ex -std +.Sh SEE ALSO +.Xr auto_master 5 , +.Xr autofs 5 , +.Xr automount 8 , +.Xr autounmountd 8 +.Sh HISTORY +The +.Nm +daemon appeared in +.Fx 10.1 . +The +.Nm +daemon appeared in +.Dx 4.5 . +The +.Nm +command appeared in +.Nx 9.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +was developed by +.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org +under sponsorship from the +.Fx +Foundation. +.Pp +.Nm +was ported to +.Dx +and +.Nx +by +.An Tomohiro Kusumi Aq Mt tkusumi@netbsd.org . diff --git a/static/netbsd/man8/autounmountd.8 b/static/netbsd/man8/autounmountd.8 new file mode 100644 index 00000000..3853153b --- /dev/null +++ b/static/netbsd/man8/autounmountd.8 @@ -0,0 +1,113 @@ +.\" $NetBSD: autounmountd.8,v 1.4 2019/11/21 15:24:17 tkusumi Exp $ +.\" +.\" Copyright (c) 2017 The NetBSD Foundation, Inc. +.\" Copyright (c) 2016 The DragonFly Project +.\" Copyright (c) 2014 The FreeBSD Foundation +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Tomohiro Kusumi. +.\" +.\" This software was developed by Edward Tomasz Napierala under sponsorship +.\" from the FreeBSD Foundation. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd November 25, 2017 +.Dt AUTOUNMOUNTD 8 +.Os +.Sh NAME +.Nm autounmountd +.Nd daemon unmounting automounted file systems +.Sh SYNOPSIS +.Nm +.Op Fl r Ar time +.Op Fl t Ar time +.Op Fl dv +.Sh DESCRIPTION +The +.Nm +daemon is responsible for unmounting file systems mounted by +.Xr automountd 8 . +On startup, +.Nm +retrieves a list of file systems that have the +.Li automounted +mount option set. +The list is updated every time a file system is mounted or unmounted. +After a specified time passes, +.Nm +attempts to unmount a file system, retrying after some time if necessary. +.Pp +These options are available: +.Bl -tag -width ".Fl v" +.It Fl d +Debug mode: increase verbosity and do not daemonize. +.It Fl r +Number of seconds to wait before trying to unmount an expired file system +after a previous attempt failed, possibly due to file system being busy. +The default value is 600, or ten minutes. +.It Fl t +Number of seconds to wait before trying to unmount a file system. +The default value is 600, or ten minutes. +.It Fl v +Increase verbosity. +.El +.Sh EXIT STATUS +.Ex -std +.Sh SEE ALSO +.Xr auto_master 5 , +.Xr autofs 5 , +.Xr automount 8 , +.Xr automountd 8 +.Sh HISTORY +The +.Nm +daemon appeared in +.Fx 10.1 . +The +.Nm +daemon appeared in +.Dx 4.5 . +The +.Nm +command appeared in +.Nx 9.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +was developed by +.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org +under sponsorship from the +.Fx +Foundation. +.Pp +.Nm +was ported to +.Dx +and +.Nx +by +.An Tomohiro Kusumi Aq Mt tkusumi@netbsd.org . diff --git a/static/netbsd/man8/bad144.8 b/static/netbsd/man8/bad144.8 new file mode 100644 index 00000000..b5308787 --- /dev/null +++ b/static/netbsd/man8/bad144.8 @@ -0,0 +1,186 @@ +.\" Copyright (c) 1980, 1988, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)bad144.8 8.1 (Berkeley) 6/6/93 +.\" $NetBSD: bad144.8,v 1.17 2017/07/03 21:35:29 wiz Exp $ +.\" +.Dd June 6, 1993 +.Dt BAD144 8 +.Os +.Sh NAME +.Nm bad144 +.Nd read/write DEC standard 144 bad sector information +.Sh SYNOPSIS +.Nm +.Op Fl c +.Op Fl f +.Op Fl v +.Ar disk +.Oo +.Ar sno +.Op Ar bad ... +.Oc +.Nm +.Fl a +.Op Fl c +.Op Fl f +.Op Fl v +.Ar disk +.Op Ar bad ... +.Sh DESCRIPTION +.Nm +can be used to inspect the information stored on a disk that is used by +the disk drivers to implement bad sector forwarding. +The +.Nm +tool is only installed on supported platforms. +.Pp +Available options: +.Pp +.Bl -tag -width Ds +.It Fl a +The argument list consists of new bad sectors to be added to an existing +list. +The new sectors are sorted into the list, +which must have been in order. +Replacement sectors are moved to accommodate the additions; +the new replacement sectors are cleared. +.It Fl c +Forces an attempt to copy the old sector to the replacement, +and may be useful when replacing an unreliable sector. +.It Fl f +.Pq vax only +For a RP06, RM03, RM05, Fujitsu Eagle, +or +.Tn SMD +disk on a MASSBUS, the +.Fl f +option may be used to mark the new bad sectors as ``bad'' +by reformatting them as unusable sectors. +This option is +.Em required unless +the sectors have already been marked bad, +or the system will not be notified that it should use the replacement sector. +This option may be used while running multiuser; it is no longer necessary +to perform format operations while running single-user. +.It Fl v +The entire process is described as it happens in gory detail if +.Fl v +(verbose) is given. +.El +.Pp +The format of +the information is specified by +.Tn DEC +standard 144, as follows. +The bad sector information is located in the first 5 even numbered sectors +of the last track of the disk pack. There are five identical copies of +the information, described by the +.Ar dkbad +structure. +.Pp +Replacement sectors are allocated starting with the first sector before +the bad sector information and working backwards towards the beginning +of the disk. A maximum of 126 bad sectors are supported. The position +of the bad sector in the bad sector table determines the replacement +sector to which it corresponds. +The bad sectors must be listed in ascending order. +.Pp +The bad sector information and replacement sectors are conventionally +only accessible through the ``c'' file system partition of the disk. If +that partition is used for a file system, the user is responsible for +making sure that it does not overlap the bad sector information or any +replacement sectors. +Thus, one track plus 126 sectors must be reserved to allow use +of all of the possible bad sector replacements. +.Pp +The bad sector structure is as follows: +.Bd -literal +struct dkbad { + int32_t bt_csn; /* cartridge serial number */ + u_int16_t bt_mbz; /* unused; should be 0 */ + u_int16_t bt_flag; /* -1 => alignment cartridge */ + struct bt_bad { + u_int16_t bt_cyl; /* cylinder number of bad sector */ + u_int16_t bt_trksec; /* track and sector number */ + } bt_bad[126]; +}; +.Ed +.Pp +Unused slots in the +.Ar bt_bad +array are filled with all bits set, a putatively +illegal value. +.Pp +.Nm +is invoked by giving a device name (e.g. wd0, hk0, hp1, etc.). +With no optional arguments +it reads the first sector of the last track +of the corresponding disk and prints out the bad sector information. +It issues a warning if the bad sectors are out of order. +.Nm +may also be invoked with a serial number for the pack and a list +of bad sectors. +It will write the supplied information into all copies +of the bad-sector file, replacing any previous information. +Note, however, that +.Nm +does not arrange for the specified sectors to be marked bad in this case. +This procedure should only be used to restore known bad sector +information which was destroyed. +.Pp +It is no longer necessary to reboot to allow the kernel +to reread the bad-sector table from the drive. +.Sh SEE ALSO +.Xr badsect 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.1 . +.Sh BUGS +It should be possible to format disks on-line under +.Bx 4 . +.Pp +It should be possible to mark bad sectors on drives of all type. +.Pp +On an 11/750, +the standard bootstrap drivers used to boot the system do +not understand bad sectors, +handle +.Tn ECC +errors, or the special +.Tn SSE +(skip sector) errors of RM80-type disks. +This means that none of these errors can occur when reading the file +.Pa /netbsd +to boot. Sectors 0-15 of the disk drive +must also not have any of these errors. +.Pp +The drivers which write a system core image on disk after a crash do not +handle errors; thus the crash dump area must be free of errors and bad +sectors. diff --git a/static/netbsd/man8/badsect.8 b/static/netbsd/man8/badsect.8 new file mode 100644 index 00000000..f7ff2f46 --- /dev/null +++ b/static/netbsd/man8/badsect.8 @@ -0,0 +1,132 @@ +.\" $NetBSD: badsect.8,v 1.17 2003/08/07 10:04:11 agc Exp $ +.\" +.\" Copyright (c) 1985, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)badsect.8 8.1 (Berkeley) 6/5/93 +.\" +.Dd June 5, 1993 +.Dt BADSECT 8 +.Os +.Sh NAME +.Nm badsect +.Nd create files to contain bad sectors +.Sh SYNOPSIS +.Nm +.Ar bbdir sector ... +.Sh DESCRIPTION +.Nm +makes a file to contain a bad sector. +Normally, bad sectors are made inaccessible by the standard formatter, +which provides a forwarding table for bad sectors to the driver; see +.Xr bad144 8 +for details. +If a driver supports the bad blocking standard it is much preferable to +use that method to isolate bad blocks, since the bad block forwarding +makes the pack appear perfect, and such packs can then be copied with +.Xr dd 1 . +The technique used by this program is also less general than +bad block forwarding, as +.Nm +can't make amends for +bad blocks in the i-list of file systems or in swap areas. +.Pp +On some disks, +adding a sector which is suddenly bad to the bad sector table +currently requires the running of the standard +.Tn DEC +formatter. +Thus to deal with a newly bad block +or on disks where the drivers +do not support the bad-blocking standard +.Nm +may be used to good effect. +.Pp +.Nm +is used on a quiet file system in the following way: +First mount the file system, and change to its root directory. +Make a directory +.Li BAD +there. +Run +.Nm +giving as argument the +.Ar BAD +directory followed by +all the bad sectors you wish to add. +The sector numbers must be relative to the beginning of +the file system, but this is not hard as the system reports +relative sector numbers in its console error messages. +Then change back to the root directory, unmount the file system +and run +.Xr fsck 8 +on the file system. +The bad sectors should show up in two files +or in the bad sector files and the free list. +Have +.Xr fsck 8 +remove files containing the offending bad sectors, but +.Em do not +have it remove the +.Pa BAD/ Ns Em nnnnn +files. +This will leave the bad sectors in only the +.Li BAD +files. +.Pp +.Nm +works by giving the specified sector numbers in a +.Xr mknod 2 +system call, +creating an illegal file whose first block address is the block containing +bad sector and whose name is the bad sector number. +When it is discovered by +.Xr fsck 8 +it will ask +.Dq Li "HOLD BAD BLOCK ?" +A positive response will cause +.Xr fsck 8 +to convert the inode to a regular file containing the bad block. +.Sh DIAGNOSTICS +.Nm +refuses to attach a block that +resides in a critical area or is out of range of the file system. +A warning is issued if the block is already in use. +.Sh SEE ALSO +.Xr bad144 8 , +.Xr fsck 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.1 . +.Sh BUGS +If more than one of the sectors in a file system fragment are bad, +you should specify only one of them to +.Nm , +as the blocks in the bad sector files actually cover all the sectors in a +file system fragment. diff --git a/static/netbsd/man8/binpatch.8 b/static/netbsd/man8/binpatch.8 new file mode 100644 index 00000000..ae21473c --- /dev/null +++ b/static/netbsd/man8/binpatch.8 @@ -0,0 +1,93 @@ +.\" $NetBSD: binpatch.8,v 1.7 2001/11/26 00:06:40 wiz Exp $ +.\" +.\" Copyright (c) 1994 Christian E. Hopps +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by Christian E. Hopps. +.\" 4. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 2, 1994 +.Dt BINPATCH 8 amiga +.Os +.Sh NAME +.Nm binpatch +.Nd "examine and or modify initialized data in a binary file" +.Sh SYNOPSIS +.Nm binpatch +.Op Fl b | Fl w | Fl l +.Op Fl o Ar offset +.Fl s Ar symname +.Op Fl r Ar value +.Ar binfile +.Nm binpatch +.Op Fl b | Fl w | Fl l +.Op Fl o Ar offset +.Fl a Ar addr +.Op Fl r Ar value +.Ar binfile +.Sh DESCRIPTION +.Nm +is used to modify or examine the data associated with a symbol in a binary +file +.Ar binfile . +The flags +.Fl b , +.Fl w +and +.Fl l +specify the size of the data to be modified or examined +(byte, word and long respectively.) The +.Ar binfile +is scanned in search of the symbol +.Ar symname +(specified with the +.Fl s +flag) +If the symbol is found the current data and address are printed. Next if the +.Fl r +flag has been given, the current data is replaced with that of +.Ar value . +.Pp +If the second form is used the address +.Ar addr +specified with the +.Fl a +flag is used as a direct address into the data section of the binary and +no symbol search is performed. +.Pp +The +.Fl o +flag specifies an offset in byte, word or long +.Fl ( b , +.Fl w , +or +.Fl l ) +units from the given locator +.Fl ( s +or +.Fl a ) +for +.Nm +to perform its described actions. diff --git a/static/netbsd/man8/binstall.8 b/static/netbsd/man8/binstall.8 new file mode 100644 index 00000000..da933ac5 --- /dev/null +++ b/static/netbsd/man8/binstall.8 @@ -0,0 +1,102 @@ +.\" $NetBSD: binstall.8,v 1.5 2008/09/24 18:19:13 reed Exp $ +.\" +.\" Copyright (c) 2002 Matthew R. Green +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd January 6, 2002 +.Dt BINSTALL 8 sparc +.Os +.Sh NAME +.Nm /usr/mdec/binstall +.Nd install sparc and sparc64 boot blocks +.Sh SYNOPSIS +.Nm +.Op Fl htUuv +.Op Fl b Ar bootprog +.Op Fl f Ar filesystem +.Op Fl m Ar mdec +.Op Fl i Ar installbootprog +.Oo +.Dq net +.Ns \&| +.Dq ffs +.Oc +.Op directory +.Sh DESCRIPTION +The +.Nm +program prepares a sparc or sparc64 system for booting, either from local +disk from a +.Dq ffs +partition or over the network. The default type of boot block installed +is derived from the host system. If it is an UltraSPARC, the sparc64 +boot blocks will be used, otherwise the SPARC boot blocks will be used. +.Nm +can be forced to prepare a disk for either. +.Sh OPTIONS +The following options are available: +.Bl -tag -width 123456 +.It Fl b +Set the second stage boot program to +.Ar bootprog . +This will typically be +.Pa boot.net +for sparc systems and +.Pa ofwboot.net +for sparc64 systems. +.It Fl f +Set the path to the filesystem being installed for to +.Ar filesystem . +This is otherwise derived from the +.Op directory . +.It Fl h +Display help. +.It Fl i +Set the path to the +.Xr installboot 8 +program to +.Ar installbootprog . +This is useful for using +.Nm +on non-sparc or sparc64 systems. +.It Fl m +Sets the path to the machine dependent directory to +.Ar mdec . +This is the directory that both the boot blocks and the +.Xr installboot 8 +program live. +.It Fl t +Test mode; does not run any program. Implies the +.Fl v +option. +.It Fl U +Install sparc (SPARC) boot blocks. +.It Fl u +Install sparc64 (UltraSPARC) boot blocks. +.It Fl v +Be verbose. +.El +.Sh SEE ALSO +.Xr disklabel 8 , +.Xr installboot 8 diff --git a/static/netbsd/man8/bioctl.8 b/static/netbsd/man8/bioctl.8 new file mode 100644 index 00000000..0948084c --- /dev/null +++ b/static/netbsd/man8/bioctl.8 @@ -0,0 +1,172 @@ +.\" $NetBSD: bioctl.8,v 1.25 2019/05/08 06:10:30 wiz Exp $ +.\" $OpenBSD: bioctl.8,v 1.43 2007/03/20 06:12:11 jmc Exp $ +.\" +.\" Copyright (c) 2007, 2008 Juan Romero Pardines +.\" Copyright (c) 2004, 2005 Marco Peereboom +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR +.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd May 7, 2019 +.Dt BIOCTL 8 +.Os +.Sh NAME +.Nm bioctl +.Nd RAID management interface +.Sh SYNOPSIS +.Nm bioctl +.Ar device +.Ar command +.Op Ar arg Op ... +.Sh DESCRIPTION +RAID device drivers which support management functionality can +register their services with the +.Xr bio 4 +driver. +.Nm bioctl +then can be used to manage the RAID controller's properties. +.Sh COMMANDS +The following commands are supported: +.Bl -tag -width XXstrategyXXnameXX +.It Ic show Op Ar disks | volumes +Without any argument by default +.Nm +will show information about all volumes and the logical disks used +on them. +If +.Ar disks +is specified, only information about physical disks will be shown. +If +.Ar volumes +is specified, only information about the volumes will be shown. +.It Ic alarm Op Ar disable | enable | silence | test +Control the RAID card's alarm functionality, if supported. +By default if no argument is specified, its current state will be +shown. +Optionally the +.Ar disable , +.Ar enable , +.Ar silence , +or +.Ar test +arguments may be specified to enable, disable, silence, or test +the RAID card's alarm. +.It Ic blink Ar start channel:target.lun | stop channel:target.lun +Instruct the device at +.Ar channel:target.lun +to start or cease blinking, if there's +.Xr ses 4 +support in the enclosure. +.It Ic hotspare Ar add channel:target.lun | remove channel:target.lun +Create or remove a hot-spare drive at location +.Ar channel:target.lun . +.It Ic passthru Ar add DISKID channel:target.lun | remove Ar channel:target.lun +Create or remove a +.Ar pass-through +device. +The +.Ar DISKID +argument specifies the disk that will be used for the new device, and +it will be created at the location +.Ar channel:target.lun . +.Em NOTE : +Removing a pass-through device that has a mounted filesystem will +lead to undefined behaviour. +.It Ic check Ar start VOLID | stop VOLID +Start or stop consistency volume check in the volume with index +.Ar VOLID . +.Em NOTE : +Not many RAID controllers support this feature. +.It Ic create volume Ar VOLID DISKIDs Oo Ar SIZE Oc Ar STRIPE RAID_LEVEL channel:target.lun +Create a volume at index +.Ar VOLID . +The +.Ar DISKIDs +argument will specify the first and last disk, i.e.: +.Em 0-3 +will use the disks 0, 1, 2, and 3. +The +.Ar SIZE +argument is optional and may be specified if not all available disk +space is wanted (also dependent of the +.Ar RAID_LEVEL ) . +The volume will have a stripe size defined in the +.Ar STRIPE +argument and it will be located at +.Ar channel:target.lun . +.It Ic remove volume Ar VOLID channel:target.lun +Remove a volume at index +.Ar VOLID +and located at +.Ar channel:target.lun . +.Em NOTE : +Removing a RAID volume that has a mounted filesystem will lead to +undefined behaviour. +.El +.Sh EXAMPLES +The following command, executed from the command line, shows the +status of the volumes and its logical disks on the RAID controller: +.Bd -literal +$ bioctl arcmsr0 show +Volume Status Size Device/Label RAID Level Stripe +================================================================= + 0 Building 468G sd0 ARC-1210-VOL#00 RAID 6 128KB 0% done + 0:0 Online 234G 0:0.0 noencl + 0:1 Online 234G 0:1.0 noencl + 0:2 Online 234G 0:2.0 noencl + 0:3 Online 234G 0:3.0 noencl +.Ed +.Pp +To create a RAID 5 volume on the SCSI 0:15.0 location on the disks +0, 1, 2, and 3, with stripe size of 64Kb on the first volume ID, +using all available free space on the disks: +.Pp +.Dl $ bioctl arcmsr0 create volume 0 0-3 64 5 0:15.0 +.Pp +To remove the volume 0 previously created at the SCSI 0:15.0 location: +.Pp +.Dl $ bioctl arcmsr0 remove volume 0 0:15.0 +.Sh SEE ALSO +.Xr arcmsr 4 , +.Xr ataraid 4 , +.Xr bio 4 , +.Xr cac 4 , +.Xr ciss 4 , +.Xr mfi 4 , +.Xr mfii 4 , +.Xr mpii 4 , +.Xr mpt 4 +.Sh HISTORY +The +.Nm +command appeared in +.Ox 3.8 , +it first appeared in +.Nx 4.0 +and was rewritten for +.Nx 5.0 . +.Sh AUTHORS +The +.Nm +interface was written by +.An Marco Peereboom Aq Mt marco@openbsd.org +and was rewritten with multiple features by +.An Juan Romero Pardines Aq Mt xtraeme@NetBSD.org . diff --git a/static/netbsd/man8/blkdiscard.8 b/static/netbsd/man8/blkdiscard.8 new file mode 100644 index 00000000..e99e3f68 --- /dev/null +++ b/static/netbsd/man8/blkdiscard.8 @@ -0,0 +1,163 @@ +.\" $NetBSD: blkdiscard.8,v 1.4 2026/04/07 21:59:43 gutteridge Exp $ +.\" +.\" Copyright (c) 2022 Matthew R. Green +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd January 13, 2024 +.Dt BLKDISCARD 8 +.Os +.Sh NAME +.Nm blkdiscard +.Nd tool to discard portions of a device or file +.Sh SYNOPSIS +.Nm +.Op Fl h +.Op Fl l Ar length +.Op Fl p Ar chunksize +.Op Fl n +.Op Fl o Ar firstbyte +.Op Fl R +.Op Fl s +.Op Fl V +.Op Fl v +.Op Fl z +.Ar file +.Nm fdiscard +.Op Fl f Ar firstbyte +.Op Fl h +.Op Fl l Ar length +.Op Fl m Ar chunksize +.Op Fl n +.Op Fl R +.Op Fl s +.Op Fl V +.Op Fl v +.Op Fl z +.Ar file +.Sh DESCRIPTION +The +.Nm +program can be used to discard portions of storage, and works on either +device files directly or upon files inside of a mounted file-system. +It provides access to the +.Xr fdiscard 2 +system call, and relies upon the +backing device to have support in both the +.Nm +driver and in the hardware itself. +.Pp +The +.Nm fdiscard +interface defaults to the +.Dq no-run +mode and requires the +.Fl R +option to perform any actions. +.Pp +.Sh OPTIONS +Available options: +.Bl -tag -width chunksize123 +.It Fl f Ar firstbyte +Set the first byte to be discarded. +The default is 0. +.It Fl h +Display built-in help. +.It Fl l Ar length +Limit the length to be discarded. +The default is the full device or file size, or the rest of the device +or file when the start offset has been set. +.It Fl m Ar chunksize +Set the per-operation chunksize. +The default is 32 MiB. +.It Fl n +Set the +.Dq no-run +option, and do not actually call +.Xr fdiscard 2 , +secure erase, or write zeroes to the file. +.It Fl o Ar firstbyte +This flag is an alias for the +.Fl f +flag. +.It Fl p Ar chunksize +This flag is an alias for the +.Fl m +flag. +.It Fl R +Turn off the +.Dq no-run mode. +.It Fl s +Use secure erase operation. +This requires specific hardware support and is not currently supported. +.It Fl V +Display the program version and exit. +.It Fl v +Set the verbose flag. +.It Fl z +Write zeroes instead of calling +.Xr fdiscard 2 . +.Sh EXAMPLES +To have a dry-run cleaning of any particular file or device: +.Bd -literal -offset indent +# blkdiscard -n -v filename +# blkdiscard -n -v /dev/rwd0b +.Ed +.Pp +To discard all the blocks on a swap device: +.Bd -literal -offset indent +# blkdiscard -v /dev/rwd0b +.Ed +.Pp +To discard all but the first 256MiB of a device, using 128MiB increments: +.Bd -literal -offset indent +# blkdiscard -v -f 256m -m 128m /dev/rwd0c +.Ed +.Pp +To zero out the contents of a file or device: +.Bd -literal -offset indent +# blkdiscard -v -z filename +# blkdiscard -v -z /dev/device +.Ed +.Sh SEE ALSO +.Xr fdiscard 2 +.Sh HISTORY +The +.Nm +command first appeared in util-linux. +This implementation was originally called fdiscard-stuff and has been +converted to be +.Lx +.Xr blkdiscard 8 +compatible and appeared in +.Nx 10.0 . +.Sh AUTHORS +The +.Nm +command was written by +.An Matthew R. Green +.Aq mrg@eterna23.net . +.Sh BUGS +The secure erase functionality of the +.Fl s +option is not yet implemented. diff --git a/static/netbsd/man8/blocklistctl.8 b/static/netbsd/man8/blocklistctl.8 new file mode 100644 index 00000000..d241f284 --- /dev/null +++ b/static/netbsd/man8/blocklistctl.8 @@ -0,0 +1,134 @@ +.\" $NetBSD: blocklistctl.8,v 1.6 2025/10/26 13:49:22 christos Exp $ +.\" +.\" Copyright (c) 2015 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Christos Zoulas. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd October 25, 2025 +.Dt BLOCKLISTCTL 8 +.Os +.Sh NAME +.Nm blocklistctl +.Nd display and change the state of the blocklistd database +.Sh SYNOPSIS +.Nm +.Cm dump +.Op Fl abdnrw +.Op Fl D Ar dbname +.Sh DESCRIPTION +.Nm +is a program used to display and change the state of the +.Xr blocklistd 8 +database. +The following sub-commands are supported: +.Ss dump +The following options are available for the +.Cm dump +sub-command: +.Bl -tag -width indent +.It Fl a +Show all database entries, by default it shows only the active ones. +Inactive entries will be shown with a last-access (or, with +.Fl r , +the remaining) time of +.Ql never . +.It Fl b +Show only the blocked entries. +.It Fl D Ar dbname +Specify the location of the +.Ic blocklistd +database file to use. +The default is +.Pa /var/db/blocklistd.db . +.It Fl d +Increase debugging level. +.It Fl n +Don't display a header. +.It Fl r +Show the remaining blocked time instead of the last activity time. +.It Fl w +Normally the width of addresses is good for IPv4, the +.Fl w +flag, makes the display wide enough for IPv6 addresses. +.El +.Pp +The output of the +.Cm dump +sub-command consists of a header (unless +.Fl n +was given) and one line for each record in the database, where each line +has the following columns: +.Bl -tag -width indent +.It Ql rulename +The packet filter rule name associated with the database entry, +usually +.Dv blocklistd . +.It Ql address/ma:port +The remote address, mask, and local port number of the client connection +associated with the database entry. +.It Ql id +column will show the identifier for the packet filter rule associated +with the database entry, though this may only be the word +.Ql OK +for packet filters which do not create a unique identifier for each rule. +.It Ql nfail +The number of +.Em failures +reported for the client on the noted port, as well as the number of +failures allowed before blocking (or, with +.Fl a , +an asterisk +.Aq * ) +.It So last access Sc | So remaining time Sc +The last time a the client was reported as attempting access, or, with +.Fl r , +the time remaining before the rule blocking the client will be removed. +.El +.Sh SEE ALSO +.Xr blocklistd 8 +.Sh NOTES +Sometimes the reported number of failed attempts can exceed the number +of attempts that +.Xr blocklistd 8 +is configured to block. +This can happen either because the rule has been removed manually, or +because there were more attempts in flight while the rule block was being +added. +This condition is normal; in that case +.Xr blocklistd 8 +will first attempt to remove the existing rule, and then it will re-add +it to make sure that there is only one rule active. +.Sh HISTORY +.Nm +first appeared in +.Nx 7 . +.Fx +support for +.Nm +was implemented in +.Fx 11 . +.Sh AUTHORS +.An Christos Zoulas diff --git a/static/netbsd/man8/blocklistd.8 b/static/netbsd/man8/blocklistd.8 new file mode 100644 index 00000000..38bf2217 --- /dev/null +++ b/static/netbsd/man8/blocklistd.8 @@ -0,0 +1,301 @@ +.\" $NetBSD: blocklistd.8,v 1.8 2025/02/25 22:13:34 christos Exp $ +.\" +.\" Copyright (c) 2015 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Christos Zoulas. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 25, 2025 +.Dt BLOCKLISTD 8 +.Os +.Sh NAME +.Nm blocklistd +.Nd block and release ports on demand to avoid DoS abuse +.Sh SYNOPSIS +.Nm +.Op Fl dfrv +.Op Fl C Ar controlprog +.Op Fl c Ar configfile +.Op Fl D Ar dbfile +.Op Fl P Ar sockpathsfile +.Op Fl R Ar rulename +.Op Fl s Ar sockpath +.Op Fl t Ar timeout +.Sh DESCRIPTION +.Nm +is a daemon similar to +.Xr syslogd 8 +that listens to sockets at paths specified in the +.Ar sockpathsfile +for notifications from other daemons about successful or failed connection +attempts. +If no such file is specified, then it only listens to the socket path +specified by +.Ar sockpath +or if that is not specified to +.Pa /var/run/blocklistd.sock . +Each notification contains an (action, port, protocol, address, owner) tuple +that identifies the remote connection and the action. +This tuple is consulted against entries from the +.Ar configfile , +with the syntax specified in +.Xr blocklistd.conf 5 . +If an entry is matched, a state entry is created for that tuple. +Each entry contains a number of tries limit and a duration. +.Pp +If +.Ar configfile +is a directory, or a directory exists with the same name as +.Ar configfile +with +.Qq .d +appended to it, each file in the directory will be read as configuration file. +If +.Ar configfile +exists as a file it will be processed before the contents of the +.Ar configfile Ns .d +directory if that also exists. +.Pp +The way +.Nm +does configuration entry matching is by having the client side pass the +file descriptor associated with the connection the client wants to blocklist +as well as passing socket credentials. +.Pp +The file descriptor is used to retrieve information (address and port) +about the remote side with +.Xr getpeername 2 +and the local side with +.Xr getsockname 2 . +.Pp +By examining the port of the local side, +.Nm +can determine if the client program +.Dq owns +the port. +By examining the optional address portion on the local side, it can match +interfaces. +By examining the remote address, it can match specific allow or deny rules. +.Pp +Finally +.Nm +can examine the socket credentials to match the user in the configuration file. +.Pp +While this works well for TCP sockets, it cannot be relied on for unbound +UDP sockets. +It is also less meaningful when it comes to connections using non-privileged +ports. +On the other hand, if we receive a request that has a local endpoint indicating +a UDP privileged port, we can presume that the client was privileged to be +able to acquire that port. +.Pp +Once an entry is matched +.Nm +can perform various actions. +If the action is +.Dq add +and the number of tries limit is reached, then a +control script +.Ar controlprog +is invoked with arguments: +.Bd -literal -offset indent +control add
+.Ed +.Pp +and should invoke a packet filter command to block the connection +specified by the arguments. +The +.Ar rulename +argument can be set from the command line (default +.Dv blocklistd ) . +The script could print a numerical id to stdout as a handle for +the rule that can be used later to remove that connection, but +that is not required as all information to remove the rule is +kept. +.Pp +If the action is +.Dq rem +Then the same control script is invoked as: +.Bd -literal -offset indent +control rem
+.Ed +.Pp +where +.Ar id +is the number returned from the +.Dq add +action. +.Pp +.Nm +maintains a database of known connections in +.Ar dbfile . +On startup it reads entries from that file, and updates its internal state. +.Pp +.Nm +checks the list of active entries every +.Ar timeout +seconds (default +.Dv 15 ) +and removes entries and block rules using the control program as necessary. +.Pp +The following options are available: +.Bl -tag -width indent +.It Fl C Ar controlprog +Use +.Ar controlprog +to communicate with the packet filter, instead of the default, which is +.Pa /libexec/blocklistd-helper . +The following arguments are passed to the control program: +.Bl -tag -width protocol +.It action +The action to perform: +.Dv add , +.Dv rem , +or +.Dv flush ; +to add, remove or flush a firewall rule. +.It name +The rule name. +.It protocol +The optional protocol name (can be empty): +.Dv tcp , +.Dv tcp6 , +.Dv udp , +.Dv udp6 . +.It address +The IPv4 or IPv6 numeric address to be blocked or released. +.It mask +The numeric mask to be applied to the blocked or released address +.It port +The optional numeric port to be blocked (can be empty). +.It id +For packet filters that support removal of rules by rule identifier, the +identifier of the rule to be removed. +The add command is expected to return the rule identifier string to stdout. +.El +.It Fl c Ar configuration +The name of the configuration file to read. +The default when +.Fl c +is not given is +.Pa /etc/blocklistd.conf . +.It Fl D Ar dbfile +The Berkeley DB file where +.Nm +stores its state. +It defaults to +.Pa /var/db/blocklistd.db . +.It Fl d +Normally, +.Nm +disassociates itself from the terminal unless the +.Fl d +flag is specified, in which case it stays in the foreground. +.It Fl f +Truncate the state database and flush all the rules named +.Ar rulename +are deleted by invoking the control script as: +.Bd -literal -offset indent +control flush +.Ed +.It Fl P Ar sockpathsfile +A file containing a list of pathnames, one per line that +.Nm +will create sockets to listen to. +This is useful for chrooted environments. +.It Fl R Ar rulename +Specify the default rule name for the packet filter rules, usually +.Dv blocklistd . +.It Fl r +Re-read the firewall rules from the internal database, then +remove and re-add them. +This helps for packet filters that do not retain state across reboots. +.It Fl s Ar sockpath +Add +.Ar sockpath +to the list of Unix sockets +.Nm +listens to. +.It Fl t Ar timeout +The interval in seconds +.Nm +polls the state file to update the rules. +.It Fl v +Cause +.Nm +to print +diagnostic messages to +.Dv stdout +instead of +.Xr syslogd 8 . +.El +.Sh SIGNAL HANDLING +.Nm +deals with the following signals: +.Bl -tag -width "USR2" +.It Dv HUP +Receipt of this signal causes +.Nm +to re-read the configuration file. +.It Dv INT , Dv TERM & Dv QUIT +These signals tell +.Nm +to exit in an orderly fashion. +.It Dv USR1 +This signal tells +.Nm +to increase the internal debugging level by 1. +.It Dv USR2 +This signal tells +.Nm +to decrease the internal debugging level by 1. +.El +.Sh FILES +.Bl -tag -width /libexec/blocklistd-helper -compact +.It Pa /libexec/blocklistd-helper +Shell script invoked to interface with the packet filter. +.It Pa /etc/blocklistd.conf +Configuration file. +.It Pa /var/db/blocklistd.db +Database of current connection entries. +.It Pa /var/run/blocklistd.sock +Socket to receive connection notifications. +.El +.Sh SEE ALSO +.Xr blocklistd.conf 5 , +.Xr blocklistctl 8 , +.Xr npfctl 8 , +.Xr syslogd 8 +.Sh HISTORY +.Nm +first appeared in +.Nx 7 . +.Fx +support for +.Nm +was implemented in +.Fx 11 . +.Sh AUTHORS +.An Christos Zoulas diff --git a/static/netbsd/man8/boot.8 b/static/netbsd/man8/boot.8 index cc083d78..ffbfc8bb 100644 --- a/static/netbsd/man8/boot.8 +++ b/static/netbsd/man8/boot.8 @@ -1,10 +1,10 @@ -.\" $NetBSD: boot.8,v 1.16 2017/02/18 21:47:11 wiz Exp $ +.\" $NetBSD: boot.8,v 1.3 2008/04/30 13:10:57 martin Exp $ .\" -.\" Copyright (c) 1991, 1993 -.\" The Regents of the University of California. All rights reserved. +.\" Copyright (c) 2003 The NetBSD Foundation, Inc. +.\" All rights reserved. .\" -.\" This code is derived from software written and contributed -.\" to Berkeley by William Jolitz. +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Marcus Comstedt. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -14,285 +14,46 @@ .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" 3. Neither the name of the University nor the names of its contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. .\" -.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. .\" -.\" @(#)boot_i386.8 8.2 (Berkeley) 4/19/94 -.\" -.Dd August 16, 2014 -.Dt BOOT 8 +.Dd July 4, 2003 +.Dt BOOT 8 dreamcast .Os .Sh NAME .Nm boot -.Nd -system bootstrapping procedures +.Nd system bootstrapping procedures .Sh DESCRIPTION -This document provides information on using common features in the -.Nx -boot loader. -Additional information may be found in -architecture-specific -.Xr boot 8 -manual pages. -.Ss Boot Protocol -In the native +.Tn Dreamcast +consoles can only boot from the built-in +.Tn GD-ROM +drive. +Insert a bootable CD-R containing the .Nx -boot protocol, options are passed from the boot loader -to the kernel via flag bits in the -.Va boothowto -variable (see -.Xr boothowto 9 ) . -Some boot loaders may also support other boot protocols. -.Ss Menu -Some boot loaders may present a menu, which may be configured via -.Xr boot.cfg 5 . -.Ss Interactive mode -In interactive mode, the boot loader will present a prompt, allowing -input of these commands: -.\" NOTE: much of this text is duplicated in architecture-specific -.\" man pages (man8/man8.*/*boot*.8); -.\" please try to keep all relevant files synchronized. -.Bl -tag -width 04n -offset 04n -.It Ic boot Oo Va device : Oc Ns Oo Va filename Oc Oo Fl 1234abcdmqsvxz Oc -The default -.Va device -will be set to the disk that the boot loader was -loaded from. -To boot from an alternate disk, the full name of the device should -be given at the prompt. -.Va device -is of the form -.Xo Va xd -.Op Va N Ns Op Va x -.Xc -where -.Va xd -is the device from which to boot, -.Va N -is the unit number, and -.Va x -is the partition letter. -.Pp -The following list of supported devices may vary from installation to -installation: -.Pp -.Bl -hang -compact -.It hd -Hard disks. -.It fd -Floppy drives. -.El -.Pp -The default -.Va filename -is -.Pa netbsd ; -if the boot loader fails to successfully -open that image, it then tries -.Pa netbsd.gz -(expected to be a kernel image compressed by gzip), followed by -.Pa netbsd.old , -.Pa netbsd.old.gz , -.Pa onetbsd , -and finally -.Pa onetbsd.gz . -Alternate system images can be loaded by just specifying the name of the image. -.Pp -Options are: -.Bl -tag -width xxx -.It Fl 1 -Sets the machine-dependent flag -.Sy RB_MD1 -in -.Va boothowto . -.It Fl 2 -Sets the machine-dependent flag -.Sy RB_MD2 -in -.Va boothowto . -.It Fl 3 -Sets the machine-dependent flag -.Sy RB_MD3 -in -.Va boothowto . -.It Fl 4 -Sets the machine-dependent flag -.Sy RB_MD4 -in -.Va boothowto . -.It Fl a -Sets the -.Sy RB_ASKNAME -flag in -.Va boothowto . -This causes the kernel to prompt for the root file system device, -the system crash dump device, and the path to -.Xr init 8 . -.It Fl b -Sets the -.Sy RB_HALT -flag in -.Va boothowto . -This causes subsequent reboot attempts to halt instead of rebooting. -.It Fl c -Sets the -.Sy RB_USERCONF -flag in -.Va boothowto . -This causes the kernel to enter the -.Xr userconf 4 -device configuration manager as soon as possible during the boot. -.Xr userconf 4 -allows devices to be enabled or disabled, and allows device locators -(such as hardware addresses or bus numbers) -to be modified before the kernel attempts to attach the devices. -.It Fl d -Sets the -.Sy RB_KDB -flag in -.Va boothowto . -Requests the kernel to enter debug mode, in which it -waits for a connection from a kernel debugger; see -.Xr ddb 4 . -.It Fl m -Sets the -.Sy RB_MINIROOT -flag in -.Va boothowto . -Informs the kernel that a mini-root file system is present in memory. -.It Fl q -Sets the -.Sy AB_QUIET -flag in -.Va boothowto . -Boot the system in quiet mode. -.It Fl s -Sets the -.Sy RB_SINGLE -flag in -.Va boothowto . -Boot the system in single-user mode. -.It Fl v -Sets the -.Sy AB_VERBOSE -flag in -.Va boothowto . -Boot the system in verbose mode. -.It Fl x -Sets the -.Sy AB_DEBUG -flag in -.Va boothowto . -Boot the system with debug messages enabled. -.It Fl z -Sets the -.Sy AB_SILENT -flag in -.Va boothowto . -Boot the system in silent mode. -.El -.It Ic consdev Va dev -Immediately switch the console to the specified device -.Va dev -and reprint the banner. -.Va dev -must be one of -.\" .Bl -item -width com[0123]kbd -offset indent -compact -.Ar pc , com0 , com1 , com2 , -.Ar com3 , com0kbd , com1kbd , com2kbd , -.Ar com3kbd , -or -.Ar auto . -See -.Sx Console Selection Policy -in -.Xr x86/boot_console 8 . -.It Ic dev Op Va device -Set the default drive and partition for subsequent filesystem -operations. -Without an argument, print the current setting. -.Va device -is of the form specified in -.Cm boot . -.It Ic help -Print an overview about commands and arguments. -.\" .It Ic load Va module Op Va arguments -.\" [x86 only] -.It Ic ls Op Pa path -Print a directory listing of -.Pa path , -containing inode number, filename, and file type. -.Pa path -can contain a device specification. -.\" .It Ic multiboot Va kernel Op Va arguments -.\" [x86 only] -.It Ic quit -Reboot the system. -.\" .It Ic userconf Va command -.\" [x86only] -.El -.Pp -In an emergency, the bootstrap methods described in the -.Nx -installation notes for the specific architecture -can be used. +kernel and turn on the power. .Sh FILES -.Bl -tag -width /usr/mdec/bootxx_fstype -compact -.It Pa /boot -boot program code loaded by the primary bootstrap -.\" .It Pa /boot.cfg -.\" optional configuration file -.\" [x86 only] +.Bl -tag -width /netbsd -compact .It Pa /netbsd system code -.It Pa /netbsd.gz -gzip-compressed system code -.It Pa /usr/mdec/boot -master copy of the boot program (copy to /boot) -.It Pa /usr/mdec/bootxx_fstype -primary bootstrap for filesystem type fstype, copied to the start of -the -.Nx -partition by -.Xr installboot 8 . .El .Sh SEE ALSO -Architecture-specific -.Xr boot 8 -manual pages (such as -.Xr emips/boot 8 , -.Xr sparc64/boot 8 , -.Xr x86/boot 8 ) , .Xr ddb 4 , .Xr userconf 4 , -.\" .Xr boot.cfg 5 [x86 only] , .Xr halt 8 , -.Xr installboot 8 , .Xr reboot 8 , -.Xr rescue 8 , -.Xr shutdown 8 , -.Xr boothowto 9 -.Sh BUGS -The kernel file name must be specified before, not after, the boot options. -Any -.Ar filename -specified after the boot options, e.g.: -.Pp -.Bd -unfilled -offset indent -compact -.Cm boot -d netbsd.test -.Ed -.Pp -is ignored, and the default kernel is booted. +.Xr shutdown 8 +.Sh HISTORY +The +.Nm +man page appeared in +.Nx 2.0 . diff --git a/static/netbsd/man8/boot.8 4.html b/static/netbsd/man8/boot.8 4.html new file mode 100644 index 00000000..6cc9571e --- /dev/null +++ b/static/netbsd/man8/boot.8 4.html @@ -0,0 +1,223 @@ + + + + + + +
BOOT(8)System Manager's ManualBOOT(8)
+
+
+

+

boot — system + bootstrapping procedures

+
+
+

+

This document provides information on using common features in the + NetBSD boot loader. Additional information may be + found in architecture-specific boot(8) manual pages.

+
+

+

In the native NetBSD boot protocol, + options are passed from the boot loader to the kernel via flag bits in the + boothowto variable (see + boothowto(9)). Some boot loaders may also support other + boot protocols.

+
+
+ +

Some boot loaders may present a menu, which may be configured via + boot.cfg(5).

+
+
+

+

In interactive mode, the boot loader will present a prompt, + allowing input of these commands:

+
+
+
+ [device:][filename] + [-1234abcdmqsvxz]
+
The default device will be set to the disk that the + boot loader was loaded from. To boot from an alternate disk, the full name + of the device should be given at the prompt. device + is of the form xd + [N[x]] where + xd is the device from which to boot, + N is the unit number, and x is + the partition letter. +

The following list of supported devices may vary from + installation to installation:

+

+
+
hd
+
Hard disks.
+
fd
+
Floppy drives.
+
+

The default filename is + netbsd; if the boot loader fails to successfully + open that image, it then tries netbsd.gz + (expected to be a kernel image compressed by gzip), followed by + netbsd.old, + netbsd.old.gz, onetbsd, + and finally onetbsd.gz. Alternate system images + can be loaded by just specifying the name of the image.

+

Options are:

+
+
+
Sets the machine-dependent flag + + in boothowto.
+
+
Sets the machine-dependent flag + + in boothowto.
+
+
Sets the machine-dependent flag + + in boothowto.
+
+
Sets the machine-dependent flag + + in boothowto.
+
+
Sets the + + flag in boothowto. This causes the kernel to + prompt for the root file system device, the system crash dump device, + and the path to init(8).
+
+
Sets the + + flag in boothowto. This causes subsequent reboot + attempts to halt instead of rebooting.
+
+
Sets the + + flag in boothowto. This causes the kernel to + enter the userconf(4) device configuration manager + as soon as possible during the boot. userconf(4) + allows devices to be enabled or disabled, and allows device locators + (such as hardware addresses or bus numbers) to be modified before the + kernel attempts to attach the devices.
+
+
Sets the + + flag in boothowto. Requests the kernel to enter + debug mode, in which it waits for a connection from a kernel debugger; + see ddb(4).
+
+
Sets the + + flag in boothowto. Informs the kernel that a + mini-root file system is present in memory.
+
+
Sets the + + flag in boothowto. Boot the system in quiet + mode.
+
+
Sets the + + flag in boothowto. Boot the system in + single-user mode.
+
+
Sets the + + flag in boothowto. Boot the system in verbose + mode.
+
+
Sets the + + flag in boothowto. Boot the system with debug + messages enabled.
+
+
Sets the + + flag in boothowto. Boot the system in silent + mode.
+
+
+
+ dev
+
Immediately switch the console to the specified device + dev and reprint the banner. + dev must be one of pc, + com0, com1, + com2, com3, + com0kbd, com1kbd, + com2kbd, com3kbd, or + auto. See + Console Selection + Policy in x86/boot_console(8).
+
+ [device]
+
Set the default drive and partition for subsequent filesystem operations. + Without an argument, print the current setting. + device is of the form specified in + boot.
+
+
Print an overview about commands and arguments.
+
+ [path]
+
Print a directory listing of path, containing + inode number, filename, and file type. path can + contain a device specification.
+
+
Reboot the system.
+
+
+

In an emergency, the bootstrap methods described in the + NetBSD installation notes for the specific + architecture can be used.

+
+
+
+

+
+
/boot
+
boot program code loaded by the primary bootstrap
+
/netbsd
+
system code
+
/netbsd.gz
+
gzip-compressed system code
+
/usr/mdec/boot
+
master copy of the boot program (copy to /boot)
+
/usr/mdec/bootxx_fstype
+
primary bootstrap for filesystem type fstype, copied to the start of the + NetBSD partition by + installboot(8).
+
+
+
+

+

Architecture-specific boot(8) manual pages (such + as emips/boot(8), sparc64/boot(8), + x86/boot(8)), ddb(4), + userconf(4), halt(8), + installboot(8), reboot(8), + rescue(8), shutdown(8), + boothowto(9)

+
+
+

+

The kernel file name must be specified before, not after, the boot + options. Any filename specified after the boot + options, e.g.:

+

+
+
boot -d netbsd.test
+
+

is ignored, and the default kernel is booted.

+
+
+ + + + + +
August 16, 2014NetBSD 10.1
diff --git a/static/netbsd/man8/boot32.8 b/static/netbsd/man8/boot32.8 new file mode 100644 index 00000000..d0ec07ff --- /dev/null +++ b/static/netbsd/man8/boot32.8 @@ -0,0 +1,156 @@ +.\" $NetBSD: boot32.8,v 1.4 2016/04/30 14:32:22 jakllsch Exp $ +.\" +.\" Copyright (c) 2000, 2001 Ben Harris +.\" Copyright (c) 2004 Reinoud Zandijk +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 4, 2009 +.Dt BOOT32 8 acorn32 +.Os +.Sh NAME +.Nm boot32 +.Nd Bootloader for +.Nx Ns /acorn32 +.Sh SYNOPSIS +.Nm *boot32 +.Op Fl acdqsv +.Op Ar root=rootdir +.Op Ar file +.Sh DESCRIPTION +.Nm +is a program that runs under +.Tn RISC OS +and launches the +.Nx Ns /acorn32 +kernel. +It needs to be installed in a RISC OS filesystem and given file +type FFA (Module). +The kernel it is to load also needs to be stored in a +.Tn RISC OS +filesystem. +.Pp +It takes the following standard +.Nx +options, which set flags in the +.Va boothowto +variable in the booted kernel (see +.Xr boothowto 9 ) . +Not all flags may be effective. +.Bl -tag -width Fl +.It Fl a +.Pq Dv RB_ASKNAME +Cause the kernel to prompt the user for the name of the device containing the +root filesystem. +This also causes +.Nm +to prompt for the name of the kernel to be loaded. +.It Fl s +.Pq Dv RB_SINGLE +Cause the kernel to ask +.Nm init +to boot into single-user mode. +.It Fl d +.Pq Dv RB_KDB +Cause the kernel to enter the kernel debugger as soon as possible. +.It Fl c +.Pq Dv RB_USERCONF +Enter the in-kernel device configuration manager before attaching any +devices. +.It Fl q +.Pq Dv AB_QUIET +Cause the kernel to emit fewer messages than normal while starting up. +.It Fl v +.Pq Dv AB_VERBOSE +Cause the kernel to emit more messages than normal while starting up. +.El +.Pp +.Nm +attempts to load the kernel from the RISC OS file specified as +.Ar file , +or from +.Pa netbsd +if +.Ar file +is not specified. +The file must be an ELF image, and may have been compressed using +.Xr gzip 1 . +.Ss Use as a module +.Nm +is implemented as a RISC OS relocatable module. +It can be loaded into memory by running +.Ql *RMLoad boot32 . +After this, +.Nx +can be booted by running +.Ql *boot32 +as usual, but the command will be handled by the module. +.Pp +It should also be possible to arrange for +.Nm +to be loaded from ROM (e.g., from the ROM on an expansion card), in which case +.Nx +could be made to boot automatically by making +.Nm +the configured language using +.Ql *Configure Language . +.Ss Screen display +When it starts up, +.Nm +displays the number of 4 kilobyte memory pages it has been delegated by RISC-OS +and gives a summary about the memory map as reported by RISC-OS followed by a +table of physical memory ranges available to the bootloader. +All this information is mainly for bughunting booting problems. +.Pp +It then checks its internal structures and kicks out RISC-OS, relocates all +memory pages loaded in to their final destinations and kickstarts +.Nm . +.Sh FILES +.Bl -tag -width Pa +.It Pa /usr/mdec/boot32,ffa +The location of +.Nm +in the +.Nx +filesystem. +.El +.Sh SEE ALSO +.Xr gzip 1 , +.Xr reboot 2 , +.Xr ddb 4 , +.Xr userconf 4 , +.Xr init 8 , +.Xr boothowto 9 +.Sh HISTORY +.Nm +was introduced in +.Nx 1.6 +as a replacement for the original +.Nx Ns /arm32 +bootloader, which was written in BBC BASIC. +.Sh BUGS +.Nm +cannot load kernels from a +.Nx +filesystem. diff --git a/static/netbsd/man8/boot_console.8 b/static/netbsd/man8/boot_console.8 new file mode 100644 index 00000000..3da8af86 --- /dev/null +++ b/static/netbsd/man8/boot_console.8 @@ -0,0 +1,147 @@ +.\" $NetBSD: boot_console.8,v 1.4 2017/02/18 21:39:53 wiz Exp $ +.\" +.\" Copyright (c) 1997 +.\" Matthias Drochner. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd February 17, 2017 +.Dt BOOT_CONSOLE 8 x86 +.Os +.Sh NAME +.Nm boot_console +.Nd selection of a console device in the x86 bootloader +.\" +.Sh DESCRIPTION +The +.Nx +x86 bootloader selects a console device for its user interaction and +passes information about it to the +.Nx +kernel. +When booting from the system BIOS, the console device and properties +are saved in the primary bootstrap by +.Xr installboot 8 . +For other boot procedures (such as +.Xr x86/dosboot 8 ) +the selection process is controlled by bootloader compile-time +options and system setup at the bootloader startup time. +The selection may be changed on-the-fly from within the bootloader. +.\" +.Ss Serial Console Options +The compile-time options (to be set in the booter's +.Dq Makefile ) +are: +.Bl -ohang +.It Sy SUPPORT_SERIAL= Ns Fa policy +enables support for serial input/output. +By default this option is +not set and the standard PC keyboard and display are always used as the +console device. +See +.Sx Console Selection Policy +below for valid values of +.Fa policy . +.It Sy DIRECT_SERIAL +causes direct hardware access to be used for serial input / output. +With this option, software handshake (XON/XOFF) is used for flow +control. +Without this option, BIOS functions are employed for serial +port handling, which require hardware handshake lines to be completely +wired. +.It Sy CONSPEED= Ns Fa integer +sets the baud-rate for the serial console. +This option has only an effect when used in combination with the +.Dq Dv DIRECT_SERIAL +option above, otherwise, the default setting of 9600 baud is used. +The value of +.Fa integer +must be something that makes sense as a serial port baud rate. +.It Sy COMCONS_KEYPRESS +Require a character input within seven (7) seconds from serial console +device to be selected. +.El +.\" +.Ss Console Selection Policy +The actual policy for the console selection is determined by the value +of +.Dq Dv SUPPORT_SERIAL +The following options are available: +.Bl -ohang +.It Em CONSDEV_PC +Force use of the standard PC keyboard and display as the console. +.It Em CONSDEV_COM0 Li ... Em CONSDEV_COM3 +Use the serial port with the corresponding BIOS number as the console. +No attempt is made to verify connectivity on the selected port. +If the port is not known to the BIOS, it falls back to +.Dq Dv CONSDEV_PC . +(Note: This feature can be deliberately used for console selection if +the serial ports have been disabled in the BIOS.) +.It Em CONSDEV_COM0KBD Li ... Em CONSDEV_COM3KBD +If the port is known to the BIOS, and output of a character to the port +succeeds (and if +.Dq Dv DIRECT_SERIAL +is defined the RS-232 +.Dq "modem ready" +status is on after the character is output), the port is used as +console. +If the port is not known to the BIOS, or the test output fails, it falls back +to +.Dq Dv CONSDEV_PC . +.It Em CONSDEV_AUTO +Auto-select the console. +All serial ports known to the BIOS are probed in sequence. +If output of a character to the port succeeds (and if +.Dq Dv DIRECT_SERIAL +is defined the RS-232 +.Dq "modem ready" +status is on after the character is output), the port is used as console. +If no serial port passes the check, +.Dq Dv CONSDEV_PC +is used. +The progress of the selection process is shown at the PC display as +digits corresponding to the serial port number currently probed. +.El +.\" +.Sh FILES +.Bl -tag -width src/sys/arch/i386/stand/{boot,pxeboot}/Makefile +.It Pa src/sys/arch/i386/stand/{boot,pxeboot}/Makefile +compile time options for the boot programs. +.El +.\" +.Sh SEE ALSO +.Xr console 4 , +.Xr installboot 8 , +.Xr x86/boot 8 +.\" +.Sh BUGS +The serial communication parameters (byte-size, parity, stop-bits) are +not settable (either at compile time or run time). +The default parameters are +.Dq "8 N 1" . +.Pp +The baud rate is not settable when using BIOS I/O. +It should be settable at compile time with +.Dq Dv CONSPEED +just as it is when using +.Dq Dv DIRECT_SERIAL . +The default speed is 9600 baud (the maximum for BIOS I/O). diff --git a/static/netbsd/man8/bootmini2440.8 b/static/netbsd/man8/bootmini2440.8 new file mode 100644 index 00000000..dbf816b0 --- /dev/null +++ b/static/netbsd/man8/bootmini2440.8 @@ -0,0 +1,179 @@ +.\" $NetBSD: bootmini2440.8,v 1.4 2012/06/02 14:04:34 njoly Exp $ +.\" +.\" Copyright (c) 2012 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Paul Fleischer . +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd January 31, 2012 +.Dt BOOTMINI2440 8 evbarm +.Os +.Sh NAME +.Nm bootmini2440 +.Nd bootloader for FriendlyARM MINI2440 evaluation board +.Sh DESCRIPTION +.Nm +is a program to load +.Tn ELF +.Nx +kernel, which works on top of +.Tn U-Boot . +It loads and executes a kernel from an SD memory card, or over +the network using the +.Tn NFS/TFTP +protocol. +.Pp +The +.Nm +bootloader can be loaded anywhere by +.Tn U-Boot , +although care should be taken that the bootloader can load the +.Nx +kernel without overwriting itself. +The kernel is, by default, made to be loaded at 0x30200000. +The recommended location for +.Nm +is 0x30A00000. +.Pp +.Nm +takes a number of arguments, which all are optional: +.Dl Ar mac=xx:xx:xx:xx:xx:xx Ar opt1 ... Ar optN Ar bootname +.Bl -tag -width xx +.It Va mac= +is used to set the MAC-address of the on-board DM9000 Ethernet +chip. +As Mini2440 has no EEPROM to store DM9000 MAC-address, this +is necessary in order to have a working Ethernet controller. +If this argument is left unspecified, a default value of 08:08:11:18:12:27 +is used. +.It Va opt1 ... Va optN +is one of single, kdb, ask, quiet, or verbose. +Their meaning is described in +.Xr boothowto 9 . +.It Va bootname +is one of the following: +.Pp +.Dl net: Ns Ar ip Ns : Ns Ar filename +.Dl net: Ns Ar filename +.Dl net: +.Dl tftp: Ns Ar filename +.Dl tftp: +.Dl ld0 Ns Ar p : Ns Ar filename +.Dl ld0 Ns Ar p : +.Pp +.Bl -tag -width xx +.It net: Ns Va ip Ns : Ns Va filename +use +.Tn DHCP +to determine own IP-address and load kernel specified by +.Ar filename +from the server specified by +.Ar ip +using +.Tn NFS . +.It net: Ns Ar filename +use +.Tn DHCP +to determine own IP-address and server IP-address. +Load kernel specified by +.Ar filename +from the server using +.Tn NFS . +.It net: +use +.Tn DHCP +to determine own IP-address, server IP-address, and kernel to load. +Load the kernel using +.Tn NFS . +.It tftp: Ns Ar filename +use +.Tn DHCP +to determine own IP-address and server IP-address. +Load kernel specified by +.Ar filename +from the server using +.Tn TFTP . +.It tftp: +use +.Tn DHCP +to determine own IP-address, server IP-address, and kernel to load. +Load kernel using +.Tn TFTP . +.It ld0 Ns Va p : Ns Va filename +load kernel from an SD card. +The kernel specified by +.Ar filename +is attempted loaded on the partition given by +.Ar p . +.It ld0 Ns Va p : +load kernel from an SD card. +The kernel will be loaded from the file +.Dq Pa netbsd +on the partition specified by +.Ar p . +.El +.El +.Sh EXAMPLES +.Ss Loading Nm +Use +.Tn U-Boot +to load +.Nm +at 0x30A00000 from an +.Tn NFS +share: +.Dl Uboot> nfs 30A00000 10.0.0.1:/srv/mini2440/bootmini2440 +.Ss Booting Nx +Load the kernel from an +.Tn NFS +share, overwriting the default MAC-address, and +booting into single user-mode: +.Dl Uboot> go 30A00000 single mac=08:08:11:20:22:30 net:10.0.0.1:/srv/mini2440/netbsd +.Pp +Load the kernel from an SD card, overwriting the default +MAC-address, and booting into single user-mode: +.Dl Uboot> go 30A00000 single mac=08:08:11:20:22:30 ld0a:netbsd +.Sh SEE ALSO +.Xr dhcpd 8 , +.Xr diskless 8 , +.Xr nfsd 8 , +.Xr tftpd 8 , +.Xr boothowto 9 +.Sh HISTORY +The +.Nx Ns Tn /evbarm +.Nm +first appeared in +.Nx 6.0 . +.Sh BUGS +.Nm +cannot currently function properly without +.Tn U-Boot +(or equivalent). +Although it performs clock and +.Tn UART +configuration, it cannot bootstrap itself from +.Tn NAND +flash. diff --git a/static/netbsd/man8/bootpd.8 b/static/netbsd/man8/bootpd.8 new file mode 100644 index 00000000..570515a9 --- /dev/null +++ b/static/netbsd/man8/bootpd.8 @@ -0,0 +1,305 @@ +.\" Copyright (c) 1988, 1989, 1991 Carnegie Mellon University +.\" +.\" $NetBSD: bootpd.8,v 1.11 2017/07/03 21:35:30 wiz Exp $ +.\" +.TH BOOTPD 8 "November 06, 1993" "Carnegie Mellon University" +.SH NAME +bootpd, bootpgw \- Internet Boot Protocol server/gateway +.SH SYNOPSIS +.B bootpd +[ +.B \-i +.B \-s +.B \-t +timeout +.B \-d +level +.B \-c +chdir\-path +] +[ +.I bootptab +[ +.I dumpfile +] ] +.br +.B bootpgw +[ +.B \-i +.B \-s +.B \-t +timeout +.B \-d +level +] server +.SH DESCRIPTION +.I Bootpd +implements an Internet Bootstrap Protocol (BOOTP) server as defined in +RFC951, RFC1532, and RFC1533. +.I Bootpgw +implements a simple BOOTP gateway which can be used to forward +requests and responses between clients on one subnet and a +BOOTP server (i.e. +.IR bootpd ) +on another subnet. While either +.I bootpd +or +.I bootpgw +will forward BOOTREPLY packets, only +.I bootpgw +will forward BOOTREQUEST packets. +.PP +One host on each network segment is normally configured to run either +.I bootpd +or +.I bootpgw +from +.I inetd +by including one of the following lines in the file +.IR /etc/inetd.conf : +.IP +bootps dgram udp wait root /usr/sbin/bootpd bootpd bootptab +.br +bootps dgram udp wait root /usr/sbin/bootpgw bootpgw server +.PP +This mode of operation is referred to as "inetd mode" and causes +.I bootpd +(or +.IR bootpgw ) +to be started only when a boot request arrives. If it does not +receive another packet within fifteen minutes of the last one +it received, it will exit to conserve system resources. The +.B \-t +option controls this timeout (see OPTIONS). +.PP +It is also possible to run +.I bootpd +(or +.IR bootpgw ) +in "standalone mode" (without +.IR inetd ) +by simply invoking it from a shell like any other regular command. +Standalone mode is particularly useful when +.I bootpd +is used with a large configuration database, where the start up +delay might otherwise prevent timely response to client requests. +(Automatic start up in standalone mode can be done by invoking +.I bootpd +from within +.IR /etc/rc.local , +for example.) +Standalone mode is less useful for +.I bootpgw +which +has very little start up delay because +it does not read a configuration file. +.PP +Either program automatically detects whether it was invoked from inetd +or from a shell and automatically selects the appropriate mode. +The +.B \-s +or +.B \-i +option may be used to force standalone or inetd mode respectively +(see OPTIONS). +.SH OPTIONS +.TP +.BI \-t \ timeout +Specifies the +.I timeout +value (in minutes) that a +.I bootpd +or +.I bootpgw +process will wait for a BOOTP packet before exiting. +If no packets are received for +.I timeout +minutes, then the program will exit. +A timeout value of zero means "run forever". +In standalone mode, this option is forced to zero. +.TP +.BI \-d \ debug\-level +Sets the +.I debug\-level +variable that controls the amount of debugging messages generated. +For example, -d4 or -d 4 will set the debugging level to 4. +For compatibility with older versions of +.IR bootpd , +omitting the numeric parameter (i.e. just -d) will +simply increment the debug level by one. +.TP +.BI \-c \ chdir\-path +Sets the current directory used by +.I bootpd +while checking the existence and size of client boot files. This is +useful when client boot files are specified as relative pathnames, and +.I bootpd +needs to use the same current directory as the TFTP server +(typically /tftpboot). This option is not recognized by +.IR bootpgw . +.TP +.B \-i +Force inetd mode. This option is obsolete, but remains for +compatibility with older versions of +.IR bootpd . +.TP +.B \-s +Force standalone mode. This option is obsolete, but remains for +compatibility with older versions of +.IR bootpd . +.TP +.I bootptab +Specifies the name of the configuration file from which +.I bootpd +loads its database of known clients and client options +.RI ( bootpd +only). +.TP +.I dumpfile +Specifies the name of the file that +.I bootpd +will dump its internal database into when it receives a +SIGUSR1 signal +.RI ( bootpd +only). This option is only recognized if +.I bootpd +was compiled with the -DDEBUG flag. +.TP +.I server +Specifies the name of a BOOTP server to which +.I bootpgw +will forward all BOOTREQUEST packets it receives +.RI ( bootpgw +only). +.SH OPERATION +.PP +Both +.I bootpd +and +.I bootpgw +operate similarly in that both listen for any packets sent to the +.I bootps +port, and both simply forward any BOOTREPLY packets. +They differ in their handling of BOOTREQUEST packets. +.PP +When +.I bootpgw +is started, it determines the address of a BOOTP server +whose name is provided as a command line parameter. When +.I bootpgw +receives a BOOTREQUEST packet, it sets the "gateway address" +and "hop count" fields in the packet and forwards the packet +to the BOOTP server at the address determined earlier. +Requests are forwarded only if they indicate that +the client has been waiting for at least three seconds. +.PP +When +.I bootpd +is started it reads a configuration file, (normally +.IR /etc/bootptab ) +that initializes the internal database of known clients and client +options. This internal database is reloaded +from the configuration file when +.I bootpd +receives a hangup signal (SIGHUP) or when it discovers that the +configuration file has changed. +.PP +When +.I bootpd +receives a BOOTREQUEST packet, it +.\" checks the modification time of the +.\" configuration file and reloads the database if necessary. Then it +looks for a database entry matching the client request. +If the client is known, +.I bootpd +composes a BOOTREPLY packet using the database entry found above, +and sends the reply to the client (possibly using a gateway). +If the client is unknown, the request is discarded +(with a notice if debug > 0). +.PP +If +.I bootpd +is compiled with the -DDEBUG option, receipt of a SIGUSR1 signal causes +it to dump its internal database to the file +.I /etc/bootpd.dump +or the dumpfile specified as a command line parameter. +.PP +During initialization, both programs +determine the UDP port numbers to be used by calling +.I getservbyname +(which normally uses +.IR /etc/services). +Two service names (and port numbers) are used: +.IP +bootps \- BOOTP Server listening port +.br +bootpc \- BOOTP Client destination port +.LP +If the port numbers cannot +be determined using +.I getservbyname +then the values default to bootps=67 and bootpc=68. +.SH FILES +.TP 20 +/etc/bootptab +Database file read by +.IR bootpd . +.TP +/etc/bootpd.dump +Debugging dump file created by +.IR bootpd . +.TP +/etc/services +Internet service numbers. +.TP +/tftpboot +Current directory typically used by the TFTP server and +.IR bootpd . + +.SH BUGS +Individual host entries must not exceed 1024 characters. + +.SH CREDITS +.PP +This distribution is currently maintained by +Walter L. Wimer . +.PP +The original BOOTP server was created by +Bill Croft at Stanford University in January 1986. +.PP +The current version of +.I bootpd +is primarily the work of David Kovar, +Drew D. Perkins, and Walter L. Wimer, +at Carnegie Mellon University. +.TP +Enhancements and bug\-fixes have been contributed by: +(in alphabetical order) +.br +Danny Backx +.br +John Brezak +.br +Frank da Cruz +.br +David R. Linn +.br +Jim McKim +.br +Gordon W. Ross +.br +Jason Zions +.SH "SEE ALSO" +.LP +bootptab(5), inetd(8), tftpd(8) +.LP +DARPA Internet Request For Comments: +.TP 10 +RFC951 +Bootstrap Protocol +.TP 10 +RFC1532 +Clarifications and Extensions for the Bootstrap Protocol +.TP 10 +RFC1533 +DHCP Options and BOOTP Vendor Extensions diff --git a/static/netbsd/man8/bootpef.8 b/static/netbsd/man8/bootpef.8 new file mode 100644 index 00000000..0b33fc8b --- /dev/null +++ b/static/netbsd/man8/bootpef.8 @@ -0,0 +1,54 @@ +.\" $NetBSD: bootpef.8,v 1.2 1998/01/09 08:09:03 perry Exp $ +.\" +.\" bootpef.8 +.TH BOOTPEF 8 "4 Dec 1993" "MAINTENANCE COMMANDS" +.SH NAME +bootpef \- BOOTP Extension File compiler +.SH SYNOPSIS +.LP +.B bootpef +.RI [ "-c chdir" ] +.RI [ "-d debug-level" ] +.RI [ "-f config-file" ] +.RI [ client-name " [...]]" +.SH DESCRIPTION +.B bootpef +builds the +.I Extension Path +files described by RFC 1497 (tag 18). +If any +.I client-name +arguments are specified, then +.I bootpef +compiles the extension files for only those clients. +.SH OPTIONS +.TP +.BI \-c \ chdir\-path +Sets the current directory used by +.I bootpef +while creating extension files. This is useful when the +extension file names are specified as relative pathnames, and +.I bootpef +needs to use the same current directory as the TFTP server +(typically /tftpboot). +.TP +.BI \-d \ debug\-level +Sets the +.I debug\-level +variable that controls the amount of debugging messages generated. +For example, -d4 or -d 4 will set the debugging level to 4. +.TP +.BI \-f \ config\-file +Set the name of the config file that specifies the option +data to be sent to each client. +.SH "SEE ALSO" +bootpd(8), tftpd(8) +.SH REFERENCES +.TP +RFC951 +BOOTSTRAP PROTOCOL (BOOTP) +.TP +RFC1497 +BOOTP Vendor Information Extensions + + diff --git a/static/netbsd/man8/bootpref.8 b/static/netbsd/man8/bootpref.8 new file mode 100644 index 00000000..ab6b1368 --- /dev/null +++ b/static/netbsd/man8/bootpref.8 @@ -0,0 +1,197 @@ +.\" $NetBSD: bootpref.8,v 1.13 2017/02/17 22:30:28 christos Exp $ +.\" +.\" Copyright (c) 1998 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Julian Coleman. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 17, 2017 +.Dt BOOTPREF 8 atari +.Os +.Sh NAME +.Nm bootpref +.Nd set NVRAM boot preference +.Sh SYNOPSIS +.Nm bootpref +.Op -v +.Op -b os +.Op -d delay +.Op -l lang +.Op -k kbd +.Op -s id +.Op -f fmt +.Op -1 +.Op -2 +.Op -e sep +.Op -c colours +.Op -n +.Op -p +.Op -t +.Op -v +.Op -4 +.Op -8 +.Op -o +.Op -O +.Op -x +.Op -X +.Op -i +.Op -I +.Sh DESCRIPTION +.Nm bootpref +views and sets the NVRAM boot preferences. +.Pp +The program options are: +.Bl -tag -width Ar +.It Fl V +verbose output (when setting preferences) +.It Fl b Ar netbsd +set the boot OS to +.Nx +.It Fl b Ar tos +set the boot OS to TOS +.It Fl b Ar linux +set the boot OS to Linux +.It Fl b Ar systemv +set the boot OS to System V +.It Fl b Ar none +set the boot OS to none +.It Fl d Ar delay +set the boot delay to +.Ar delay +seconds, where +.Ar delay +is a value between 0 and 255 +.It Fl l Ar english +set the language to English +.It Fl l Ar german +set the language to German +.It Fl l Ar french +set the language to French +.It Fl l Ar spanish +set the language to Spanish +.It Fl l Ar italian +set the language to Italian +.It Fl k Ar american +set the keyboard layout to American +.It Fl k Ar german +set the keyboard layout to German +.It Fl k Ar french +set the keyboard layout to French +.It Fl k Ar british +set the keyboard layout to British +.It Fl k Ar spanish +set the keyboard layout to Spanish +.It Fl k Ar italian +set the keyboard layout to Italian +.It Fl k Ar sw f +.It Fl k Ar swiss french +set the keyboard layout to Swiss (French) +.It Fl k Ar sw g +.It Fl k Ar swiss german +set the keyboard layout to Swiss (German) +.It Fl s Ar id +set the SCSI id to +.Ar id , +where +.Ar id +is a value between 0 and 7 +.It Fl f Ar mmddyy +.It Fl f Ar ddmmyy +.It Fl f Ar yymmdd +.It Fl f Ar yyddmm +set the date format +.It Fl 1 +set the date format to 12 hour clock +.It Fl 2 +set the date format to 24 hour clock +.It Fl e Ar sep +set the date format separator to +.Ar sep +.It Fl c Ar colours +set the number of +.Ar colours +- 2, 4, 16, 256 or 65535 +.It Fl n +set the video mode to +.Ar NTSC +.It Fl p +set the video mode to +.Ar PAL +.It Fl t +set the video mode to +.Ar TV +.It Fl v +set the video mode to +.Ar VGA +.It Fl 4 +set the video mode to +.Ar 40 columns +.It Fl 8 +set the video mode to +.Ar 80 columns +.It Fl o +set the video mode to +.Ar overscan +.It Fl O +set the video mode to +.Ar no overscan +.It Fl x +set the video mode to +.Ar ST compatibility +.It Fl X +set the video mode to +.Ar no ST compatibility +.It Fl i +set the video mode to +.Ar interlace +(TV), +.Ar double line +(VGA) +.It Fl I +set the video mode to +.Ar no interlace/double line +.El +.Pp +All strings can be specified by their shortest abbreviation +.Pp +If no parameters are specified, +.Nm bootpref +shows the current boot preferences. +.Sh SEE ALSO +.Xr atari/installboot 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 1.4 . +.Sh AUTHORS +.An Julian Coleman +.Sh BUGS +Setting the boot OS to +.Ar none +will cause the machine not to boot from the hard disk. +.Pp +The majority of the parameters are not used under +.Nx . diff --git a/static/netbsd/man8/bootptest.8 b/static/netbsd/man8/bootptest.8 new file mode 100644 index 00000000..18ee4d1f --- /dev/null +++ b/static/netbsd/man8/bootptest.8 @@ -0,0 +1,73 @@ +.\" $NetBSD: bootptest.8,v 1.5 2017/07/03 21:35:30 wiz Exp $ +.\" bootptest.8 +.TH BOOTPTEST 8 "10 June 1993" "MAINTENANCE COMMANDS" +.SH NAME +bootptest \- send BOOTP queries and print responses +.SH SYNOPSIS +.LP +.B bootptest +[ +.B \-f +.I bootfile +] +[ +.B \-h +] +[ +.B \-m +.I magic_number +] +.I server\-name +.RI [ template-file ] +.SH DESCRIPTION +.B bootptest +sends BOOTP requests to the host specified as +.I server\-name +at one\-second intervals until either a response is received, +or until ten requests have gone unanswered. +After a response is received, +.B bootptest +will wait one more second listening for additional responses. +.SH OPTIONS +.TP +.BI \-f \ bootfile +Fill in the boot file field of the request with +.IR bootfile . +.TP +.B \-h +Use the hardware (Ethernet) address to identify the client. +By default, the IP address is copied into the request +indicating that this client already knows its IP address. +.TP +.BI \-m \ magic_number +Initialize the first word of the vendor options field with +.IR magic_number . +.LP +A +.I template-file +may be specified, in which case +.B bootptest +uses the (binary) contents of this file to initialize the +.I options +area of the request packet. +.SH CREDITS +.LP +The bootptest program is a combination of original and derived works. +The main program module (bootptest.c) is original work by +Gordon W. Ross . +The packet printing module (print-bootp.c) is a slightly modified +version of a file from the BSD tcpdump program. +.LP +This program includes software developed by the University of +California, Lawrence Berkeley Laboratory and its contributors. +(See the copyright notice in print-bootp.c) +.SH "SEE ALSO" +.LP +bootpd(8) +.SH REFERENCES +.TP +RFC951 +BOOTSTRAP PROTOCOL (BOOTP) +.TP +RFC1048 +BOOTP Vendor Information Extensions diff --git a/static/netbsd/man8/bounce.8 b/static/netbsd/man8/bounce.8 new file mode 100644 index 00000000..1b63faf1 --- /dev/null +++ b/static/netbsd/man8/bounce.8 @@ -0,0 +1,192 @@ +.\" $NetBSD: bounce.8,v 1.5 2025/02/25 19:15:42 christos Exp $ +.\" +.TH BOUNCE 8 +.ad +.fi +.SH NAME +bounce +\- +Postfix delivery status reports +.SH "SYNOPSIS" +.na +.nf +\fBbounce\fR [generic Postfix daemon options] +.SH DESCRIPTION +.ad +.fi +The \fBbounce\fR(8) daemon maintains per\-message log files with +delivery status information. Each log file is named after the +queue file that it corresponds to, and is kept in a queue subdirectory +named after the service name in the \fBmaster.cf\fR file (either +\fBbounce\fR, \fBdefer\fR or \fBtrace\fR). +This program expects to be run from the \fBmaster\fR(8) process +manager. + +The \fBbounce\fR(8) daemon processes two types of service requests: +.IP \(bu +Append a recipient (non\-)delivery status record to a per\-message +log file. +.IP \(bu +Enqueue a delivery status notification message, with a copy +of a per\-message log file and of the corresponding message. +When the delivery status notification message is +enqueued successfully, the per\-message log file is deleted. +.PP +The software does a best notification effort. A non\-delivery +notification is sent even when the log file or the original +message cannot be read. + +Optionally, a bounce (defer, trace) client can request that the +per\-message log file be deleted when the requested operation fails. +This is used by clients that cannot retry transactions by +themselves, and that depend on retry logic in their own client. +.SH "STANDARDS" +.na +.nf +RFC 822 (ARPA Internet Text Messages) +RFC 2045 (Format of Internet Message Bodies) +RFC 2822 (Internet Message Format) +RFC 3462 (Delivery Status Notifications) +RFC 3464 (Delivery Status Notifications) +RFC 3834 (Auto\-Submitted: message header) +RFC 5322 (Internet Message Format) +RFC 6531 (Internationalized SMTP) +RFC 6532 (Internationalized Message Format) +RFC 6533 (Internationalized Delivery Status Notifications) +.SH DIAGNOSTICS +.ad +.fi +Problems and transactions are logged to \fBsyslogd\fR(8) +or \fBpostlogd\fR(8). +.SH "CONFIGURATION PARAMETERS" +.na +.nf +.ad +.fi +Changes to \fBmain.cf\fR are picked up automatically, as \fBbounce\fR(8) +processes run for only a limited amount of time. Use the command +"\fBpostfix reload\fR" to speed up a change. + +The text below provides only a parameter summary. See +\fBpostconf\fR(5) for more details including examples. +.IP "\fB2bounce_notice_recipient (postmaster)\fR" +The recipient of undeliverable mail that cannot be returned to +the sender. +.IP "\fBbackwards_bounce_logfile_compatibility (yes)\fR" +Produce additional \fBbounce\fR(8) logfile records that can be read by +Postfix versions before 2.0. +.IP "\fBbounce_notice_recipient (postmaster)\fR" +The recipient of postmaster notifications with the message headers +of mail that Postfix did not deliver and of SMTP conversation +transcripts of mail that Postfix did not receive. +.IP "\fBbounce_size_limit (50000)\fR" +The maximal amount of original message text that is sent in a +non\-delivery notification. +.IP "\fBbounce_template_file (empty)\fR" +Pathname of a configuration file with bounce message templates. +.IP "\fBconfig_directory (see 'postconf -d' output)\fR" +The default location of the Postfix main.cf and master.cf +configuration files. +.IP "\fBdaemon_timeout (18000s)\fR" +How much time a Postfix daemon process may take to handle a +request before it is terminated by a built\-in watchdog timer. +.IP "\fBdelay_notice_recipient (postmaster)\fR" +The recipient of postmaster notifications with the message headers +of mail that cannot be delivered within $delay_warning_time time +units. +.IP "\fBdeliver_lock_attempts (20)\fR" +The maximal number of attempts to acquire an exclusive lock on a +mailbox file or \fBbounce\fR(8) logfile. +.IP "\fBdeliver_lock_delay (1s)\fR" +The time between attempts to acquire an exclusive lock on a mailbox +file or \fBbounce\fR(8) logfile. +.IP "\fBipc_timeout (3600s)\fR" +The time limit for sending or receiving information over an internal +communication channel. +.IP "\fBinternal_mail_filter_classes (empty)\fR" +What categories of Postfix\-generated mail are subject to +before\-queue content inspection by non_smtpd_milters, header_checks +and body_checks. +.IP "\fBmail_name (Postfix)\fR" +The mail system name that is displayed in Received: headers, in +the SMTP greeting banner, and in bounced mail. +.IP "\fBmax_idle (100s)\fR" +The maximum amount of time that an idle Postfix daemon process waits +for an incoming connection before terminating voluntarily. +.IP "\fBmax_use (100)\fR" +The maximal number of incoming connections that a Postfix daemon +process will service before terminating voluntarily. +.IP "\fBnotify_classes (resource, software)\fR" +The list of error classes that are reported to the postmaster. +.IP "\fBprocess_id (read\-only)\fR" +The process ID of a Postfix command or daemon process. +.IP "\fBprocess_name (read\-only)\fR" +The process name of a Postfix command or daemon process. +.IP "\fBqueue_directory (see 'postconf -d' output)\fR" +The location of the Postfix top\-level queue directory. +.IP "\fBsyslog_facility (mail)\fR" +The syslog facility of Postfix logging. +.IP "\fBsyslog_name (see 'postconf -d' output)\fR" +A prefix that is prepended to the process name in syslog +records, so that, for example, "smtpd" becomes "prefix/smtpd". +.PP +Available in Postfix 3.0 and later: +.IP "\fBsmtputf8_autodetect_classes (sendmail, verify)\fR" +Detect that a message requires SMTPUTF8 support for the specified +mail origin classes. +.PP +Available in Postfix 3.3 and later: +.IP "\fBservice_name (read\-only)\fR" +The master.cf service name of a Postfix daemon process. +.PP +Available in Postfix 3.6 and later: +.IP "\fBenable_threaded_bounces (no)\fR" +Enable non\-delivery, success, and delay notifications that link +to the original message by including a References: and In\-Reply\-To: +header with the original Message\-ID value. +.PP +Available in Postfix 3.7 and later: +.IP "\fBheader_from_format (standard)\fR" +The format of the Postfix\-generated \fBFrom:\fR header. +.PP +Available in Postfix 3.10 and later: +.IP "\fBtls_required_enable (yes)\fR" +Enable support for the "TLS\-Required: no" message header, defined +in RFC 8689. +.SH "FILES" +.na +.nf +/var/spool/postfix/bounce/* non\-delivery records +/var/spool/postfix/defer/* non\-delivery records +/var/spool/postfix/trace/* delivery status records +.SH "SEE ALSO" +.na +.nf +bounce(5), bounce message template format +qmgr(8), queue manager +postconf(5), configuration parameters +master(5), generic daemon options +master(8), process manager +postlogd(8), Postfix logging +syslogd(8), system logging +.SH "LICENSE" +.na +.nf +.ad +.fi +The Secure Mailer license must be distributed with this software. +.SH "AUTHOR(S)" +.na +.nf +Wietse Venema +IBM T.J. Watson Research +P.O. Box 704 +Yorktown Heights, NY 10598, USA + +Wietse Venema +Google, Inc. +111 8th Avenue +New York, NY 10011, USA + +Wietse Venema +porcupine.org diff --git a/static/netbsd/man8/bozohttpd.8 b/static/netbsd/man8/bozohttpd.8 new file mode 100644 index 00000000..2e9797f7 --- /dev/null +++ b/static/netbsd/man8/bozohttpd.8 @@ -0,0 +1,911 @@ +.\" $NetBSD: bozohttpd.8,v 1.100 2025/04/16 14:18:57 bad Exp $ +.\" +.\" $eterna: bozohttpd.8,v 1.101 2011/11/18 01:25:11 mrg Exp $ +.\" +.\" Copyright (c) 1997-2024 Matthew R. Green +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd November 22, 2024 +.Dt BOZOHTTPD 8 +.Os +.Sh NAME +.Nm bozohttpd +.Nd hyper text transfer protocol version 1.1 daemon +.Sh SYNOPSIS +.Nm +.Op Fl EGHVXdefhnqsu +.Op Fl C Ar suffix cgihandler +.Op Fl I Ar port +.Op Fl L Ar prefix script +.Op Fl M Ar suffix type encoding encoding11 +.Op Fl m Ar version +.Op Fl P Ar pidfile +.Op Fl R Ar readme +.Op Fl S Ar version +.Op Fl T Ar type timeout +.Op Fl U Ar username +.Op Fl Z Ar cert privkey +.Op Fl c Ar cgibin +.Op Fl i Ar address +.Op Fl p Ar pubdir +.Op Fl t Ar chrootdir +.Op Fl v Ar virtualroot +.Op Fl x Ar index +.Op Fl z Ar ciphers +.Ar slashdir +.Op Ar myname +.Sh DESCRIPTION +The +.Nm +program reads a +.Em HTTP +request from the standard input, and sends a reply to the standard output. +Besides ~user translation and virtual hosting support (see below), all file +requests are from +.Ar slashdir +directory. +The server uses +.Ar myname +as its name, which defaults to the local hostname, obtained from +.Xr gethostname 3 +(but see the +.Fl v +option for virtual hosting.) +.Nm +writes logs to +.Xr syslog 3 +using the ftp facility (but see the +.Fl s +option for testing and the +.Fl q +option for suppressing this.) +.Nm +is designed to be small, simple and relatively featureless, +hopefully increasing its security. +.Ss OPTIONS +The following options are available: +.Bl -tag -width xxxcgibin +.It Fl b +Enables stand-alone daemon mode, where +.Nm +detaches from the current terminal and runs in the background +(unless invoked with +.Fl f ) , +listens on the appropriate IP address +(see +.Fl i Ar address ) +and TCP port +(see +.Fl I Ar port ) , +and services HTTP requests. +.Nm +does not use +.Xr inetd 8 +in stand-alone daemon mode. +.It Fl C Ar suffix cgihandler +Adds a new CGI handler program for a particular file type. +The +.Ar suffix +should be any normal file suffix, and the +.Ar cgihandler +should be a full path to an interpreter. +This option is the only way to enable CGI programs that exist +outside of the cgibin directory to be executed. +Multiple +.Fl C +options may be passed. +.It Fl c Ar cgibin +Enables the CGI/1.1 interface. +The +.Ar cgibin +directory is expected to contain the CGI programs to be used. +.Nm +looks for URLs in the form of +.Ql /cgi-bin/ Ns Ar scriptname +where +.Ar scriptname +is a valid CGI program in the +.Ar cgibin +directory. +In other words, all CGI URLs must begin with +.Ql \%/cgi-bin/ . +Note that the CGI/1.1 interface is available with +.Ql ~user +translation using +.Fl E +switch. +.It Fl d +Enables debug support. +.It Fl E +Enables CGI/1.1 interface for +.Ql ~user +translation. +Note that enabling this support implies that users can run commands +as the web server user. +This may have security implications. +.It Fl e +Do not clear the environment when used with either the +.Fl t +or +.Fl U +options. +.It Fl f +Stops the +.Fl b +option from detaching +.Nm +from the tty and going into the background as part of stand-alone daemon mode. +This implies the +.Fl b +option. +.It Fl G +Get the +.Nm +version string, print it on standard output, and exit. +.It Fl H +Changes directory index mode +(see +.Fl X +option) +to hide files and directories that start with a period +.Pq Ql \&. , +except for +.Pa .. . +.It Fl I Ar port +Use +.Ar port +instead of the default +.Dq http +port +(usually 80, see +.Xr services 5 ) . +When used with the +.Fl b +or +.Fl f +options, this option changes the bound port. +Otherwise this option forces redirections to use this port +instead of the value obtained via +.Xr getsockname 2 . +.It Fl i Ar address +Use +.Ar address +as the address to bind to in stand-alone daemon mode. +If this option is not provided, all available IP addresses +will be listened to. +Only the last +.Fl i +option is used. +This option is only valid with the +.Fl b +or +.Fl f +options. +.It Fl L Ar prefix script +Adds a new Lua script for a particular prefix. +The +.Ar prefix +should be an arbitrary text, and the +.Ar script +should be a full path to a Lua script. +Multiple +.Fl L +options may be passed. +A separate Lua state is created for each prefix. +The Lua script can register callbacks using the +.Dl httpd.register_handler('suffixpath', luafunc) +Lua function, +which will trigger the execution of the Lua function +.Fn luafunc +when a URL in the form +.Sm off +.Li http:// Ar hostname Li / Ar prefix Li / Ar suffixpath +.Sm on +is being accessed. +The function is passed three tables as arguments, the server +environment, the request headers, and the decoded query string +plus any data that was sent as application/x-www-form-urlencoded. +.It Fl M Ar suffix type encoding encoding11 +Adds a new entry to the table that converts file suffixes to +content type and encoding. +This option takes four additional arguments containing +the file prefix, its +.Dq Content-Type , +.Dq Content-Encoding , +and +.Dq Content-Encoding +for HTTP/1.1 connections, respectively. +If any of these are a single dash +.Pq Dq - , +the empty string is used instead. +Multiple +.Fl M +options may be passed. +.It Fl m Ar version +Set the minimum supported SSL protocol +.Ar version . +The valid values of +.Ar version +are +.Dq TLSv1.1 , +.Dq TLSv1.2 , +and +.Dq TLSv1.3 . +The default version is +.Dq TLSv1.1 . +.It Fl n +Stops +.Nm +from doing IP address to name resolution of remote hosts. +This affects the +.Ev REMOTE_HOST +environment variable for CGI programs and Lua scripts. +.It Fl P Ar pidfile +Create a PID file in +.Ar pidfile +when run in daemon mode with the +.Fl b +or +.Fl f +options. +.It Fl p Ar pubdir +Changes the default user directory for +.Ql /~user/ +translations from +.Pa public_html +to +.Ar pubdir . +.It Fl q +Quiet mode - no log entries generated. +.It Fl R Ar readme +When directory indexing is enabled +(see +.Fl X +option), +include the contents of the file +.Ar readme +in the footer of the directory index. +.It Fl S Ar version +Sets the internal server version to +.Ar version . +.It Fl s +Forces logging to be set to stderr always. +.It Fl T Ar type timeout +Set the timeout for +.Ar type +to +.Ar timeout . +The valid values of +.Ar type +are +.Dq ssl timeout , +.Dq initial timeout , +.Dq header timeout , +and +.Dq request timeout . +The default values are 30 seconds, 30 seconds, 10 seconds and 600 seconds, +respectively. +.It Fl t Ar chrootdir +Makes +.Nm +chroot to the specified directory +before answering requests. +Every other path should be specified relative +to the new root, if this option is used. +Note that the current environment +is normally replaced with an empty environment with this option, unless the +.Fl e +option is also used. +.It Fl U Ar username +Switch to the user and the groups of +.Ar username +after initialization. +This option, like +.Fl t +above, causes +.Nm +to clear the environment unless the +.Fl e +option is given. +.It Fl u +Enables the transformation of Uniform Resource Locators of +the form +.Ql /~user/ +into the directory +.Pa ~user/public_html +(but see the +.Fl p +option above). +.It Fl V +Sets the backup virtual host directory to the +.Ar slashdir +argument. +If no directory exists in +.Ar virtualroot +for the request, then +.Ar slashdir +will be used. +The default behavior is to return 404 (Not Found.) +.It Fl v Ar virtualroot +Enables virtual hosting support. +Directories in +.Ar virtualroot +will be searched for a matching virtual host name, when parsing +the HTML request. +If a matching name is found, it will be used +as both the server's real name, +.Op Ar myname , +and as the +.Ar slashdir . +See the +.Sx EXAMPLES +section for an example of using this option. +.It Fl X +Enables directory indexing. +A directory index will be generated only when the default +index file is not present +(i.e., +.Pa index.html +unless changed with +.Fl x Ar index ) . +.It Fl x Ar index +Changes the default file read for directories from +.Pa index.html +to +.Ar index . +.It Fl Z Ar certificate_path privatekey_path +Sets the path to the server certificate file and the private key file +in PEM format. +This option also causes +.Nm +to start SSL mode. +.It Fl z Ar ciphers +Sets the list of SSL ciphers (see +.Xr SSL_CTX_set_cipher_list 3 ) . +.El +.Pp +Note that in +.Nm +versions 20031005 and prior that supported the +.Fl C +and +.Fl M +options, they took a single space-separated argument that was parsed. +since version 20040828, they take multiple options (2 in the case of +.Fl C +and 4 in the case of +.Fl M . ) +.Ss INETD CONFIGURATION +By default +.Nm +uses +.Xr inetd 8 +to process incoming TCP connections for HTTP requests +(unless stand-alone daemon mode is enabled with the +.Fl b +or +.Fl f +options), +.Nm +has little internal networking knowledge. +(Indeed, you can run +.Nm +on the command line with little change of functionality.) +A typical +.Xr inetd.conf 5 +entry would be: +.Bd -literal +http stream tcp nowait:600 _httpd /usr/libexec/httpd httpd /var/www +http stream tcp6 nowait:600 _httpd /usr/libexec/httpd httpd /var/www +.Ed +.Pp +This would serve web pages from +.Pa /var/www +on both IPv4 and IPv6 ports. +The +.Ql :600 +changes the +requests per minute to 600, up from the +.Xr inetd 8 +default of 40. +.Pp +Using the +.Nx +.Xr inetd 8 , +you can provide multiple IP-address based HTTP servers by having multiple +listening ports with different configurations. +.Ss NOTES +This server supports the +.Em HTTP/0.9 , +.Em HTTP/1.0 , +and +.Em HTTP/1.1 +standards. +Support for these protocols is very minimal and many optional features are +not supported. +.Pp +.Nm +can be compiled without +CGI support (NO_CGIBIN_SUPPORT), +user transformations (NO_USER_SUPPORT), +directory index support (NO_DIRINDEX_SUPPORT), +daemon mode support (NO_DAEMON_MODE), +dynamic MIME content (NO_DYNAMIC_CONTENT), +Lua support (NO_LUA_SUPPORT), +and SSL support (NO_SSL_SUPPORT) +by defining the listed macros when building +.Nm . +.Ss HTTP BASIC AUTHORIZATION +.Nm +has support for HTTP Basic Authorization. +If a file named +.Pa .htpasswd +exists in the directory of the current request, +.Nm +will restrict access to documents in that directory +using the RFC 2617 HTTP +.Dq Basic +authentication scheme. +.Pp +Note: +This does not recursively protect any sub-directories. +.Pp +The +.Pa .htpasswd +file contains lines delimited with a colon containing +user names and passwords hashed with +.Xr crypt 3 , +for example: +.Bd -literal +heather:$1$pZWI4tH/$DzDPl63i6VvVRv2lJNV7k1 +jeremy:A.xewbx2DpQ8I +.Ed +.Pp +On +.Nx , +the +.Xr pwhash 1 +utility may be used to generate hashed passwords. +.Pp +While +.Nm +distributed with +.Nx +has support for HTTP Basic Authorization enabled by default, +in the portable distribution this feature is disabled. +Compile +.Nm +with +.Dq -DDO_HTPASSWD +on the compiler command line to enable this support. +This may require linking with the crypt library, using +.Dq -lcrypt . +.Ss BLOCKLIST SUPPORT +On +.Nx , +.Nm +supports +.Xr blocklistd 8 +by default. +The support can be disabled with the +.Dq -DNO_BLOCKLIST_SUPPORT +compilation option. +.Pp +Upon occurrence, +.Nm +reports two HTTP status codes to +.Xr blocklistd 8 +as failures: +.Er 401 +(``Unauthorized'') +and +.Er 403 +(``Forbidden'') . +Of these, +.Er 401 +is the one received upon authorization failure with the +HTTP Basic Authorization mechanism. +A successful authorization decreases the counter kept by +.Xr blocklistd 8 . +.Pp +Note that the implementation of the HTTP Basic Authorization mechanism +uses a redirection; a status code +.Er 401 +is always initially received. +Therefore, a single authorization failure of +.Pa .htpasswd +is reported as two failures to +.Xr blocklistd 8 , +but no failures are recorded upon successful authorization +due to the decrease of the failure counter. +.Ss SSL SUPPORT +.Nm +has support for TLSv1.1 and TLSv1.2 protocols that are included by +default. +This requires linking with the crypto and ssl library, using +.Dq -lcrypto -lssl . +To disable SSL SUPPORT compile +.Nm +with +.Dq -DNO_SSL_SUPPORT +on the compiler command line. +.Pp +To have an enforced redirect, such as http to https, create a shadow +directory root that contains a +.Pa .bzabsredirect +file that points to the real target. +.Ss COMPRESSION +.Nm +supports a very basic form of compression. +.Nm +will serve the requested file postpended with +.Dq Pa .gz +if it exists, it is readable, the client requested gzip compression, and +the client did not make a ranged request. +.Sh FILES +.Nm +processes specific files in each directory that +enables certain features on a per-directory basis. +These per-directory files are: +.Bl -tag -width .htpasswd +.It Pa .bzabsredirect +Symbolic link to the absolute URL pointed to by this symlink. +This is useful to redirect to different servers. +See +.Sx SYMBOLIC LINK REDIRECTION . +.It Pa .bzredirect +Symbolic link to URL for +.Nm +to perform a smart redirect to the target of this symlink. +The target is assumed to live on the same server. +If target starts with slash then absolute redirection is performed, +otherwise it is handled as relative. +See +.Sx SYMBOLIC LINK REDIRECTION . +.It Pa .bzremap +Used by rewrite mappings; see +.Sx REWRITE MAPPINGS . +.It Pa .htpasswd +Used by HTTP basic authorization; see +.Sx HTTP BASIC AUTHORIZATION . +.El +.Ss SYMBOLIC LINK REDIRECTION +Two forms of redirection are supported: +.Bl -enum +.It +A symbolic link without schema will use +.Li http:// +as default. +E.g., a symbolic link to +.Pa NetBSD.org +will redirect to +.Lk http://NetBSD.org/ . +.It +A symbolic link with a schema uses the provided schema. +E.g., a symbolic link to +.Pa ftp://NetBSD.org/ +will redirect to +.Lk ftp://NetBSD.org/ . +.El +.Ss REWRITE MAPPINGS +If a +.Pa .bzremap +file is found at the root of a (virtual) server, it is expected to contain +rewrite mappings for URLs. +.Pp +These remappings are performed internally in the server before authentication +happens and can be used to hide implementation details, like the CGI handler +specific suffix for non cgi scripts in authorized directories. +.Pp +The map file consists of lines two paths separated by a colon, where the left +side needs to exactly match a (sub) path of the request and will be replaced +by the right side. +.Pp +The first match always wins. +.Pp +A +.Pa .bzremap +file could look like this: +.Bd -literal +/nic/update:/auth-dir/updipv4.pl +.Ed +.Pp +The remap file should be short, access to it is slow and needs to happen +on each request. +If a request path needs to include a colon +.Pq Ql \&: +character, it can be escaped +with a backslash +.Pq Ql \e +The right hand side of the colon is always used verbatim, no escape sequences +are interpreted. +.Sh EXAMPLES +To configure set of virtual hosts, one would use an +.Xr inetd.conf 5 +entry like: +.Bd -literal +http stream tcp nowait:600 _httpd /usr/libexec/httpd httpd -v /var/vroot /var/www +.Ed +.Pp +and inside +.Pa /var/vroot +create a directory (or a symlink to a directory) with the same name as +the virtual host, for each virtual host. +Lookups for these names are done in a case-insensitive manner, and may +include the port number part of the request, allowing for distinct +virtual hosts on the same name. +.Pp +To use +.Nm +with PHP, one must use the +.Fl C +option to specify a CGI handler for a particular file type. +Typically this will be like: +.Bd -literal +httpd -C .php /usr/pkg/bin/php-cgi /var/www +.Ed +.Pp +Note that a plain script interpreter can not be used directly as a cgihandler, +as there are no command line options passed from +.Nm +to avoid security issues. +.Pp +If no CGI-aware wrapper exists, a simple shell script like the following +might do. +.Pp +It would be invoked like: +.Bd -literal +httpd -C .pl /www-scripts/bin/run.perl /var/www +.Ed +and the script could look like: +.Bd -literal +#! /bin/sh + +if [ -r "$SCRIPT_FILENAME" -a -x "$SCRIPT_FILENAME" ]; then + exec /usr/pkg/bin/perl "$SCRIPT_FILENAME" +fi + +exit 1 +.Ed +.Sh SEE ALSO +.Xr inetd.conf 5 , +.Xr services 5 , +.Xr inetd 8 +.Sh HISTORY +.Nm +was first written in perl, based on another perl http server +called +.Dq tinyhttpd . +It was then rewritten from scratch in perl, and then once again in C. +From +.Dq bozohttpd +version 20060517, it has been integrated into +.Nx . +The focus has always been simplicity and security, with minimal features +and regular code audits. +This manual documents +.Nm +version 20240428. +.Sh AUTHORS +.An -nosplit +.Nm +was written by +.An Matthew R. Green +.Aq Mt mrg@eterna23.net . +.Pp +The large list of contributors includes: +.Bl -dash +.It +.An Christoph Badura +.Aq Mt bad@bsd.de +provided Range: header support +.It +.An Marc Balmer +.Aq Mt mbalmer@NetBSD.org +added Lua support for dynamic content creation +.It +.An Sean Boudreau +.Aq Mt seanb@NetBSD.org +provided a security fix for virtual hosting +.It +.An Julian Coleman +.Aq Mt jdc@coris.org.uk +provided an IPv6 bugfix +.It +.An Chuck Cranor +.Aq Mt chuck@research.att.com +provided cgi-bin support fixes, and more +.It +.An Alistair G. Crooks +.Aq Mt agc@NetBSD.org +cleaned up many internal interfaces, made +.Nm +linkable as a library and provided the Lua binding +.It +.An DEGROOTE Arnaud +.Aq Mt degroote@NetBSD.org +provided a fix for daemon mode +.It +.An Andrew Doran +.Aq Mt ad@NetBSD.org +provided directory indexing support +.It +.An Roland Dowdeswell +.Aq Mt elric@NetBSD.org +added support for serving gzipped files and better SSL handling +.It +.An Per Ekman +.Aq Mt pek@pdc.kth.se +provided a fix for a minor (non-security) buffer overflow condition +.It +.Aq Mt emily@ingalls.rocks +provided fixes for some bad request parsing +.It +.An Jun-ichiro itojun Hagino, KAME +.Aq Mt itojun@iijlab.net +provided initial IPv6 support +.It +.An Martin Husemann +.Aq Mt martin@NetBSD.org +provided .bzabsredirect and .bzredir support, fixed various +redirection issues and more +.It +.An Arto Huusko +.Aq Mt arto.huusko@pp2.inet.fi +provided fixes cgi-bin +.It +.An Roland Illig +.Aq Mt roland.illig@gmx.de +provided some off-by-one fixes +.It +.An Zak Johnson +.Aq Mt zakj@nox.cx +provided cgi-bin enhancements +.It +.An Nicolas Jombart +.Aq Mt ecu@ipv42.net +provided fixes for HTTP basic authorization support +.It +.An Antti Kantee +.Aq Mt pooka@NetBSD.org +provided fixes for HTTP basic authorization support +.It +.An Thomas Klausner +.Aq Mt wiz@NetBSD.org +provided many fixes and enhancements for the man page +.It +.An Mateusz Kocielski +.Aq Mt shm@NetBSD.org +fixed memory leaks, various issues with userdir support, +information disclosure issues, added support for using CGI handlers +with directory indexing, found several security issues and provided +various other fixes +.It +.An Arnaud Lacombe +.Aq Mt alc@NetBSD.org +provided some clean up for memory leaks +.It +.An Johnny Lam +.Aq Mt jlam@NetBSD.org +provided man page fixes +.It +.An Dennis Lindroos +.Aq Mt denafcm@gmail.com +provided a cgi-bin fix +.It +.An Jared McNeill +.Aq Mt jmcneill@NetBSD.org +added support for readme in directory indexing +.It +.An Julio Merino +.Aq Mt jmmv@NetBSD.org +Added the +.Fl P +option (pidfile support) and provided some man page fixes +.It +.An Luke Mewburn +.Aq Mt lukem@NetBSD.org +provided many various fixes, including cgi-bin fixes and enhancements, +HTTP basic authorization support and much code clean up +.It +.An Sunil Nimmagadda +.Aq Mt sunil@nimmagadda.net +provided runtime TLS version control +.It +.An Rajeev V. Pillai +.Aq Mt rajeev_v_pillai@yahoo.com +provided several fixes for virtual hosting and directory indexing and +fixes for CGI +.It +.An Jeremy C. Reed +.Aq Mt reed@NetBSD.org +provided several clean up fixes, and man page updates +.It +.An Scott Reynolds +.Aq Mt scottr@NetBSD.org +provided various fixes +.It +.An Tyler Retzlaff +.Aq Mt rtr@eterna23.net +provided SSL support, cgi-bin fixes and much other random other stuff +.It +.An rudolf +.Aq Mt netbsd@eq.cz +provided minor compile fixes and a CGI content map fix +.It +.An Steve Rumble +.Aq Mt rumble@ephemeral.org +provided the +.Fl V +option +.It +.An Jukka Ruohonen +.Aq Mt jruoho@NetBSD.org +provided support for +.Xr blocklistd 8 +.It +.An Thor Lancelot Simon +.Aq Mt tls@NetBSD.org +enhanced cgi-bin support +.It +.An Joerg Sonnenberger +.Aq Mt joerg@NetBSD.org +implemented If-Modified-Since support +.It +.An Kimmo Suominen +.Aq Mt kim@NetBSD.org +removed obsolete +.Pa .bzdirect +handling +.It +.An ISIHARA Takanori +.Aq Mt ishit@oak.dti.ne.jp +provided a man page fix +.It +.An Holger Weiss +.Aq Mt holger@CIS.FU-Berlin.DE +provided http authorization fixes +.It +.Aq Mt xs@kittenz.org +provided chroot and change-to-user support, and other various fixes +.It +.An S.P.Zeidler +.Aq Mt spz@NetBSD.org +fixed several SSL shutdown issues +.It +Coyote Point provided various CGI fixes +.El +.Pp +There are probably others I have forgotten (let me know if you care) +.Pp +Please send all updates to +.Nm +to +.Aq Mt mrg@eterna23.net +or +.Aq Mt netbsd-bugs@NetBSD.org +for inclusion in future releases. +.Sh BUGS +.Nm +does not handle HTTP/1.1 chunked input from the client yet. diff --git a/static/netbsd/man8/brconfig.8 b/static/netbsd/man8/brconfig.8 new file mode 100644 index 00000000..f79887ac --- /dev/null +++ b/static/netbsd/man8/brconfig.8 @@ -0,0 +1,295 @@ +.\" $NetBSD: brconfig.8,v 1.22 2024/09/03 10:42:58 uwe Exp $ +.\" +.\" Copyright 2001 Wasabi Systems, Inc. +.\" All rights reserved. +.\" +.\" Written by Jason R. Thorpe for Wasabi Systems, Inc. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed for the NetBSD Project by +.\" Wasabi Systems, Inc. +.\" 4. The name of Wasabi Systems, Inc. may not be used to endorse +.\" or promote products derived from this software without specific prior +.\" written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd August 29, 2024 +.Dt BRCONFIG 8 +.Os +.Sh NAME +.Nm brconfig +.Nd configure network bridge parameters +.Sh SYNOPSIS +.Nm +.Fl a +.Nm +.Ar bridge +.Nm +.Ar bridge +.Ar command +.Op Ar args ... +.Sh DESCRIPTION +The +.Nm +utility is used to configure network bridge parameters and retrieve +network bridge parameters and status from the kernel. +The bridging function is implemented by the +.Xr bridge 4 +driver. +.Pp +A network bridge creates a logical link between two or more +IEEE 802 networks that use the same (or +.Dq similar enough ) +framing format. +For example, it is possible to bridge Ethernet +and 802.11 networks together, but it is not possible to bridge +Ethernet and Token Ring together. +.Pp +Bridge interfaces are created using the +.Xr ifconfig 8 +command's +.Cm create +sub-command. +All other bridge configuration is performed using +.Nm . +.Pp +The options are as follows: +.Bl -tag -width Fl +.It Fl a +Display the status of all bridge devices present on the system. +This flag is mutually exclusive with all other sub-commands. +.El +.Pp +All other operations require that a bridge be specified. +If a bridge is specified with no sub-commands, +the status of that bridge is displayed. +The following sub-commands are available: +.Bl -tag -width Cm +.It Cm up +Start forwarding packets on the bridge. +.It Cm down +Stop forwarding packets on the bridge. +.It Cm add Ar interface +Add the interface named by +.Ar interface +as a member of the bridge. +The interface is put into promiscuous mode +so that it can receive every packet sent on the network. +.It Cm delete Ar interface +Remove the interface named by +.Ar interface +from the bridge. +Promiscuous mode is disabled on the interface when +it is removed from the bridge. +.It Cm addr +Display the addresses that have been learned by the bridge. +.It Cm maxaddr Ar size +Set the size of the bridge address cache to +.Ar size . +The default is 100 entries. +.It Cm timeout Ar seconds +Set the timeout of address cache entries to +.Ar seconds +seconds. +If +.Ar seconds +is zero, then address cache entries will not be expired. +The default is 1200 seconds. +.It Cm deladdr Ar address +Delete +.Ar address +from the address cache. +.It Cm flush +Delete all dynamically-learned addresses from the address cache. +.It Cm flushall +Delete all addresses, including static addresses, from the address cache. +.It Cm discover Ar interface +Mark an interface as a +.Dq discovering +interface. +When the bridge has no address cache entry +(either dynamic or static) +for the destination address of a packet, +the bridge will forward the packet to all +member interfaces marked as +.Dq discovering . +This is the default for all interfaces added to a bridge. +.It Cm -discover Ar interface +Clear the +.Dq discovering +attribute on a member interface. +For packets without the +.Dq discovering +attribute, the only packets forwarded on the interface are broadcast +or multicast packets and packets for which the destination address +is known to be on the interface's segment. +.It Cm ipf +Enable packet filtering with +.Xr pfil 9 +on the bridge. +The current implementation passes +all ARP and RARP packets through the bridge +while filtering IP and IPv6 packets through the configured packet +filter, such as +.Xr npf 7 . +Other packet types are blocked. +.It Cm learn Ar interface +Mark an interface as a +.Dq learning +interface. +When a packet arrives on such an interface, the source +address of the packet is entered into the address cache as being a +destination address on the interface's segment. +This is the default for all interfaces added to a bridge. +.It Cm -learn Ar interface +Clear the +.Dq learning +attribute on a member interface. +.It Cm protect Ar interface +Mark an interface as a +.Dq protected +interface. +When a packet arrives on a +.Dq protected +interface and is being forwarded to another +.Dq protected +interface, the packet will be discarded. +.It Cm -protect Ar interface +Clear the +.Dq protected +attribute on a member interface. +.It Cm static Ar interface address +Add a static entry into the address cache pointing to +.Ar interface . +Static entries are never aged out of the cache or replaced, even if the address +is seen on a different interface. +.It Cm stp Ar interface +Enable Spanning Tree protocol on +.Ar interface . +The +.Xr bridge 4 +driver has support for the IEEE 802.1D Spanning Tree protocol (STP). +Spanning Tree is used to detect and remove loops in a network topology. +.It Cm -stp Ar interface +Disable Spanning Tree protocol on +.Ar interface . +This is the default for all interfaces added to a bridge. +.It Cm maxage Ar seconds +Set the time that a Spanning Tree protocol configuration is valid. +The default is 20 seconds. +The minimum is 1 second and the maximum is 255 seconds. +.It Cm fwddelay Ar seconds +Set the time that must pass before an interface begins forwarding +packets when Spanning Tree is enabled. +The default is 15 seconds. +The minimum is 1 second and the maximum is 255 seconds. +.It Cm hellotime Ar seconds +Set the time between broadcasting of Spanning Tree protocol +configuration messages. +The default is 2 seconds. +The minimum is 1 second and the maximum is 255 seconds. +.It Cm priority Ar value +Set the bridge priority for Spanning Tree. +The default is 32768. +Allowed numerical values range from 0 (highest priority) to 65535 +(lowest priority). +.It Cm ifpriority Ar interface Ar value +Set the Spanning Tree priority of +.Ar interface +to +.Ar value . +The default is 128. +The minimum is 0 and the maximum is 255. +.It Cm ifpathcost Ar interface Ar value +Set the Spanning Tree path cost of +.Ar interface +to +.Ar value . +The default is 55. +The minimum is 0 and the maximum is 65535. +.El +.Sh EXAMPLES +The following, when placed in the file +.Pa /etc/ifconfig.bridge0 , +will cause a bridge called +.Ql bridge0 +to be created, add the interfaces +.Ql ray0 +and +.Ql fxp0 +to the bridge, and then enable packet forwarding. +Such a configuration could be used to implement a simple +802.11-to-Ethernet bridge (assuming the 802.11 interface is +in ad-hoc mode). +.Bd -literal -offset indent +create +!brconfig $int add ray0 add fxp0 up +.Ed +.Pp +Consider a system with two 4-port Ethernet boards. +The following placed in the file +.Pa /etc/ifconfig.bridge0 +will cause a bridge consisting of all 8 ports with Spanning Tree +enabled to be created: +.Bd -literal -offset indent +create +!brconfig $int \e + add tlp0 stp tlp0 \e + add tlp1 stp tlp1 \e + add tlp2 stp tlp2 \e + add tlp3 stp tlp3 \e + add tlp4 stp tlp4 \e + add tlp5 stp tlp5 \e + add tlp6 stp tlp6 \e + add tlp7 stp tlp7 \e + up +.Ed +.Sh SEE ALSO +.Xr bridge 4 , +.Xr pf 4 , +.Xr ifconfig.if 5 , +.Xr npf 7 , +.Xr ifconfig 8 , +.Xr pfil 9 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 1.6 . +.Sh AUTHORS +.An -nosplit +The +.Xr bridge 4 +driver and +.Nm +utility were originally written by +.An Jason L. Wright +.Aq jason@thought.net +as part of an undergraduate independent study at the +University of North Carolina at Greensboro. +.Pp +This version of the +.Nm +utility was written from scratch by +.An Jason R. Thorpe +.Aq thorpej@wasabisystems.com . diff --git a/static/netbsd/man8/bta2dpd.8 b/static/netbsd/man8/bta2dpd.8 new file mode 100644 index 00000000..ef574fc1 --- /dev/null +++ b/static/netbsd/man8/bta2dpd.8 @@ -0,0 +1,296 @@ +.\" $NetBSD: bta2dpd.8,v 1.10 2023/07/20 13:31:31 nat Exp $ +.\" +.\" Copyright (c) 2015 - 2016 Nathanial Sloss +.\" All rights reserved. +.\" +.\" This software is dedicated to the memory of - +.\" Baron James Anlezark (Barry) - 1 Jan 1949 - 13 May 2012. +.\" +.\" Barry was a man who loved his music. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd July 20, 2023 +.Dt BTA2DPD 8 +.Os +.Sh NAME +.Nm bta2dpd +.Nd Bluetooth Advanced Audio Distribution Profile daemon +.Sh SYNOPSIS +.Nm +.Op Fl \&Dnv +.Op Fl A Ar bitpool_allocation +.Op Fl B Ar bitpool +.Op Fl b Ar blocks +.Op Fl d Ar device +.Op Fl e Ar encoding_bands +.Op Fl f Ar channel_mode +.Op Fl M Ar mtu +.Op Fl m Ar mode +.Op Fl r Ar rate +.Op Fl V Ar volume +.Fl a Ar address +.Ar files ... +.Nm +.Fl K +.Op Fl DIv +.Op Fl A Ar bitpool_allocation +.Op Fl B Ar bitpool +.Op Fl b Ar blocks +.Op Fl d Ar device +.Op Fl e Ar encoding_bands +.Op Fl f Ar channel_mode +.Op Fl m Ar mode +.Op Fl p Ar psm +.Op Fl r Ar rate +.Op a Ar address +.Ar file +.Nm +.Fl t +.Op Fl A Ar bitpool_allocation +.Op Fl B Ar bitpool +.Op Fl b Ar blocks +.Op Fl e Ar encoding_bands +.Op Fl f Ar channel_mode +.Op Fl M Ar mtu +.Op Fl r Ar rate +.Op Fl V Ar volume +.Ar files ... +.Nm +.Fl t +.Fl K +.Ar file +.Sh DESCRIPTION +The +.Nm +daemon is used to transmit/receive audio to/from Bluetooth devices such as +speakers or headphones, using the Advanced Audio Distribution Profile +(A2DP). +.Bl -tag -width indent +.It Fl a Ar address +Remote device address. +The +.Ar address +may be given as BDADDR or a name. +.Pp +If a name was specified, +.Nm +attempts to resolve the name via +.Xr bt_gethostbyname 3 . +.It Fl B Ar bitpool +Allows setting the maximum bitpool value for your device. +This may have to be lowered if audio is distorted. +.Pp +Use +.Nm +with only the +.Fl v +option and the maximum bitpool for your device will be printed to stdout. +.It Fl D +Run in the background. +.It Fl n +Do not close connection on end of file (EOF). +Useful for +.Xr pad 4 . +.It Fl d Ar device +Local device address. +May be given as BDADDR or device name. +.It Fl I +Initiate a Discover command. +Useful when used as an audio sink as some devices need this to pair. +.It Fl K +Allows registering as an audio sink receiving an incoming connection. +.It Fl M Ar mtu +Allows setting the Maximum Transmission Unit (MTU) for the streaming +connections. +.Pp +For most devices this would be 672 but if audio is broken or has gaps lowering +this value may help. +.It Fl m Ar mode +Set L2CAP connection link mode. +Supported modes are: +.Pp +.Bl -tag -compact -width encrypt +.It auth +Require devices to be paired. +.It encrypt +Auth, plus enable encryption. +.It secure +Encryption, plus change of link key. +.El +.It Fl p Ar psm +Allows changing the l2cap psm for an audio sink the default is 25. +Most all devices will use 25. +.It Fl t +Test mode can be used with +.Fl K +to decode and receive encoded music from stdout/stdin to file. +.It Fl V Ar volume +Allows shifting the volume of the music by 1 or 2 bits prior to encoding for +increased volume. +.Pp +.Sy USE WITH CARE +as this may mean the output is quite loud. +.It Fl v +Be verbose. +.It Ar files ... +Files to stream. +These can be WAV files or CD-Audio Red Book data or output from a +.Xr pad 4 +device. +If not specified, the default is stdin or stdout if +.Fl K +applied and +.Nm +is used as an audio sink. +.Pp +When writing to a file or stdout it is raw 16-bit little endian (pulse coded +modulation) PCM data. +So a utility must be used to convert the file to add a header or use the +.Xr audioplay 1 +command as stated in +.Sx EXAMPLES . +.El +.Ss Channel Modes +.Bl -tag -width indent +.It Fl f Ar channel_mode +.Bl -tag -width 2n +.It Ar 0 +This specifies that all possible input formats are accepted and then one is +chosen starting with joint stereo then stereo then 2 channel then mono. +.It Ar m +This specifies that the input is monophonic. +.It Ar 2 +This specifies that the input is dual-channel. +.It Ar j +This specifies that the input is joint-stereo. +.It Ar s +This specifies that the input is stereo. +This is the default. +.El +.Pp +Specifying joint stereo as opposed to stereo would allow for a slightly higher +quality of playback as +.Nm +will only encode stereo and monophonic streams. +.It Fl r Ar rate +The frequency of the input. +Where rate is one of 0, 16000, 32000, 44100, 48000. +This defaults to 44.1 kHz. +.Pp +A value of 0 will arbitrate from the highest to lowest frequency. +.El +.Ss Sub Band Codec (SBC) Encoding Options +.Bl -tag -width indent +.It Fl A Ar bitpool_allocation +.Bl -tag -width 2n +.It Ar 0 +Bit Allocation is negotiated starting with Loudness then SNR. +.It Ar S +Audio is encoded with SNR (Signal to Noise Ratio) bit allocation. +.It Ar L +Audio is encoded with Loudness bit allocation. +This is the default. +.El +.It Fl b Ar blocks +Number of blocks to use for encoding. +Where blocks is one of 0, 4, 8, 12, 16. +This defaults to 16 blocks. +.Pp +In the case of 0 the number of blocks is +negotiated starting from 16 down to 4. +.It Fl e Ar bands +.Bl -tag -width 2n +.It Ar 0 +Number of SBC bands is negotiated 8 then 4. +.It Ar 4 +Audio is encoded with 4 SBC bands. +.It Ar 8 +Audio is encoded with 8 SBC bands. +This is the default. +.El +.El +.Pp +It may be necessary to use +.Xr btconfig 8 +to set the class of your Bluetooth adapter to that of headphones when +using +.Nm +as an audio sink. +I.e., +.Dl btconfig ubt0 class 0x200418 +Then start +.Nm +with +.Fl K +before pairing. +.Pp +This is necessary as some devices only perform an +.Xr sdpquery 1 +just after pairing and cache the result. +.Pp +It is possible to specify multiples of +.Fl r Fl e Fl b Fl f . +This will mean that the specified combinations are reported as being accepted +by the source/sink. +.Pp +When used as a sink +.Fl ( K ) , +all modes, bands, blocks and allocation modes will be +accepted unless specified as options. +I.e., +.Fl r Ar 44100 +will only accept a connection with a rate of 44.1kHz. +.Sh EXAMPLES +.Dl bta2dpd -a spkr my.wav +Encode and send audio +.Pa my.wav +to address +.Sq spkr . +.Pp +.Dl bta2dpd -n -a spkr /dev/pad +Encode and send audio from +.Xr pad 4 +to address +.Sq spkr . +.Pp +.Dl bta2dpd -K out.pcm +Decode stream from any connected address +and write it to +.Pa out.pcm . +.Pp +.Dl bta2dpd -K -a phone | audioplay -f -e slinear_le -P 16 -s 44100 -c 2 -- +Decode stream from address +.Sq phone +and send to speakers. +.Sh SEE ALSO +.Xr audioplay 1 , +.Xr sdpquery 1 , +.Xr pad 4 , +.Xr btconfig 8 +.Sh AUTHORS +.An Nathanial Sloss +.Sh BUGS +For some devices playback from file results in rapid playback or playback with +stutter. +For best results use with +.Xr pad 4 . diff --git a/static/netbsd/man8/btattach.8 b/static/netbsd/man8/btattach.8 new file mode 100644 index 00000000..8e8cbd29 --- /dev/null +++ b/static/netbsd/man8/btattach.8 @@ -0,0 +1,146 @@ +.\" $NetBSD: btattach.8,v 1.10 2017/08/13 18:34:03 wiz Exp $ +.\" +.\" Copyright (c) 2007 KIYOHARA Takashi +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, +.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd August 11, 2017 +.Dt BTATTACH 8 +.Os +.Sh NAME +.Nm btattach +.Nd attach serial lines as Bluetooth HCI interfaces +.Sh SYNOPSIS +.Nm +.Op Fl dFfoPp +.Op Fl i Ar speed +.Op Ar type +.Ar tty +.Ar speed +.Nm +.Fl t +.Op Fl dFfoPp +.Ar tty +.Sh DESCRIPTION +.Nm +is used to assign a +.Ar tty +line to a Bluetooth Host Controller Interface using the +.Xr btuart 4 +or +.Xr bcsp 4 +line disciplines, and can optionally initialize the line for a +given device +.Ar type +before activating the line discipline. +.Pp +Supported types are: +.Bl -tag -compact -width 15n -offset indent +.It Cm bcm2035 +Broadcom BCM2035 +.It Cm bcm43xx +Broadcom BCM43xx +.It Cm bcm43xx-3wire +Broadcom BCM43xx (3-wire) +.It Cm bcsp +Generic BCSP (BlueCore Serial Protocol) +.It Cm bgb2xx +Philips BGB2xx module +.It Cm btuart +Generic UART (this is the default) +.It Cm csr +Cambridge Silicon Radio Casira serial adapter, or +Brainboxes serial dongle (BL642) +.It Cm ericsson +Ericsson based modules +.It Cm digi +Digianswer based cards +.It Cm st +ST Microelectronics minikits based on STLC2410/STLC2415 +.It Cm stlc2500 +ST Microelectronics minikits based on STLC2500 +.It Cm swave +Silicon Wave kits +.It Cm texas +Texas Instruments modules +.It Cm unistone +Infineon UniStone (PBA31308) modules +.El +.Pp +When the line discipline is activated, +.Nm +detaches and sleeps until it receives a +.Dv SIGHUP . +.Pp +The command line options are as follows: +.Bl -tag -width ".Fl i Ar speed" +.It Fl d +debug mode. +print initialization IO and do not detach. +.It Fl F +Disable flow control. +.It Fl f +Enable flow control. +.It Fl i Ar speed +Specify an alternate +.Ar speed +for the Bluetooth module to use during the initialization phase. +.It Fl o +Enable odd parity. +.It Fl P +Disable parity. +.It Fl p +Enable parity (even parity). +.It Fl t +Test mode. +.El +.Pp +Only the super-user may attach a Bluetooth HCI interface. +.Pp +Test mode tries to guess the speed using the received link-establish +packet from HCI, or +.Xr btuart 4 , +if there is no response. +.Sh FILES +.Bl -tag -compact -width 20n +.It Pa /var/run/btattach- Ns Bro tty Brc Ns .pid +.El +.Sh SEE ALSO +.Xr bcsp 4 , +.Xr bluetooth 4 , +.Xr btuart 4 , +.Xr btconfig 8 +.Sh HISTORY +The +.Nm +program was written with reference to +.Nm hciattach +as provided with the BlueZ tools for Linux and first appeared in +.Nx 5.0 . +.Sh AUTHORS +.An KIYOHARA Takashi Aq Mt kiyohara@kk.iij4u.or.jp +.An Iain Hibbert +.Sh BUGS +Not all +.Ar type +initializations have been tested. diff --git a/static/netbsd/man8/btconfig.8 b/static/netbsd/man8/btconfig.8 new file mode 100644 index 00000000..1aa5ad00 --- /dev/null +++ b/static/netbsd/man8/btconfig.8 @@ -0,0 +1,204 @@ +.\" $NetBSD: btconfig.8,v 1.19 2021/12/02 21:55:22 andvar Exp $ +.\" +.\" Copyright (c) 2006 Itronix Inc. +.\" All rights reserved. +.\" +.\" Written by Iain Hibbert for Itronix Inc. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of Itronix Inc. may not be used to endorse +.\" or promote products derived from this software without specific +.\" prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd October 11, 2010 +.Dt BTCONFIG 8 +.Os +.Sh NAME +.Nm btconfig +.Nd configure bluetooth devices +.Sh SYNOPSIS +.Nm +.Op Fl svz +.Oo +.Ar device +.Op Ar parameters +.Oc +.Nm +.Op Fl l +.Sh DESCRIPTION +.Nm +is used to configure Bluetooth devices. +If the +.Ar device +is given, but no parameters, then +.Nm +will print information about the device. +If no +.Ar device +is given, a basic list of devices will be printed. +.Pp +When the +.Fl l +flag is used, just the device names will be printed. +.Sh COMMANDS +The following parameters may be specified with +.Nm : +.Bl -tag -width xxxxxxxxxxx +.It Cm up +Enable Bluetooth Device. +.It Cm down +Disable Bluetooth Device. +.It Cm pscan +Enable Page Scan. +This enables incoming connections to the device. +.It Cm -pscan +Disable Page Scan. +.It Cm iscan +Enable Inquiry Scan. +This puts the device in Discoverable mode. +.It Cm -iscan +Disable Inquiry Scan. +.It Cm encrypt +Enable encryption. +This will cause the device to request encryption on all baseband +connections, and will only work if authentication is also enabled. +.It Cm -encrypt +Disable encryption. +.It Cm auth +Enable authentication. +This will cause the device to request authentication +for all baseband connections. +.It Cm -auth +Disable authentication. +.It Cm switch +Enable Role Switching. +In a Bluetooth piconet there is one Master and up to seven Slaves, and +normally the device that initiates a connection will take the Master role. +Enabling this option allows remote devices to switch connection roles. +.It Cm -switch +Disable Role Switching. +.It Cm master +Request the Master role when accepting connections. +.It Cm -master +Do not request Master role. +.It Cm hold +Enable Hold Mode. +.It Cm -hold +Disable Hold Mode. +.It Cm sniff +Enable Sniff Mode. +.It Cm -sniff +Disable Sniff Mode. +.It Cm park +Enable Park Mode. +.It Cm -park +Disable Park Mode. +.It Cm name Ar name +Set human readable name of device. +.It Cm ptype Ar type +Set packet types. +.Ar type +is a 16 bit hex value specifying packet types that will be requested +by outgoing ACL connections. +By default, all packet types that the device supports are enabled, +see bluetooth specifications for more information if you want to change this. +.It Cm class Ar class +Set class of device. +.Ar class +is a 6 digit hex value the value of which declares the device capabilities. +See the +.Qq Assigned Numbers - Baseband +document at +.Lk http://www.bluetooth.com/ +for details of constructing a Class of Device value. +As a starter, 0x020104 means Desktop Computer, with Networking +available. +.It Cm fixed +Set fixed pin type. +.It Cm variable +Set variable pin type. +.It Cm inquiry +Perform device Discovery from the specified device and print details. +.It Cm imode Ar type +Set inquiry mode type to control which event formats are generated during +a device inquiry. +The +.Ar type +can be: +.Bl -tag -width xxxxxx +.It std +Standard Inquiry Result Event format. +.It rssi +Enable Remote Signal Strength Indicator (RSSI) in inquiry results. +This will only work if the device features indicate +.Aq RSSI with inquiry result . +.It ext +Inquiry Result with RSSI format or Extended Inquiry Result format. +This will only work where the device features indicate +.Aq extended inquiry , +and the Extended Inquiry Result will only occur when the remote device +provides the extended information. +.El +.It Cm reset +Perform a hard reset on the device and re-initialise system state. +.It Cm voice +Set Voice Setting. +[This should be 0x0060 for now] +.It Cm pto +Set Page Timeout value. +This is a decimal value in milliseconds, indicating how long the device +will attempt to page another device when opening baseband connections. +.It Cm scomtu +Change SCO mtu value. +This is a decimal value, see +.Xr ubt 4 +for reasons why you may need to do this. +.El +.Pp +All parameters are parsed before any device operations take place. +Each time the +.Fl v +flag is given, verbosity levels will be increased. +.Pp +Super-user privileges are required to change device configurations. +.Sh DIAGNOSTICS +Messages indicating the specified device does not exist, the +requested address is unknown, or the user is not privileged and +tried to alter a device's configuration. +.Sh SEE ALSO +.Xr bcsp 4 , +.Xr bluetooth 4 , +.Xr bt3c 4 , +.Xr btbc 4 , +.Xr btuart 4 , +.Xr sbt 4 , +.Xr ubt 4 +.Sh HISTORY +The +.Nm +command was written for +.Nx 4.0 +by +.An Iain Hibbert +under the sponsorship of Itronix, Inc. +.Sh BUGS +The output is very messy. diff --git a/static/netbsd/man8/btdevctl.8 b/static/netbsd/man8/btdevctl.8 new file mode 100644 index 00000000..9d0484c0 --- /dev/null +++ b/static/netbsd/man8/btdevctl.8 @@ -0,0 +1,179 @@ +.\" $NetBSD: btdevctl.8,v 1.12 2015/06/12 09:43:05 plunky Exp $ +.\" +.\" Copyright (c) 2006 Itronix Inc. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of Itronix Inc. may not be used to endorse +.\" or promote products derived from this software without specific +.\" prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" Copyright (c) 2004 Maksim Yevmenkin +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd December 26, 2012 +.Dt BTDEVCTL 8 +.Os +.Sh NAME +.Nm btdevctl +.Nd Bluetooth remote device control utility +.Sh SYNOPSIS +.Nm +.Op Fl A | Fl D +.Op Fl qv +.Op Fl m Ar mode +.Fl a Ar address +.Fl d Ar device +.Fl s Ar service +.Sh DESCRIPTION +The +.Nm +utility is used to configure bluetooth devices in the system. +Normally, +.Nm +will perform an SDP query to the remote device as needed, and +cache the results in the +.Pa /var/db/btdevctl.plist +file for later use. +If neither Attach nor Detach is specified, +.Nm +will display the configuration. +.Pp +The options are: +.Bl -tag +.It Fl A +Attach device +.It Fl a Ar address +Remote device address. +The +.Ar address +may be given as BDADDR or a name. +If a name was specified, +.Nm +attempts to resolve the name via +.Xr bt_gethostbyname 3 . +.It Fl D +Detach device +.It Fl d Ar device +Local device address. +May be given as BDADDR or device name. +.It Fl m Ar mode +Connection link mode. +The following modes are supported: +.Pp +.Bl -tag -width encrypt -compact +.It none +clear previously set mode. +.It auth +require devices be paired, see +.Xr btpin 1 . +.It encrypt +auth, plus enable encryption. +.It secure +encryption, plus change of link key. +.El +.Pp +When configuring the HID service, +.Nm +will set +.Sq auth +by default, or +.Sq encrypt +for keyboard devices. +If the device cannot handle authentication, then the mode will need +to be cleared manually. +.It Fl q +Ignore any cached data and perform a SDP query for the given +.Ar service . +.It Fl s Ar service +Service to configure. +Known services are: +.Pp +.Bl -tag -width HSETXX -compact +.It Dv HID +Human Interface Device. +.It Dv HF +Handsfree. +.It Dv HSET +Headset. +.El +.It Fl v +Be verbose. +.El +.Pp +For device configurations to persist across boots, add entries to the +.Pa /etc/bluetooth/btdevctl.conf +file and ensure the +.Xr rc.conf 5 +variable +.Sy bluetooth +is set to YES. +.Sh FILES +.Bl -tag -compact +.It Pa /etc/bluetooth/btdevctl.conf +.It Pa /dev/bthub +.It Pa /var/db/btdevctl.plist +.El +.Sh EXIT STATUS +.Ex -std +.Sh SEE ALSO +.Xr btpin 1 , +.Xr bthidev 4 , +.Xr bthub 4 , +.Xr btsco 4 , +.Xr rc.conf 5 +.Pp +See the Bluetooth chapter of +.Qq The NetBSD Guide +for detailed examples of configuring keyboards, mice, and audio headsets. +.Sh HISTORY +Parts of the +.Nm +program originated in the +.Fx +.Nm bthidcontrol +program. +.Sh AUTHORS +.An Iain Hibbert +for Itronix, Inc. +.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com diff --git a/static/netbsd/man8/bthcid.8 b/static/netbsd/man8/bthcid.8 new file mode 100644 index 00000000..f874cc12 --- /dev/null +++ b/static/netbsd/man8/bthcid.8 @@ -0,0 +1,170 @@ +.\" $NetBSD: bthcid.8,v 1.11 2017/12/21 12:25:03 wiz Exp $ +.\" +.\" Copyright (c) 2006 Itronix Inc. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of Itronix Inc. may not be used to endorse +.\" or promote products derived from this software without specific +.\" prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" +.\" Copyright (c) 2001-2002 Maksim Yevmenkin +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $Id: bthcid.8,v 1.11 2017/12/21 12:25:03 wiz Exp $ +.\" $FreeBSD: src/usr.sbin/bluetooth/hcsecd/hcsecd.8,v 1.6 2006/02/11 15:36:37 markus Exp $ +.\" +.Dd September 29, 2006 +.Dt BTHCID 8 +.Os +.Sh NAME +.Nm bthcid +.Nd Bluetooth Link Key/PIN Code Manager +.Sh SYNOPSIS +.Nm +.Op Fl fn +.Op Fl d Ar device +.Op Fl m Ar mode +.Op Fl s Ar socket_name +.Nm +.Op Fl h +.Sh DESCRIPTION +The +.Nm +daemon handles Link Key and PIN code requests for Bluetooth devices. +It opens a raw HCI socket and listens for the following HCI events. +.Pp +.Bl -tag -compact -width "Link_Key_NotificationXXX" +.It Dv Link_Key_Request +.Nm +scans the +.Pa /var/db/bthcid.keys +file for a cached link key matching the remote device BD_ADDR and, if +found, the +.Dv Link_Key_Request_Reply +will be sent back to the device, otherwise the +.Dv Link_Key_Request_Negative_Reply +will be sent. +.Pp +.It Dv Link_Key_Notification +When a new link key is created by the device, it will be cached for future +use in the +.Pa /var/db/bthcid.keys +link keys file, which will be created if it does not already exist. +.Pp +.It Dv PIN_Code_Request +The +.Nm +daemon checks its PIN cache for a matching remote device entry. +If no PIN is found, the +.Nm +daemon will send a message to any PIN clients that have +registered, with the device details and a timeout value. +When no clients are available or the timeout has expired, +.Nm +will send a +.Dv PIN_Code_Request_Negative_Reply +back to the device. +When a PIN is found, or if a client responds within the timeout period, a +.Dv PIN_Code_Request_Reply +will be sent back to the device. +.Pp +PINs received from clients will be cached for 5 minutes until used, and may be added +to the cache prior to pairing with the +.Xr btpin 1 +utility. +.El +.Pp +Some of the functionality of +.Nm +can be handled by the Bluetooth controller directly, and cached Link +Keys may be examined, deleted or moved to device storage using the +.Xr btkey 1 +program. +.Pp +The command line options are as follows: +.Bl -tag -width ".Fl s Ar socket_name" +.It Fl d Ar device +Specify the local Bluetooth device address. +The default is BDADDR_ANY. +.It Fl f +Run in foreground (do not detach). +.It Fl h +Display usage message and exit. +.It Fl m +Specify the file mode access bits for the PIN client socket. +The default is to allow readwrite access to user and group (0660). +.It Fl n +Do not listen for PIN clients. +.It Fl s Ar socket_name +Specify the socket name to listen on for PIN clients. +The default path is +.Pa /var/run/bthcid . +.El +.Sh FILES +.Bl -tag -compact -width "XvarXdbXbthcid.keysXXX" +.It Pa /var/db/bthcid.keys +.It Pa /var/run/bthcid +.It Pa /var/run/bthcid.pid +.El +.Sh SEE ALSO +.Xr btkey 1 , +.Xr btpin 1 , +.Xr bluetooth 4 , +.Xr btconfig 8 +.Sh HISTORY +The +.Nm +daemon first appeared in +.Fx 5.3 +as +.Ic hcsecd . +It was ported to +.Nx 4.0 +with its present name and extended to support PIN clients by +.An Iain Hibbert +under the sponsorship of Itronix, Inc. +.Sh AUTHORS +.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com +.An Iain Hibbert diff --git a/static/netbsd/man8/btpand.8 b/static/netbsd/man8/btpand.8 new file mode 100644 index 00000000..a8a39904 --- /dev/null +++ b/static/netbsd/man8/btpand.8 @@ -0,0 +1,240 @@ +.\" $NetBSD: btpand.8,v 1.8 2019/01/17 08:53:17 wiz Exp $ +.\" +.\" Copyright (c) 2008 Iain Hibbert +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd January 17, 2019 +.Dt BTPAND 8 +.Os +.Sh NAME +.Nm btpand +.Nd Bluetooth PAN daemon +.Sh SYNOPSIS +.Nm +.Op Fl i Ar ifname +.Op Fl m Ar mode +.Fl a Ar addr +.Fl d Ar device +.Brq Fl s Ar service | Fl S Ar service Op Fl p Ar psm +.Nm +.Op Fl c Ar path +.Op Fl i Ar ifname +.Op Fl l Ar limit +.Op Fl m Ar mode +.Op Fl p Ar psm +.Fl d Ar device +.Brq Fl s Ar service | Fl S Ar service +.Sh DESCRIPTION +The +.Nm +daemon handles Bluetooth Personal Area Networking services +in the system. +It can operate in client mode as a Personal Area Networking User +.Pq PANU +or in server mode as Network Access Point +.Pq NAP , +Group ad-hoc Network +.Pq GN +or PANU host. +.Nm +connects to the system via a +.Xr tap 4 +virtual Ethernet device and forwards Ethernet packets to +remote Bluetooth devices using the Bluetooth Network Encapsulation +Protocol +.Pq BNEP . +.Pp +The PANU client is the device that uses either the NAP or GN +service, or can talk directly to a PANU host in a crossover +cable fashion. +.Pp +A GN host forwards Ethernet packets to each of the connected PAN +users as needed but does not provide access to any additional networks. +.Pp +The NAP service provides some of the features of an Ethernet bridge, +with the NAP host forwarding Ethernet packets between each of the +connected PAN users, and a different network +media. +.Pp +Note, the only differences between NAP and GN services as implemented by +.Nm +are in the SDP service record. +The bridging of packets by the NAP must be configured separately with +.Xr brconfig 8 . +.Pp +The options are as follows: +.Bl -tag -width ".Fl a Ar address" +.It Fl a Ar address +In client mode, address of remote server. +May be given as BDADDR or name, in which case +.Nm +will attempt to resolve the address via the +.Xr bt_gethostbyname 3 +call. +.It Fl c Ar path +In server mode, specify +.Ar path +to the +.Xr sdpd 8 +control socket. +The default path is +.Pa /var/run/sdp . +.It Fl d Ar device +Restrict connections to the local +.Ar device . +May be given as BDADDR or name, in which case +.Nm +will attempt to resolve the address via the +.Xr bt_devaddr 3 +call. +.Nm +will set the +.Xr tap 4 +interface physical address to the BDADDR +of the Bluetooth radio. +.It Fl i Ar ifname +.Nm +uses the +.Xr tap 4 +driver to create a new network interface for use. +Use this option to select a specific +.Xr tap 4 +device interface which must already be created. +.It Fl l Ar limit +In server mode, limit the number of simultaneous connections. +The default limit is 7 for NAP and GN servers, +and 1 for a PANU server. +.It Fl m Ar mode +Set L2CAP connection link mode. +Supported modes are: +.Pp +.Bl -tag -compact -width secure +.It auth +require devices to be paired. +.It encrypt +auth, plus enable encryption. +.It secure +encryption, plus change of link key. +.El +.It Fl p Ar psm +Use an alternative L2CAP Protocol/Service Multiplexer +.Pq PSM +for server mode or client mode +.Pq when not using Service Discovery . +The default PSM for BNEP is 15 +.Pq 0x000f . +.It Fl s Ar service +Name of +.Ar service +to provide or connect to, the following services are recognised: +.Pp +.Bl -tag -compact -width PANU +.It GN +Group ad-hoc Network. +.It NAP +Network Access Point. +.It PANU +Personal Area Networking User. +.El +.It Fl S Ar service +As per +.Fl s +except that +.Nm +will not use SDP services for connection setup. +.El +.Pp +When providing networking services, the Bluetooth PAN profile says that the +.Sq Class of Device +property of the bluetooth controller SHALL include Networking capability +.Pq set bit 0x020000 . +See +.Xr btconfig 8 +for details. +.Pp +After +.Nm +has set up the client or server connection and opened the +.Xr tap 4 +interface, it will create a pid file and detach. +.Sh FILES +.Bl -tag -compact -width /etc/bluetooth/hosts +.It Pa /dev/tap +.It Pa /etc/bluetooth/hosts +.It Pa /var/run/sdp +.It Pa /var/run/tap Ns Em N Ns No .pid +.El +.Sh EXIT STATUS +.Ex -std +.Sh EXAMPLES +.Dl ifconfig tap1 create +.Dl btpand -a host -d ubt0 -s NAP -m encrypt -i tap1 +.Dl dhcpcd -q -b tap1 +.Pp +Will create an encrypted connection to the NAP on +.Ar host , +and link that to the +.Ar tap1 +interface. +.Pp +.Dl btpand -d ubt0 -s GN -m auth +.Pp +Will create a Group Network requiring authentication to join and register +the GN service with the local SDP server. +.Sh SEE ALSO +.Xr bluetooth 3 , +.Xr bluetooth 4 , +.Xr bridge 4 , +.Xr tap 4 , +.Xr brconfig 8 , +.Xr btconfig 8 , +.Xr dhcpcd 8 , +.Xr dhcpd 8 , +.Xr ifconfig 8 , +.Xr sdpd 8 +.Pp +The +.Qq Personal Area Networking Profile +and +.Qq Bluetooth Network Encapsulation Protocol +specifications are available at +.Lk http://www.bluetooth.com/ +.Sh AUTHORS +.An Iain Hibbert +.Sh BUGS +There is no way to supply alternative values for the SDP record. +.Pp +There is no way to set net type or multicast address filters. +.Pp +.Nm +does not do any address routing except to directly connected +unicast addresses. +All other packets are multicast. +.Pp +As +.Nm +uses the BDADDR of the Bluetooth radio as the physical address +of the tap, only one instance can be run per radio. +.Pp +.Nm +can only provide a single service. diff --git a/static/netbsd/man8/canconfig.8 b/static/netbsd/man8/canconfig.8 new file mode 100644 index 00000000..8f6f751f --- /dev/null +++ b/static/netbsd/man8/canconfig.8 @@ -0,0 +1,126 @@ +.\" $NetBSD: canconfig.8,v 1.3 2017/05/29 08:46:23 wiz Exp $ +.\" +.\" Copyright (c) 2017 Manuel Bouyer. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd April 15, 2017 +.Dt CANCONFIG 8 +.Os +.Sh NAME +.Nm canconfig +.Nd configure CAN network interface parameters +.Sh SYNOPSIS +.Nm +.Fl a +.Nm +.Ar canif +.Nm +.Ar can +.Ar command +.Op Ar args ... +.Sh DESCRIPTION +The +.Nm +utility is used to configure CAN network interface parameters and retrieve +CAN network interface parameters and status from the kernel. +.Ss Timing +The base time unit used to define the network bit rate is the time quanta (tq), +its value is defined by the input clock frequency and the prescaler value +as (1/ freq * prescaler). +.Pp +The network bit time is split in 4 segments: +.Bl -tag -width "phase_seg1" -offset indent -compact +.It sync_seg +fixed to 1 tq +.It prop_seg +.It phase_seg1 +.It phase_seg2 +.El +The network bit time is (1 + prop_seg + phase_seg1 + phase_seg2), in tq. +The sample point is between phase_seg1 and phase_seg2. +.Pp +The receiver hardware is allowed to shorten prop_seg or phase_seg2 to +resynchronize with the sender. +The swj (Synchronisation Jump Width) parameter +defines by how much the hardware can shorten these segments. +.Pp +Some hardware can use 3 sample points instead of one, and keep the majority as +the final value. +.Ss Options +The options are as follows: +.Bl -tag -width indent +.It Fl a +Display the status of all CAN devices present on the system. +This flag is mutually exclusive with all other sub-commands. +.El +.Pp +All other operations require that a CAN interface be specified. +If a CAN interface is specified with no sub-commands, +the status of that interface is displayed. +.Pp +The following sub-commands are available: +.Bl -tag -width indent +.It Cm up +Start network operations on the interface. +Requires that all timing parameters have been set. +.It Cm down +Stop network operations on the interface. +.It Cm brp Ar value +Set the value of the baud rate prescaler. +.It Cm prop_seg Ar value +Set the number of tq for the propagation segment. +.It Cm phase_seg1 Ar value +Set the number of tq for the phase segment 1. +.It Cm phase_seg2 Ar value +Set the number of tq for the phase segment 2. +.It Cm sjw Ar value +Set the number of tq for the Synchronisation Jump Width. +.It Cm 3samples +Enable triple-sampling. +.It Cm -3samples +Disable triple-sampling. +.It Cm listenonly +Enable listen-only mode. +In this mode the controller is passive, and doesn't send ACKs on the bus. +.It Cm -listenonly +Disable listen-only mode. +.It Cm loopback +Enable loopback mode. +In this mode, the controller doesn't expect ACK from the bus. +.It Cm -loopback +Disable loopback mode. +.El +.\".Sh EXAMPLES +.\"TODO +.Sh SEE ALSO +.Xr ifconfig.if 5 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 8.0 . +.Sh AUTHORS +This version of the +.Nm +utility was written by +.An Manuel Bouyer . diff --git a/static/netbsd/man8/catman.8 b/static/netbsd/man8/catman.8 new file mode 100644 index 00000000..0ba3f8b8 --- /dev/null +++ b/static/netbsd/man8/catman.8 @@ -0,0 +1,107 @@ +.\" +.\" Copyright (c) 1993 Winning Strategies, Inc. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by Winning Strategies, Inc. +.\" 4. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $NetBSD: catman.8,v 1.12 2021/08/15 11:00:43 christos Exp $ +.\" +.Dd August 15, 2021 +.Dt CATMAN 8 +.Os +.Sh NAME +.Nm catman +.Nd format cat pages from man pages +.Sh SYNOPSIS +.Nm +.Op Fl knpsw +.Op Fl m Ar directory +.Op Ar sections +.Nm +.Op Fl knpsw +.Op Fl M Ar directory +.Op Ar sections +.Sh DESCRIPTION +.Nm +creates formatted versions of the on-line manual pages from their +.Xr nroff 1 +source. +Manual pages whose formatted versions are missing or out of date are +regenerated. +If manual pages are regenerated, +.Nm +also regenerates the +.Pa whatis +database. +.Pp +The optional +.Ar sections +argument is one word, and contains the section numbers of all the +sections to be checked. For example, if +.Ar sections +is ``13f8'', the +manual pages in sections 1, 3f, and 8 will be checked and regenerated. +If no +.Ar sections +argument is provided, +.Nm +will try to operate on all of the known manual sections. +.Pp +The options are as follows: +.Bl -tag -width indent +.It Fl k +Ignore errors from nroff when building manpages. +.It Fl n +Do not create the +.Pa whatis +database. +.It Fl p +Display the commands that would have been executed, but do not actually +execute them. +.It Fl s +Perform work silently; do not echo commands as they are executed. This +flag is ignored if +.Fl p +is specified. +.It Fl w +Only create the +.Pa whatis +database. +.It Fl m Ar directory +Add +.Ar directory +to the set of directories to be updated. +.It Fl M Ar directory +Update manual pages in +.Ar directory . +.El +.Sh SEE ALSO +.Xr apropos 1 , +.Xr man 1 , +.Xr whatis 1 +.Sh BUGS +Currently does not handle hard links. +Acts oddly on nights with full moons. diff --git a/static/netbsd/man8/ccdconfig.8 b/static/netbsd/man8/ccdconfig.8 new file mode 100644 index 00000000..22387715 --- /dev/null +++ b/static/netbsd/man8/ccdconfig.8 @@ -0,0 +1,344 @@ +.\" $NetBSD: ccdconfig.8,v 1.30 2026/02/21 02:38:38 uwe Exp $ +.\" +.\" Copyright (c) 1996, 1997 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Jason R. Thorpe. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 20, 2026 +.Dt CCDCONFIG 8 +.Os +.Sh NAME +.Nm ccdconfig +.Nd configuration utility for the concatenated disk driver +.Sh SYNOPSIS +. +.Nm +.Op Fl cv +.Ar ccd +.Ar ileave +.Op Ar flags +.Ar dev \&... +. +.Nm +.Fl C +.Op Fl v +.Op Fl f Ar config_file +. +.Nm +.Fl u +.Op Fl v +.Ar ccd \&... +. +.Nm +.Fl U +.Op Fl v +.Op Fl f Ar config_file +. +.Nm +.Fl g +.Op Fl vWw +.Op Ar ccd \&... +. +.Nm +.Fl p +.Op Fl hsVvWw +.Op Ar ccd \&... +. +.Sh DESCRIPTION +.Nm +is used to dynamically configure and unconfigure concatenated disk +devices, or ccds. +For more information see +.Xr ccd 4 . +.Pp +The options are as follows: +.Bl -tag -width Fl +.It Fl c +Configure a ccd. +The ccd to configure is given as +.Ar ccd , +it is usually the name of a +.Xr ccd 4 +device relative to +.Pa /dev . +This is the default behavior of +.Nm . +.It Fl C +Configure all ccd devices listed in the ccd configuration file. +.It Fl f Ar config_file +When configuring or unconfiguring all devices, read the file +.Pa config_file +instead of the default +.Pa /etc/ccd.conf . +.It Fl g +Dump the current ccd configuration in a format suitable +for use as the ccd configuration file. +If no arguments are specified, every configured ccd is dumped. +Otherwise, the configuration of each listed ccd is dumped. +.It Fl h +With +.Fl p +show the size as a number of bytes, rather than sectors, +and interpreted by +.Xr humanize_number 3 . +.It Fl s +With +.Fl p +show the flags in string form, rather than as a number. +.It Fl u +Unconfigure one, or more, ccds. +.It Fl U +Unconfigure all ccd devices listed in the ccd configuration file. +.It Fl V +Identical to +.Fl v , +except when used with +.Fl p +a more ornate layout is used. +.It Fl v +Causes +.Nm +to be verbose. +When used with +.Fl c +or +.Fl C +information about the ccd being configured is printed. +When used with +.Fl u +or +.Fl U +a message indicating that the ccd has been unconfigured is printed. +When used with +.Fl g +or +.Fl p +a header line is printed before the output. +In the case of +.Fl g +the header is in a format that will be treated as a comment +if included in a ccd configuration file. +.It Fl W +With +.Fl g +or +.Fl p +when a component device of a ccd is a wedge with a label, +print the label in +.Li NAME=label +format instead of the wedge device name. +Wedge names in this format are always accepted as a +.Ar dev +.Pq component device +argument. +.It Fl w +The same as +.Fl W +except wedge labels which contain any of +.Ql \~ +.Pq space , +.Ql \et +.Pq tab , +or +.Ql \en +.Pq newline +are treated as if no label exists; the wedge device name is used. +.El +.Pp +See the +.Sx ENVIRONMENT +section below for some extra options. +.Pp +A ccd is described on the command line and in the ccd configuration +file by the name of the ccd +.Po +the string +.Dq Cm ccd +with a decimal unit number appended +.Pc , +the interleave factor, +the ccd configuration flags, and a list of one or more devices. +An interleave factor of 0 means that the devices are +concatenated serially, not interleaved. +The flags may be represented as a decimal number, a hexadecimal number, +a comma-separated list of strings, or the word +.Sq Li none . +The flags are as follows: +.Bl -column -offset indent ".Dv CCDF_UNIFORM" ".Sy Numeric" +.It Sy Symbolic Ta Sy Numeric Ta Sy Comment. +.It Dv CCDF_UNIFORM Ta Li 0x02 Ta Use uniform interleave. +The size of all components is clamped to that of the smallest component. +.It Dv CCDF_NOLABEL Ta Li 0x04 Ta Ignore raw disklabel. +Useful when creating a new ccd. +.El +.Pp +The aliases +.Sq Li uniform +and +.Sq Li nolabel +may be used instead of the formal names, and are printed when +.Nm +.Fl ps +is requested. +In all cases when considering input names of flags, character case is ignored. +.Ss /etc/ccd.conf +The file +.Pa /etc/ccd.conf +is used to configure +.Nm +if +.Fl C +or +.Fl U +is used without +.Fl f . +Each line of the configuration file contains arguments as per the +.Fl c +argument: +.Ar ccd Ar ileave Oo Ar flags Oc Ar dev \&... +.Pp +A +.Ql # +is a comment, and everything to end of line is ignored. +A +.Ql \e +at the end of a line indicates that the next line should be concatenated +with the current. +A +.Ql \e +preceding any character +.Pq other than the end of line +prevents that character's special meaning from taking effect. +.Pp +See +.Sx EXAMPLES +for an example of +.Pa /etc/ccd.conf . +.Sh ENVIRONMENT +The name +.Ev CCDCONFIG +in the environment passed to +.Nm , +can be set to a string containing of one or more of the +characters: +.Ql h +.Ql s +.Ql V +.Ql v +.Ql W +and +.Ql w , +to cause the appropriate option to default to on. +Any other characters in the value of +.Ev CCDCONFIG +are ignored. +To allow these defaults to be overridden for a particular instance of +.Nm , +additional options, +not shown in the +.Sx SYNOPSIS , +listed above, or output in a usage message, +can be used on the command line to override settings from +.Ev CCDCONFIG . +.Fl D +will disable +.Ql w +and +.Ql W , +.Fl n +will disable +.Ql h , +.Fl q +will disable +.Ql v +and +.Ql V , +and +.Fl S +will disable +.Ql s . +In addition the options in each of the option pairs +.Fl W +and +.Fl w , +and +.Fl V +and +.Fl v , +are mutually exclusive, using one on the command line will +override an earlier use of the other, or use of the other +character in +.Ev CCDCONFIG . +.Sh FILES +.Bl -tag -width Pa -compact +.It Pa /etc/ccd.conf +default ccd configuration file. +.El +.Sh EXAMPLES +The following command, executed from the command line, would configure +.Pa ccd0 +with 4 components +.Po +.Pa /dev/sd2e , +.Pa /dev/sd3e , +.Pa /dev/sd4e , +.Pa /dev/sd5e +.Pc , +and an interleave factor of 32 blocks. +.Pp +.Dl ccdconfig ccd0 32 0 /dev/sd2e /dev/sd3e /dev/sd4e /dev/sd5e +.Pp +.Pp +An example +.Pa /etc/ccd.conf : +.Bd -literal -offset indent +# +# /etc/ccd.conf +# Configuration file for concatenated disk devices +# +.Pp +# ccd ileave flags component devices +ccd0 16 none /dev/sd2e /dev/sd3e +.Ed +.Sh SEE ALSO +.Xr humanize_number 3 , +.Xr ccd 4 , +.Xr ccd.conf 5 , +.Xr rc 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 1.1 . +The +.Fl W +.Pq and Fl w +option, +and the +.Fl p +option, and its related options, +first appeared in +.Nx 12.0 . diff --git a/static/netbsd/man8/certctl.8 b/static/netbsd/man8/certctl.8 new file mode 100644 index 00000000..072f1751 --- /dev/null +++ b/static/netbsd/man8/certctl.8 @@ -0,0 +1,369 @@ +.\" $NetBSD: certctl.8,v 1.3 2023/10/11 15:28:05 riastradh Exp $ +.\" +.\" Copyright (c) 2023 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd August 16, 2023 +.Dt CERTCTL 8 +.Os +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh NAME +.Nm certctl +.Nd configure OpenSSL certificate trust anchors +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh SYNOPSIS +.Nm +.Op Fl nv +.Op Fl C Ar config +.Op Fl c Ar certsdir +.Op Fl u Ar distrustdir +.Ar cmd +.Op Ar args... +.\"""""""""""""""""" +.Nm +.Oo Ar options Oc Cm list +.Nm +.Oo Ar options Oc Cm rehash +.Nm +.Oo Ar options Oc Cm trust Ar cert +.Nm +.Oo Ar options Oc Cm untrust Ar cert +.Nm +.Oo Ar options Oc Cm untrusted +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh DESCRIPTION +The +.Nm +utility manages certificates used by OpenSSL-based applications as +trust anchors for certificate validation in TLS or other purposes, +for example by +.Xr ftp 1 +in HTTPS. +.Nm +allows configuring the set of certificates and persistently excluding +individual certificates. +.Pp +For trust anchors to validate TLS certificates, OpenSSL applications +typically use a directory at +.Pa /etc/openssl/certs +of hashed certificates in PEM format, with names like +.Pa "3513523f.0" +used for lookup; see +.Xr openssl_rehash 1 . +.Pp +.Nm +scans all directories in the certificate search path specified by the +configuration file +.Ar config +.Pq default: Pa /etc/openssl/certs.conf +for files called +.Pa *.cer , +.Pa *.crt , +or +.Pa *.pem +in PEM format, and keeps +.Ar certsdir +.Pq default: Pa /etc/openssl/certs +populated with: +.Bl -dash +.It +symlinks to the original files in the certificate search path, for +applications that scan a directory for all files matching +.Pa *.cer , +.Pa *.crt , +or +.Pa *.pem ; +.It +hashed symlinks as in +.Xr openssl_rehash 1 ; and +.It +a single-file bundle +.Pa ca-certificates.crt +concatenating all the certificates in PEM format. +.El +.Pp +.Nm +will exclude from +.Ar certsdir +any certificates that have been marked untrustworthy with +.Nm Cm untrust , +which are persistently maintained in the private state directory +.Ar distrustdir +.Pq default: Pa /etc/openssl/untrusted . +.Pp +.Nm +treats +.Ar config +and +.Ar distrustdir +as configuration, and treats +.Ar certsdir +strictly as a cache that can be safely deleted and rebuilt with +.Nm Cm rehash . +.Nm +can also be instructed not to touch +.Ar certsdir +at all by putting +.Cm manual +in +.Ar config . +.\"""""""""""""""""""""""""""""""""""""" +.Ss Commands +.Bl -tag -width Cm +.\"""""""""""""""""" +.It Cm list +List absolute paths to trusted certificates. +.Nm Cm rehash +will populate +.Ar certsdir +with these. +Paths are printed one per line, encoded in +.Xr vis 1 +format to escape any shell metacharacters. +.\"""""""""""""""""" +.It Cm rehash +Populate +.Ar certsdir +with all trusted certificates, excluding any from +.Nm Cm untrust . +.\"""""""""""""""""" +.It Cm trust Ar cert +Allow +.Ar cert +to be included in +.Ar certsdir +if it is in the certificate search path, and rehash to make it +effective immediately. +In other words, reverse the persistent effect of +.Nm Cm untrust Ar cert . +.Pp +.Ar cert +must be the full absolute path to a certificate that has been excluded +by +.Nm Cm untrust Ar cert . +.Pp +This does not add a new certificate which is not in the search path. +To do that, you can create a directory to hold it and put that +directory in the search path. +.\"""""""""""""""""" +.It Cm untrust Ar cert +Persistently prevent +.Ar cert +from being included in +.Ar certsdir , +and rehash to make it effective immediately. +.Pp +.Ar cert +must be the full absolute path to a certificate that is in the +certificate search path. +.\"""""""""""""""""" +.It Cm untrusted +List absolute paths to certificates that have been excluded by +.Nm Cm untrust . +.Nm Cm rehash +will not put these in +.Ar certsdir . +Paths are printed one per line, encoded in +.Xr vis 1 +format to escape any shell metacharacters. +.\"""""""""""""""""" +.El +.\"""""""""""""""""""""""""""""""""""""" +.Ss Configuration file +The configuration file is a plain text file of lines separated by +.Tn US-ASCII +line feeds. +.Pp +.Pp +The first line must be: +.Dl netbsd-certctl 20230816 +.Pp +Lines with only whitespace, or whitespace followed by the comment +character +.Ql # +are ignored. +Each line has a directive and arguments separated by whitespace, and +may be extended by +.Ql \e +to continuation lines. +.Bl -tag -width Cm +.\"""""""""""""""""" +.It Cm path Ar dir +Add +.Ar dir +to the certificate search path. +.Ar dir +must be an absolute pathname, +.Xr vis 3 Ns -encoded +if it has any characters outside the class +.Ql "a-zA-Z0-9,.:=/+-" . +.Pp +All certificates must have unique base names across all directories +in the certificate search path. +.\"""""""""""""""""" +.It Cm manual +Manual override. +If specified, +.Nm +will +.Em not +modify +.Ar certsdir , +but may still check consistency of the configuration when run, and +.Nm Cm untrust +and +.Nm Cm trust +will still update +.Ar distrustdir . +.\"""""""""""""""""" +.El +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh FILES +.Bl -tag -width Pa +.It Pa /etc/openssl/certs +Default directory of hashed TLS CA certificates. +.It Pa /etc/openssl/certs/ca-certificates.crt +Default single-file TLS CA certificate bundle. +.It Pa /etc/openssl/certs.conf +Default configuration file for TLS CA certificates. +.It Pa /etc/openssl/untrusted +Default +.Ar distrustdir +directory of excluded TLS CA certificates. +.It Pa /usr/share/certs/mozilla/all +All root CA certificates published by Mozilla, including untrustworthy +certificates. +.It Pa /usr/share/certs/mozilla/code +All root CA certificates published by Mozilla for use in code-signing. +.It Pa /usr/share/certs/mozilla/email +All root CA certificates published by Mozilla for use in email +authentication. +.It Pa /usr/share/certs/mozilla/server +All root CA certificates published by Mozilla for use in TLS server +authentication. +.El +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh EXAMPLES +Example configuration file +.Pq Pa /etc/openssl/certs.conf : +.Bd -literal -offset indent +netbsd-certctl 20230816 + +# Blank lines and comments are ignored. +# Comments begin with a `#' sign. + +# Gather certificates from files called *.cer, *.crt, and *.pem +# under these directories. +path /usr/share/certs/mozilla/server +path /usr/pkg/share/chromium-cacerts +path /etc/openssl/certs.local + +# If the next line is uncommented, certctl(8) will decline to +# touch /etc/openssl/certs. +#manual +.Ed +.Pp +Exclude a certificate: +.Bd -literal -offset indent +$ certctl untrust /usr/share/certs/mozilla/server/GTS_Root_R1.pem +.Ed +.Pp +There is no need to run +.Nm Cm rehash +explicitly after +.Nm Cm untrust , +but if you do, the setting will persist. +.Pp +Rebuild the hashed certificate cache at +.Pa /etc/myapplication/certs +from +.Pa /etc/myapplication/certs.conf +and +.Pa /etc/myapplication/untrusted : +.Bd -literal -offset indent +$ certctl -c /etc/myapplication/certs \e + -C /etc/myapplication/certs.conf \e + -u /etc/myapplication/untrusted +.Ed +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh DIAGNOSTICS +.Ex -std +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh COMPATIBILITY +The +.Nm +utility is mostly compatible with a utility of the same name in +.Fx . +Differences: +.Bl -enum +.\"""""""""""""""""" +.It +.Fx Nm +supports destdir/metalog handling; +.Nx Nm +does not. +.\"""""""""""""""""" +.It +.Fx Nm +treats +.Pa /etc/ssl/certs +and +.Pa /etc/ssl/untrusted +both as configuration +.Em and +as caches; +.Nx Nm +treats +.Pa /etc/openssl/certs.conf +and +.Pa /etc/openssl/untrusted +as configuration, and treats +.Pa /etc/openssl/certs +strictly as a cache. +.Fx Nm +will forget any +.Nm Cm untrust +settings on +.Nm Cm rehash , +but +.Nx Nm +will remember them. +.\"""""""""""""""""" +.It +.Fx Nm +takes configuration through environment variables; +.Nx Nm +takes configuration through a file and command-line arguments. +.El +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh SEE ALSO +.Xr openssl 1 , +.Xr openssl_rehash 1 +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh HISTORY +.Nm +first appeared in +.Nx 10.0 . +A utility of the same name previously appeared in +.Fx 12.2 . diff --git a/static/netbsd/man8/cgdconfig.8 b/static/netbsd/man8/cgdconfig.8 new file mode 100644 index 00000000..785fd098 --- /dev/null +++ b/static/netbsd/man8/cgdconfig.8 @@ -0,0 +1,759 @@ +.\" $NetBSD: cgdconfig.8,v 1.59 2024/10/09 19:44:17 riastradh Exp $ +.\" +.\" Copyright (c) 2002, The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Roland C. Dowdeswell. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd May 12, 2024 +.Dt CGDCONFIG 8 +.Os +.Sh NAME +.Nm cgdconfig +.Nd configuration utility for the cryptographic disk driver +.Sh SYNOPSIS +.Nm +.Op Fl enpv +.Op Fl V Ar vmeth +.Ar cgd dev +.Op Ar paramsfile +.Nm +.Fl C +.Op Fl enpv +.Op Fl f Ar configfile +.Nm +.Fl G +.Op Fl enpv +.Op Fl i Ar ivmeth +.Op Fl k Ar kgmeth +.Op Fl o Ar outfile +.Ar paramsfile +.Nm +.Fl g +.Op Fl Sv +.Op Fl V Ar vmeth +.Op Fl i Ar ivmeth +.Op Fl k Ar kgmeth +.Op Fl o Ar outfile +.Op Fl P Ar paramsfile +.Ar alg +.Op Ar keylen +.Nm +.Fl T +.Op Fl f Ar configfile +.Nm +.Fl t +.Ar paramsfile +.Nm +.Fl l +.Op Fl v Ns Op Cm v +.Op Ar cgd +.Nm +.Fl s +.Op Fl nv +.Op Fl i Ar ivmeth +.Ar cgd +.Ar dev +.Ar alg +.Op Ar keylen +.Nm +.Fl U +.Op Fl nv +.Op Fl f Ar configfile +.Nm +.Fl u +.Op Fl nv +.Ar cgd +.Sh DESCRIPTION +.Nm +is used to configure and unconfigure cryptographic disk devices (cgds) +and to maintain the configuration files that are associated with them. +For more information about cryptographic disk devices see +.Xr cgd 4 . +.Pp +The options are as follows: +.Bl -tag -width configfilexxxx +.It Fl C +Configure all the devices listed in the cgd configuration file. +.It Fl e +Echo the passphrase. +.It Fl f Ar configfile +Specify the configuration file explicitly, rather than using the default +configuration file +.Pa /etc/cgd/cgd.conf . +.It Fl G +Generate a new paramsfile (to stdout) using the values from +.Ar paramsfile +which will generate the same key. +This may need to obtain multiple passphrases. +.It Fl g +Generate a paramsfile (to stdout). +.It Fl i Ar ivmeth +Specify the IV method (default: encblkno1). +.Pp +Setting the IV method is needed only for compatibility with disks +written with a very old version of +.Xr cgd 4 +from before +.Nx 5.0 , +released in 2010; see +.Xr cgd 4 +for details. +.It Fl k Ar kgmeth +Specify the key generation method (default: pkcs5_pbkdf2/sha1). +.It Fl l Op Ar cgd +List state of all devices or just the one +.Ar cgd +device. +The verbosity level affects the output. +.It Fl n +Do not actually configure or unconfigure a cryptographic disk +device, but instead report the steps that would be taken. +.It Fl o Ar outfile +When generating a +.Ar paramsfile , +store it in +.Ar outfile . +If +.Fl o +is not given, any paramsfile content is written to standard output. +.It Fl P Ar paramsfile +With the +.Fl S +option for the +.Fl g +or +.Fl G +actions, specify a parameters file with a shared key to reuse for +deriving this one as a subkey. +.It Fl p +Read all passphrases from stdin rather than +.Pa /dev/tty . +Passphrases are separated by newlines. +Users of this flag must be able to predict the order in which passphrases +are prompted. +If this flag is specified then verification errors will cause the device +in question to be unconfigured rather than prompting for the passphrase +again. +.It Fl S +When generating a parameters file with +.Fl g +or +.Fl G , +arrange to use a subkey of a shared key. +If +.Fl P Ar paramsfile +is also specified, reuse the shared key of +.Ar paramsfile ; +otherwise a new one will be generated. +.It Fl s +Read the key (nb: not the passphrase) from stdin. +.It Fl T +Generate all keys for all the devices listed in the +.Nm +configuration file and print them to standard output encoded in +base64. +.It Fl t +Generate the key and print it to standard output encoded in base64. +.It Fl U +Unconfigure all the devices listed in the cgd configuration file. +.It Fl u +Unconfigure a cgd. +.It Fl V Ar vmeth +Specify the verification method (default: none). +.It Fl v +Be verbose. +May be specified multiple times. +.El +.Pp +For more information about the cryptographic algorithms supported, +please refer to +.Xr cgd 4 . +.Ss Key Generation Methods +To generate the key which it will use, +.Nm +evaluates all of the key generation methods in the parameters file +and uses the exclusive-or of the outputs of all the methods. +The methods and descriptions are as follows: +.Bl -tag -width indentxxxxxxxxxxx +.It argon2id +This method requires a passphrase which is entered at configuration +time. +Argon2 is a memory-hard password hashing scheme and winner of the +2013-2015 Password Hashing Competition. +It has numerous parameters allowing its hardness to scale with the +performance of the system. +Recommended for passphrase-based initialization. +.It pkcs5_pbkdf2/sha1 +This method requires a passphrase which is entered at configuration +time. +It is a salted hmac-based scheme detailed in +.Dq PKCS#5 v2.0: Password-Based Cryptography Standard , +RSA Laboratories, March 25, 1999, pages 8-10. +PKCS #5 was also republished as RFC 2898. +.It pkcs5_pbkdf2 +This is an earlier, slightly incorrect and deprecated implementation +of the above algorithm. +It is retained for backwards compatibility with existing parameters +files, and will be removed. +Existing parameters files should be +converted to use the correct method using the +.Fl G +option, and a new passphrase. +.It storedkey +This method stores its key in the parameters file. +.It randomkey +The method simply reads +.Pa /dev/random +and uses the resulting bits as the key. +It does not require a passphrase to be entered. +This method is typically used to present disk devices that do not +need to survive a reboot. +It is also handy to facilitate overwriting the contents of +a disk volume with meaningless data prior to use. +.It urandomkey +The method simply reads +.Pa /dev/urandom +and uses the resulting bits as the key. +This is similar to the +.Pa randomkey +method, but it guarantees that +.Nm +will not stall waiting for 256 bits of entropy from a hardware RNG +or seed. +.It shell_cmd +This method executes a shell command via +.Xr popen 3 +and reads the key from stdout. +.El +.Ss Verification Method +The verification method is how +.Nm +determines if the generated key is correct. +If the newly configured disk fails to verify, then +.Nm +will regenerate the key and re-configure the device. +It only makes sense to specify a verification method if at least one of the +key generation methods is error prone, e.g., uses a user-entered passphrase. +The following verification methods are supported: +.Pp +.Bl -tag -width indentxxx -compact +.It none +perform no verification. +.It disklabel +scan for a valid disklabel. +.It mbr +scan for a valid Master Boot Record. +.It gpt +scan for a valid GUID partition table. +.It ffs +scan for a valid FFS file system. +.It zfs +scan for a valid ZFS vdev label (if compiled with MKZFS). +.It re-enter +prompt for passphrase twice, and ensure entered passphrases are +identical. +This method only works with the argon2id, pkcs5_pbkdf2/sha1, and +pkcs5_pbkdf2 key generators. +.El +.Pp +If a wrong key is generated, e.g. if the passphrase is entered +incorrectly, the disk content will appear to be randomized. +Assuming uniform random disk content, each verification method has some +probability of falsely accepting a wrong key anyway. +The probability for each method is as follows: +.Bl -column "disklabel" "matching \*(Ge160-bit hashes" "1 - (1 - 1/2^80)^1946 < 1/6e20" +.It Sy method Ta Sy verifies Ta Sy "P(false accept)" +.It Li none Ta No nothing Ta "1" Ta +.\" disklabel: +.\" - scans SCANSIZE=8192 bytes with disklabel_scan, which... +.\" - checks {0, 4, 8, 12, ..., SCANSIZE=8192 - sizeof(struct +.\" disklabel)=408}, 1946 options total, for a matching 64-bit +.\" quantity (d_magic=DISKMAGIC, d_magic2=DISKMAGIC) plus a matching +.\" 16-bit cksum (plus a plausible d_npartitions but let's ignore +.\" that) +.\" Pr[false accept] = Pr[exists i. scan[i] matches 80-bit magic/cksum] +.\" = 1 - Pr[not exists i. scan[i] does not match 80-bit magic/cksum] +.\" = 1 - Pr[forall i. scan[i] does not match 80-bit magic/cksum] +.\" = 1 - \prod_i Pr[scan[i] does not match 80-bit magic/cksum] +.\" = 1 - \prod_i (1 - Pr[scan[i] matches 80-bit magic/cksum]) +.\" = 1 - \prod_i (1 - 1/2^80) +.\" = 1 - (1 - 1/2^80)^1946 +.\" = 1 - exp(1946*log(1 - 1/2^80)) +.\" = -expm1(1946*log1p(-1/2^80)) +.\" <= 1/621e18 <= 1/6e20 (one in six hundred quintillion) +.It Li disklabel Ta No 64-bit magic strings w/16-bit cksum in any of 1946 places Ta "1 - (1 - 1/2^80)^1946 < 1/6e20" +.\" mbr: +.\" - checks exactly one location +.\" - checks for exactly one magic 16-bit constant +.\" Pr[false accept] = 1/2^16 = 1/65536 +.It Li mbr Ta No 16-bit magic string Ta "1/65536" +.\" gpt: +.\" - scans SCANSIZE=8192 bytes +.\" - checks blksizes DEV_BSIZE=512, 1024, 2048, 4096 +.\" - checks for 64-bit sig, 32-bit rev, 32-bit size, 32-bit cksum +.\" Pr[false accept] +.\" = Pr[exists blksz. hdr[blksz] matches 160-bit magic/cksum] +.\" = 1 - Pr[not exists blksz. hdr[blksz] matches 160-bit magic/cksum] +.\" = 1 - Pr[forall blksz. hdr[blksz] does not match 160-bit magic/cksum] +.\" = 1 - \prod_blksz Pr[hdr[blksz] does not match 160-bit magic/cksum] +.\" = 1 - \prod_blksz (1 - Pr[hdr[blksz] matches 160-bit magic/cksum]) +.\" = 1 - \prod_blksz (1 - 1/2^160) +.\" = 1 - (1 - 1/2^160)^4 +.\" = 1 - exp(4*log(1 - 1/2^160)) +.\" = -expm1(4*log1p(-1/2^160)) +.\" <= 1/3e47 +.It Li gpt Ta No 128-bit magic string w/32-bit cksum in any of 4 places Ta "1 - (1 - 1/2^160)^4 < 1/3e47" Ta +.\" ffs: +.\" - checks four locations in SBLOCKSEARCH (sblock_try) +.\" - checks for any of six magic 32-bit constants +.\" Pr[false accept] = Pr[exists i. sblock_try[i] in {magic[0], ..., magic[5]}] +.\" = 1 - Pr[not exists i. sblock_try[i] in {magic[0], ..., magic[5]}] +.\" = 1 - Pr[forall i. sblock_try[i] not in {magic[0], ..., magic[5]}] +.\" = 1 - \prod_i Pr[sblock_try[i] not in {magic[0], ..., magic[5]}] +.\" = 1 - \prod_i (1 - Pr[sblock_try[i] in {magic[0], ..., magic[5]}]) +.\" = 1 - \prod_i (1 - 6/2^32) +.\" = 1 - (1 - 6/2^32)^4 +.\" = 1 - exp(4*log(1 - 6/2^32)) +.\" = -expm1(4*log1p(-6/2^32)) +.\" <= 1/178e6 <= 1/1e8 (one in a hundred million) +.It Li ffs Ta No any of 6 32-bit magic strings in any of 4 places Ta "1 - (1 - 6/2^32)^4 < 1/1e8" Ta +.\" zfs: +.\" - checks four locations (VDEV_LABELS) +.\" - checks for any of two magic 64-bit constants (ZEC_MAGIC or bswap) +.\" - checks for 256-bit SHA256 hash +.\" Pr[false accept] = Pr[exists i. label[i] matches 320-bit magic/cksum] +.\" = 1 - Pr[not exists i. label[i] matches 320-bit magic/cksum] +.\" = 1 - Pr[forall i. label[i] does not match 320-bit magic/cksum] +.\" = 1 - \prod_i Pr[label[i] does not match 320-bit magic/cksum] +.\" = 1 - \prod_i (1 - Pr[label[i] does matches 320-bit magic/cksum]) +.\" = 1 - \prod_i (1 - 2/2^230) +.\" = 1 - (1 - 2/2^230)^4 +.\" = -expm1(4*log1p(-2/2^230)) +.\" <= 1/2e68 +.It Li zfs Ta No any of 2 64-bit magic strings w/256-bit cksum in any of 4 places Ta "1 - (1 - 2/2^320)^4 < 1/1e68" +.\" re-enter: +.\" - checks whether >=160-bit hash matches +.\" Pr[false accept] = Pr[H(pw1) = H(pw2) | pw1 != pw2] <= 1/2^160 < 1/1e48 +.It Li re-enter Ta No matching \*(Ge160-bit hashes Ta "\*(Le 1/2^160 < 1/1e48" +.El +.Pp +Note that aside from the +.Ql none +method, which accepts any key unconditionally, the +.Ql mbr +method and to a lesser extent the +.Ql ffs +method also accept a wrong key with a much higher probability than +cryptography normally deals in. +.Pp +This is not a security vulnerability in the confidentiality of +.Xr cgd 4 +against an adversary, but it may be alarming for a user if a disk is +configured with a mistyped passphrase, +.Nm +.Em accepts the wrong key , +and the content appears to be garbage \(em for example, fsck may fail +with scary warnings, and any writes to the disk configured with the +wrong key will corrupt the original plaintext content under the right +key. +.Ss /etc/cgd/cgd.conf +The file +.Pa /etc/cgd/cgd.conf +is used to configure +.Nm +if either of +.Fl C +or +.Fl U +are specified. +Each line of the file is composed of either two or three +tokens: cgd, target, and optional paramsfile. +.Pp +A +.Sq \&# +character is interpreted as a comment and indicates that the +rest of the line should be ignored. +A +.Sq \e +at the end of a line indicates that the next line is a continuation of +the current line. +.Pp +If the second field is of the form +.Dq NAME= +then all the +.Xr dk 4 +wedge partitions are searched for one that has a wedge name equal to +.Ar +and the device corresponding to it is selected. +.Pp +If the second field starts with the prefix +.Dq ROOT. +the prefix is replaced with +.Dq /dev/[root_device] , +where +.Bq root_device +is the value of the +.Dq kern.root_device +sysctl. +.Pp +See +.Sx EXAMPLES +for an example of +.Pa /etc/cgd/cgd.conf . +.Ss Parameters File +The Parameters File contains the required information to generate the +key and configure a device. +These files are typically generated by the +.Fl g +flag and not edited by hand. +When a device is configured the default parameters file is constructed +by taking the basename of the target disk and prepending +.Pa /etc/cgd/ +to it. +E.g., if the target is +.Pa /dev/sd0h , +then the default parameters file will be +.Pa /etc/cgd/sd0h . +.Pp +It is possible to have more than one parameters file for a given +disk which use different key generation methods but will generate +the same key. +To create a parameters file that is equivalent to an existing parameters +file, use +.Nm +with the +.Fl G +flag. +See +.Sx EXAMPLES +for an example of this usage. +.Pp +The parameters file contains a list of statements each terminated +with a semi-colon. +Some statements can contain statement-blocks which are either a +single unadorned statement, or a brace-enclosed list of semicolon +terminated statements. +Three types of data are understood: +.Pp +.Bl -tag -compact -width integerxx +.It integer +a 32 bit signed integer. +.It string +a string. +.It base64 +a length-encoded base64 string. +.El +.Pp +The following statements are defined: +.Bl -tag -width indentxx +.It algorithm Ar string +Defines the cryptographic algorithm. +.It iv-method Ar string +Defines the IV generation method. +This should always be +.Sq encblkno1 +except when dealing with disks written with a very old version of +.Xr cgd 4 +from before +.Nx 5.0 , +released in 2010; see +.Xr cgd 4 +for details. +.It keylength Ar integer +Defines the length of the key. +.It verify_method Ar string +Defines the verification method. +.It keygen Ar string Ar statement_block +Defines a key generation method. +The +.Ar statement_block +contains statements that are specific to the key generation method. +.El +.Pp +The keygen statement's statement block may contain the following statements: +.Bl -tag -width indentxx +.It key Ar string +The key. +Only used for the storedkey key generation method. +.It cmd Ar string +The command to execute. +Only used for the shell_cmd key generation method. +.It iterations Ar integer +The number of iterations. +Only used for argon2id, pkcs5_pbkdf2/sha1, and pkcs5_pbkdf2. +.It salt Ar base64 +The salt. +Only used for argon2id, pkcs5_pbkdf2/sha1, and pkcs5_pbkdf2. +.It memory Ar integer +Memory consumption in kilobytes. +Only used for argon2id. +.It parallelism Ar integer +Number of threads to use to compute the password hash. +Should be equivalent to the number of CPUs/hardware threads. +Only used for argon2id. +.It version Ar integer +Version of Argon2 to use. +Should be the most recent version, currently +.Dv 19 . +Only used for argon2id. +.It shared Ar name No algorithm Ar kdf No subkey Ar info +Makes the key generation take an extra step to derive a subkey from the +main key using the key derivation function +.Ar kdf +with input +.Ar info . +.Pp +This enables a single password entry, for example, to decrypt multiple +disks that use different keys, each derived as a subkey from the main +key generated from the password. +.Bl -tag -width 6n +.It Ar name +A string used to identify the same main key generation shared between +parameters files for different disks listed in a single +.Pa cgd.conf +configuration file. +.It Ar kdf +The name of a key derivation function used to derive a subkey from the +main key. +Supported values: +.Bl -tag -width 6n -offset indent +.It Li hkdf-hmac-sha256 +The HKDF-Expand function of RFC 5869, instantiated with SHA-256. +.El +.It Ar info +A base64 length-encoded string to distinguish different subkeys derived +from a shared main key. +Need not be secret. +For example, it could be a nickname, or the disk's World-Wide Name, or +a UUID generated for the disk, or just a random string. +.El +.Pp +It is an error to reuse a shared key +.Ar name +with different keygen blocks, other than the +.Ar info +parameter, +between parameters files used by a single +.Pa cgd.conf +configuration file. +.El +.Sh FILES +.Bl -tag -width indentxxxxxxxxxxxxxxxxxx -compact +.It Pa /etc/cgd/ +configuration directory, used to store paramsfiles. +.It Pa /etc/cgd/cgd.conf +cgd configuration file. +.El +.Sh EXAMPLES +To set up and configure a cgd that uses adiantum, which takes a 256-bit +key: +.Bd -literal + # cgdconfig -g -k argon2id -o /etc/cgd/wd0e adiantum 256 + # cgdconfig cgd0 /dev/wd0e + /dev/wd0e's passphrase: +.Ed +.Pp +When using verification methods, the first time that we configure the +disk the verification method will fail. +We overcome this by supplying +.Fl V Ar re-enter +when we configure the first time to set up the disk. +Here is the +sequence of commands that is recommended: +.Bd -literal + # cgdconfig -g -k argon2id -o /etc/cgd/dk3 -V gpt adiantum + # cgdconfig -V re-enter cgd0 /dev/dk3 + /dev/dk3's passphrase: + re-enter device's passphrase: + # gpt create cgd0 + # cgdconfig -u cgd0 + # cgdconfig cgd0 /dev/dk3 + /dev/dk3's passphrase: +.Ed +.Pp +To scrub data from a disk before setting up a cgd: +.Bd -literal + # cgdconfig -s cgd0 /dev/sd0e adiantum 256 < /dev/urandom + # dd if=/dev/zero of=/dev/rcgd0d bs=32k progress=512 + # cgdconfig -u cgd0 +.Ed +.Pp +To create a new parameters file that will generate the same key as an old +parameters file: +.Bd -literal + # cgdconfig -G -o newparamsfile oldparamsfile + old file's passphrase: + new file's passphrase: +.Ed +.Pp +To create parameters files for three disks with subkeys derived from a +shared password-based key: +.Bd -literal + # cgdconfig -g -S -k argon2id -o /etc/cgd/wd0 -V gpt adiantum + # cgdconfig -g -S -P /etc/cgd/wd0 -o /etc/cgd/ld1 \e + -V disklabel aes-cbc 256 +.Ed +.Pp +Listing these in the same +.Pa /etc/cgd/cgd.conf +will allow you to enter a password once to decrypt both disks with +.Cm cgdconfig -C . +.Pp +To configure a cgd that uses aes-cbc with a 192 bit key that it +reads from stdin: +.Bd -literal + # cgdconfig -s cgd0 /dev/sd0h aes-cbc 192 +.Ed +.Pp +An example parameters file which uses PKCS#5 PBKDF2: +.Bd -literal + algorithm aes-cbc; + iv-method encblkno1; + keylength 128; + verify_method none; + keygen pkcs5_pbkdf2/sha1 { + iterations 39361; + salt AAAAgMoHiYonye6Kog \e + dYJAobCHE=; + }; +.Ed +.Pp +An example parameters file which stores its key locally: +.Bd -literal + algorithm adiantum; + iv-method encblkno1; + keylength 256; + verify_method none; + keygen storedkey key AAABAK3QO6d7xzLfrXTdsgg4 \e + ly2TdxkFqOkYYcbyUKu/f60L; +.Ed +.Pp +An example pair of configuration files which use shared keys so they +can be derived from a single passphrase entry, with the 64-bit +World-Wide Name of each disk (base64 length-encoded) as its subkey +info: +.Bl -tag -offset indent -width 6n +.It Pa /etc/cgd/wd0a +.Bd -literal +algorithm adiantum; +iv-method encblkno1; +keylength 256; +verify_method gpt; +keygen argon2id { + iterations 32; + memory 5214; + parallelism 2; + version 19; + salt AAAAgLZ5QgleU2m/Ib6wiPYxz98=; + shared "my laptop" algorithm hkdf-hmac-sha256 \e + subkey AAAAQEGELNr3bj3I; +}; +.Ed +.It Pa /etc/cgd/wd1a +.Bd -literal +algorithm adiantum; +iv-method encblkno1; +keylength 256; +verify_method gpt; +keygen argon2id { + iterations 32; + memory 5214; + parallelism 2; + version 19; + salt AAAAgLZ5QgleU2m/Ib6wiPYxz98=; + shared "my laptop" algorithm hkdf-hmac-sha256 \e + subkey AAAAQHSC15pr1Pe4; +}; +.Ed +.El +.Pp +An example +.Pa /etc/cgd/cgd.conf : +.Bd -literal + # + # /etc/cgd/cgd.conf + # Configuration file for cryptographic disk devices + # + + # cgd target [paramsfile] + cgd0 /dev/wd0e + cgd1 NAME=mycgd /usr/local/etc/cgd/mycgd +.Ed +.Pp +Note the first entry will store the parameters file as +.Pa /etc/cgd/wd0e . +And use the entered passphrase to generate the key. +.Pp +Although not required, the partition type +.Ar cgd +should be used in the disklabel or GPT type field for the cgd partition. +.Sh DIAGNOSTICS +.Bl -diag +.It "cgdconfig: could not calibrate pkcs5_pbkdf2" +An error greater than 5% in calibration occurred. +This could be the result of dynamic processor frequency scaling technology. +Ensure that the processor clock frequency remains static throughout the +program's execution. +.El +.Sh SEE ALSO +.Xr cgd 4 , +.Xr dk 4 , +.Xr fstab 5 , +.Xr disklabel 8 , +.Xr gpt 8 +.Rs +.%T "Argon2: the memory-hard function for password hashing and other applications" +.%A Alex Biryukov +.%A Daniel Dinu +.%A Dmitry Khovratovich +.%D 2017 +.%I University of Luxembourg +.%U https://www.password-hashing.net/ +.Re +.Rs +.%A H. Krawczyk +.%A P. Eronen +.%T HMAC-based Extract-and-Expand Key Derivation Function (HKDF) +.%I Internet Engineering Task Force +.%U https://www.rfc-editor.org/rfc/rfc5869.html +.%N RFC 5869 +.%D May 2010 +.Re +.Pp +.Dq PKCS #5 v2.0: Password-Based Cryptography Standard , +RSA Laboratories, March 25, 1999. +.Sh HISTORY +The +.Nm +utility appeared in +.Nx 2.0 . +.Pp +Support for +.Li argon2id +and for shared keys appeared in +.Nx 10.0 . +.Sh BUGS +Pass phrases are limited to 1023 bytes. diff --git a/static/netbsd/man8/chat.8 b/static/netbsd/man8/chat.8 new file mode 100644 index 00000000..899554c4 --- /dev/null +++ b/static/netbsd/man8/chat.8 @@ -0,0 +1,598 @@ +.\" NetBSD +.\" manual page [] for chat 1.8 +.\" SH section heading +.\" SS subsection heading +.\" LP paragraph +.\" IP indented paragraph +.\" TP hanging label +.TH CHAT 8 "22 May 1999" "Chat Version 1.22" +.SH NAME +chat \- Automated conversational script with a modem +.SH SYNOPSIS +.B chat +[ +.I options +] +.I script +.SH DESCRIPTION +.LP +The \fIchat\fR program defines a conversational exchange between the +computer and the modem. +Its primary purpose is to establish the +connection between the Point-to-Point Protocol Daemon (\fIpppd\fR) and +the remote's \fIpppd\fR process. +.SH OPTIONS +.TP +.B \-f \fI\*[Lt]chat file\*[Gt] +Read the chat script from the chat \fIfile\fR. +The use of this option +is mutually exclusive with the chat script parameters. +The user must +have read access to the file. +Multiple lines are permitted in the +file. +Space or horizontal tab characters should be used to separate +the strings. +.TP +.B \-t \fI\*[Lt]timeout\*[Gt] +Set the timeout for the expected string to be received. +If the string +is not received within the time limit then the reply string is not +sent. +An alternate reply may be sent or the script will fail if there +is no alternate reply string. +A failed script will cause the +\fIchat\fR program to terminate with a non-zero error code. +.TP +.B \-r \fI\*[Lt]report file\*[Gt] +Set the file for output of the report strings. +If you use the keyword +\fIREPORT\fR, the resulting strings are written to this file. +If this +option is not used and you still use \fIREPORT\fR keywords, the +\fIstderr\fR file is used for the report strings. +.TP +.B \-e +Start with the echo option turned on. +Echoing may also be turned on +or off at specific points in the chat script by using the \fIECHO\fR +keyword. +When echoing is enabled, all output from the modem is echoed +to \fIstderr\fR. +.TP +.B \-E +Enables environment variable substitution within chat scripts using the +standard \fI$xxx\fR syntax. +.TP +.B \-v +Request that the \fIchat\fR script be executed in a verbose mode. +The +\fIchat\fR program will then log the execution state of the chat +script as well as all text received from the modem and the output +strings sent to the modem. + The default is to log through the SYSLOG; +the logging method may be altered with the \-S and \-s flags. +.TP +.B \-V +Request that the \fIchat\fR script be executed in a stderr verbose +mode. +The \fIchat\fR program will then log all text received from the +modem and the output strings sent to the modem to the stderr device. +This +device is usually the local console at the station running the chat or +pppd program. +.TP +.B \-s +Use stderr. + All log messages from '\-v' and all error messages will be +sent to stderr. +.TP +.B \-S +Do not use the SYSLOG. + By default, error messages are sent to the +SYSLOG. + The use of \-S will prevent both log messages from '\-v' and +error messages from being sent to the SYSLOG. +.TP +.B \-T \fI\*[Lt]phone number\*[Gt] +Pass in an arbitrary string, usually a phone number, that will be +substituted for the \eT substitution metacharacter in a send string. +.TP +.B \-U \fI\*[Lt]phone number 2\*[Gt] +Pass in a second string, usually a phone number, that will be +substituted for the \eU substitution metacharacter in a send string. +This is useful when dialing an ISDN terminal adapter that requires two +numbers. +.TP +.B script +If the script is not specified in a file with the \fI\-f\fR option then +the script is included as parameters to the \fIchat\fR program. +.SH CHAT SCRIPT +.LP +The \fIchat\fR script defines the communications. +.LP +A script consists of one or more "expect\-send" pairs of strings, +separated by spaces, with an optional "subexpect\-subsend" string pair, +separated by a dash as in the following example: +.IP +ogin:\-BREAK\-ogin: ppp ssword: hello2u2 +.LP +This line indicates that the \fIchat\fR program should expect the string +"ogin:". +If it fails to receive a login prompt within the time interval +allotted, it is to send a break sequence to the remote and then expect the +string "ogin:". +If the first "ogin:" is received then the break sequence is +not generated. +.LP +Once it received the login prompt the \fIchat\fR program will send the +string ppp and then expect the prompt "ssword:". +When it receives the +prompt for the password, it will send the password hello2u2. +.LP +A carriage return is normally sent following the reply string. +It is not +expected in the "expect" string unless it is specifically requested by using +the \er character sequence. +.LP +The expect sequence should contain only what is needed to identify the +string. +Since it is normally stored on a disk file, it should not contain +variable information. +It is generally not acceptable to look for time +strings, network identification strings, or other variable pieces of data as +an expect string. +.LP +To help correct for characters which may be corrupted during the initial +sequence, look for the string "ogin:" rather than "login:". +It is possible +that the leading "l" character may be received in error and you may never +find the string even though it was sent by the system. +For this reason, +scripts look for "ogin:" rather than "login:" and "ssword:" rather than +"password:". +.LP +A very simple script might look like this: +.IP +ogin: ppp ssword: hello2u2 +.LP +In other words, expect ....ogin:, send ppp, expect ...ssword:, send hello2u2. +.LP +In actual practice, simple scripts are rare. +At the vary least, you +should include sub-expect sequences should the original string not be +received. +For example, consider the following script: +.IP +ogin:\-\-ogin: ppp ssword: hello2u2 +.LP +This would be a better script than the simple one used earlier. +This would look +for the same login: prompt, however, if one was not received, a single +return sequence is sent and then it will look for login: again. +Should line +noise obscure the first login prompt then sending the empty line will +usually generate a login prompt again. +.SH COMMENTS +Comments can be embedded in the chat script. +A comment is a line which +starts with the \fB#\fR (hash) character in column 1. +Such comment lines are just ignored by the chat program. +If a '#' character is to +be expected as the first character of the expect sequence, you should +quote the expect string. +If you want to wait for a prompt that starts with a # (hash) +character, you would have to write something like this: +.IP +# Now wait for the prompt and send logout string +.br +\&'# ' logout +.LP + +.SH SENDING DATA FROM A FILE +If the string to send starts with an at sign (@), the rest of the +string is taken to be the name of a file to read to get the string to +send. +If the last character of the data read is a newline, it is removed. +The file can be a named pipe (or fifo) instead of a regular file. +This provides a way for \fBchat\fR to communicate with another +program, for example, a program to prompt the user and receive a +password typed in. +.LP + +.SH ABORT STRINGS +Many modems will report the status of the call as a string. +These +strings may be \fBCONNECTED\fR or \fBNO CARRIER\fR or \fBBUSY\fR. +It is often desirable to terminate the script should the modem fail to +connect to the remote. +The difficulty is that a script would not know +exactly which modem string it may receive. +On one attempt, it may +receive \fBBUSY\fR while the next time it may receive \fBNO CARRIER\fR. +.LP +These "abort" strings may be specified in the script using the \fIABORT\fR +sequence. +It is written in the script as in the following example: +.IP +ABORT BUSY ABORT 'NO CARRIER' '' ATZ OK ATDT5551212 CONNECT +.LP +This sequence will expect nothing; and then send the string ATZ. +The expected response to this is the string \fIOK\fR. +When it receives \fIOK\fR, +the string ATDT5551212 to dial the telephone. +The expected string is +\fICONNECT\fR. +If the string \fICONNECT\fR is received the remainder of the +script is executed. +However, should the modem find a busy telephone, it will +send the string \fIBUSY\fR. +This will cause the string to match the abort character sequence. +The script will then fail because it found a match to the abort string. +If it received the string \fINO CARRIER\fR, it will abort +for the same reason. +Either string may be received. +Either string will terminate the \fIchat\fR script. +.SH CLR_ABORT STRINGS +This sequence allows for clearing previously set \fBABORT\fR strings. +\fBABORT\fR strings are kept in an array of a pre-determined size (at +compilation time); \fBCLR_ABORT\fR will reclaim the space for cleared +entries so that new strings can use that space. +.SH SAY STRINGS +The \fBSAY\fR directive allows the script to send strings to the user +at the terminal via standard error. + If \fBchat\fR is being run by +pppd, and pppd is running as a daemon (detached from its controlling +terminal), standard error will normally be redirected to the file +/etc/ppp/connect\-errors. +.LP +\fBSAY\fR strings must be enclosed in single or double quotes. +If +carriage return and line feed are needed in the string to be output, +you must explicitly add them to your string. +.LP +The SAY strings could be used to give progress messages in sections of +the script where you want to have 'ECHO OFF' but still let the user +know what is happening. + An example is: +.IP +ABORT BUSY +.br +ECHO OFF +.br +SAY "Dialling your ISP...\en" +.br +\&'' ATDT5551212 +.br +TIMEOUT 120 +.br +SAY "Waiting up to 2 minutes for connection ... +" +.br +CONNECT '' +.br +SAY "Connected, now logging in ...\en" +.br +ogin: account +.br +ssword: pass +.br +$ \ec +.br +SAY "Logged in OK ...\en" +\fIetc ...\fR +.LP +This sequence will only present the SAY strings to the user and all +the details of the script will remain hidden. +For example, if the +above script works, the user will see: +.IP +Dialling your ISP... +.br +Waiting up to 2 minutes for connection ... +Connected, now logging in ... +.br +Logged in OK ... +.LP + +.SH REPORT STRINGS +A \fBreport\fR string is similar to the ABORT string. +The difference +is that the strings, and all characters to the next control character +such as a carriage return, are written to the report file. +.LP +The report strings may be used to isolate the transmission rate of the +modem's connect string and return the value to the chat user. +The analysis of the report string logic occurs in conjunction with the +other string processing such as looking for the expect string. +The use +of the same string for a report and abort sequence is probably not +very useful, however, it is possible. +.LP +The report strings to no change the completion code of the program. +.LP +These "report" strings may be specified in the script using the \fIREPORT\fR +sequence. +It is written in the script as in the following example: +.IP +REPORT CONNECT ABORT BUSY '' ATDT5551212 CONNECT '' ogin: account +.LP +This sequence will expect nothing; and then send the string +ATDT5551212 to dial the telephone. +The expected string is +\fICONNECT\fR. +If the string \fICONNECT\fR is received the remainder +of the script is executed. +In addition the program will write to the +expect\-file the string "CONNECT" plus any characters which follow it +such as the connection rate. +.SH CLR_REPORT STRINGS +This sequence allows for clearing previously set \fBREPORT\fR strings. +\fBREPORT\fR strings are kept in an array of a pre-determined size (at +compilation time); \fBCLR_REPORT\fR will reclaim the space for cleared +entries so that new strings can use that space. +.SH ECHO +The echo options controls whether the output from the modem is echoed +to \fIstderr\fR. +This option may be set with the \fI\-e\fR option, but +it can also be controlled by the \fIECHO\fR keyword. +The "expect\-send" +pair \fIECHO\fR \fION\fR enables echoing, and \fIECHO\fR \fIOFF\fR +disables it. +With this keyword you can select which parts of the +conversation should be visible. +For instance, with the following +script: +.IP +ABORT 'BUSY' +.br +ABORT 'NO CARRIER' +.br +\&'' ATZ +.br +OK\er\en ATD1234567 +.br +\er\en \ec +.br +ECHO ON +.br +CONNECT \ec +.br +ogin: account +.LP +all output resulting from modem configuration and dialing is not visible, +but starting with the \fICONNECT\fR (or \fIBUSY\fR) message, everything +will be echoed. +.SH HANGUP +The HANGUP options control whether a modem hangup should be considered +as an error or not. + This option is useful in scripts for dialling +systems which will hang up and call your system back. + The HANGUP +options can be \fBON\fR or \fBOFF\fR. +.br +When HANGUP is set OFF and the modem hangs up (e.g., after the first +stage of logging in to a callback system), \fBchat\fR will continue +running the script (e.g., waiting for the incoming call and second +stage login prompt). +As soon as the incoming call is connected, you +should use the \fBHANGUP ON\fR directive to reinstall normal hang up +signal behavior. + Here is an (simple) example script: +.IP +ABORT 'BUSY' +.br +\&'' ATZ +.br +OK\er\en ATD1234567 +.br +\er\en \ec +.br +CONNECT \ec +.br +\&'Callback login:' call_back_ID +.br +HANGUP OFF +.br +ABORT "Bad Login" +.br +\&'Callback Password:' Call_back_password +.br +TIMEOUT 120 +.br +CONNECT \ec +.br +HANGUP ON +.br +ABORT "NO CARRIER" +.br +ogin:\-\-BREAK\-\-ogin: real_account +.br +\fIetc ...\fR +.LP +.SH TIMEOUT +The initial timeout value is 45 seconds. +This may be changed using the \fB\-t\fR parameter. +.LP +To change the timeout value for the next expect string, the following +example may be used: +.IP +ATZ OK ATDT5551212 CONNECT TIMEOUT 10 ogin:\-\-ogin: TIMEOUT 5 assword: hello2u2 +.LP +This will change the timeout to 10 seconds when it expects the login: +prompt. +The timeout is then changed to 5 seconds when it looks for the +password prompt. +.LP +The timeout, once changed, remains in effect until it is changed again. +.SH SENDING EOT +The special reply string of \fIEOT\fR indicates that the chat program +should send an EOT character to the remote. +This is normally the +End-of-file character sequence. +A return character is not sent +following the EOT. +The EOT sequence may be embedded into the send string using the +sequence \fI^D\fR. +.SH GENERATING BREAK +The special reply string of \fIBREAK\fR will cause a break condition +to be sent. +The break is a special signal on the transmitter. +The +normal processing on the receiver is to change the transmission rate. +It may be used to cycle through the available transmission rates on +the remote until you are able to receive a valid login prompt. +The break sequence may be embedded into the send string using the +\fI\eK\fR sequence. +.SH ESCAPE SEQUENCES +The expect and reply strings may contain escape sequences. +All of the +sequences are legal in the reply string. +Many are legal in the expect. +Those which are not valid in the expect sequence are so indicated. +.TP +.B '' +Expects or sends a null string. +If you send a null string then it will still +send the return character. +This sequence may either be a pair of apostrophe +or quote characters. +.TP +.B \eb +represents a backspace character. +.TP +.B \ec +Suppresses the newline at the end of the reply string. +This is the only +method to send a string without a trailing return character. +It must +be at the end of the send string. +For example, +the sequence hello\ec will simply send the characters h, e, l, l, o. +.I (not valid in expect.) +.TP +.B \ed +Delay for one second. +The program uses sleep(1) which will delay to a +maximum of one second. +.I (not valid in expect.) +.TP +.B \eK +Insert a BREAK +.I (not valid in expect.) +.TP +.B \en +Send a newline or linefeed character. +.TP +.B \eN +Send a null character. +The same sequence may be represented by \e0. +.I (not valid in expect.) +.TP +.B \ep +Pause for a fraction of a second. +The delay is 1/10th of a second. +.I (not valid in expect.) +.TP +.B \eq +Suppress writing the string to the SYSLOG file. +The string ?????? is +written to the log in its place. +.I (not valid in expect.) +.TP +.B \er +Send or expect a carriage return. +.TP +.B \es +Represents a space character in the string. +This may be used when it +is not desirable to quote the strings which contains spaces. +The +sequence 'HI TIM' and HI\esTIM are the same. +.TP +.B \et +Send or expect a tab character. +.TP +.B \eT +Send the phone number string as specified with the \fI\-T\fR option +.I (not valid in expect.) +.TP +.B \eU +Send the phone number 2 string as specified with the \fI\-U\fR option +.I (not valid in expect.) +.TP +.B \e\e +Send or expect a backslash character. +.TP +.B \eddd +Collapse the octal digits (ddd) into a single ASCII character and send that +character. +.I (some characters are not valid in expect.) +.TP +.B \^^C +Substitute the sequence with the control character represented by C. +For example, the character DC1 (17) is shown as \^^Q. +.I (some characters are not valid in expect.) +.SH ENVIRONMENT VARIABLES +Environment variables are available within chat scripts, if the \fI\-E\fR +option was specified in the command line. +The metacharacter \fI$\fR is used +to introduce the name of the environment variable to substitute. +If the +substitution fails, because the requested environment variable is not set, +\fInothing\fR is replaced for the variable. +.SH TERMINATION CODES +The \fIchat\fR program will terminate with the following completion +codes. +.TP +.B 0 +The normal termination of the program. +This indicates that the script +was executed without error to the normal conclusion. +.TP +.B 1 +One or more of the parameters are invalid or an expect string was too +large for the internal buffers. +This indicates that the program as not +properly executed. +.TP +.B 2 +An error occurred during the execution of the program. +This may be due +to a read or write operation failing for some reason or chat receiving +a signal such as SIGINT. +.TP +.B 3 +A timeout event occurred when there was an \fIexpect\fR string without +having a "\-subsend" string. +This may mean that you did not program the +script correctly for the condition or that some unexpected event has +occurred and the expected string could not be found. +.TP +.B 4 +The first string marked as an \fIABORT\fR condition occurred. +.TP +.B 5 +The second string marked as an \fIABORT\fR condition occurred. +.TP +.B 6 +The third string marked as an \fIABORT\fR condition occurred. +.TP +.B 7 +The fourth string marked as an \fIABORT\fR condition occurred. +.TP +.B ... +The other termination codes are also strings marked as an \fIABORT\fR +condition. +.LP +Using the termination code, it is possible to determine which event +terminated the script. +It is possible to decide if the string "BUSY" +was received from the modem as opposed to "NO DIAL TONE". +While the +first event may be retried, the second will probably have little +chance of succeeding during a retry. +.SH COPYRIGHT +The \fIchat\fR program is in public domain. +This is not the GNU public license. +If it breaks then you get to keep both pieces. diff --git a/static/netbsd/man8/chkconfig.8 b/static/netbsd/man8/chkconfig.8 new file mode 100644 index 00000000..41205a0c --- /dev/null +++ b/static/netbsd/man8/chkconfig.8 @@ -0,0 +1,133 @@ +.\" $NetBSD: chkconfig.8,v 1.6 2003/02/25 10:34:53 wiz Exp $ +.\" +.\" Copyright (c) 2001 Zembu Labs, Inc. +.\" All rights reserved. +.\" +.\" Author: Dan Mercer +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by Zembu Labs, Inc. +.\" 4. Neither the name of Zembu Labs nor the names of its employees may +.\" be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY ZEMBU LABS, INC. ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WAR- +.\" RANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS- +.\" CLAIMED. IN NO EVENT SHALL ZEMBU LABS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd March 13, 2001 +.Dt CHKCONFIG 8 +.Os +.Sh NAME +.Nm chkconfig +.Nd rc.conf.d management utility +.Sh SYNOPSIS +.Nm +.Op Ar service +.Nm +.Op Fl f +.Ar service +.Op Ar on | off +.Sh DESCRIPTION +The +.Nm +utility allows a system administrator to easily manage services +started by +.Xr rc 8 . +.Pp +With no arguments, +.Nm +will print the state (on or off) of every service found in the +directory +.Pa /etc/rc.conf.d/ . +The settings will be shown sorted according to the output of +.Xr rcorder 8 . +.Pp +If the +.Ar service +is specified as the sole argument, +.Nm +exits with status 0 if the service is +.Sq on +and status 1 if +.Sq off . +The exit status may be used by shell scripts to test the state of +a service, for example: +.Bd -literal -offset indent +if chkconfig wscons; then + echo "wscons is on" +else + echo "wscons is off" +fi +.Ed +.Pp +The optional third argument allows the specified service to be set +to +.Sq on +or +.Sq off +for the next time its +.Xr rc.d 8 +script is run (generally the next system reboot). +.Pp +In order for +.Nm +to display service status or to control service state, the service +must be managed by +.Nm . +A +.Nm +managed service is one that has the +.Xr rcorder 8 +keyword +.Dq chkconfig +present in the +.Xr rc.d 8 +script for that service. +If a service's script does not contain +this keyword, it may still be managed by +.Nm +using the +.Fl f +flag. +When this flag is used, +.Nm +will automatically add the +.Dq chkconfig +keyword to the service's script. +.Sh SEE ALSO +.Xr rc 8 , +.Xr rcorder 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 1.6 . +.Sh AUTHORS +The +.Nm +program was written by +.An Dan Mercer +.Aq dmercer@zembu.com +of Zembu Labs, Inc. +.Sh BUGS +The +.Nm +program currently does not support configuring the options +to be passed to services upon startup. diff --git a/static/netbsd/man8/chown.8 b/static/netbsd/man8/chown.8 new file mode 100644 index 00000000..65790963 --- /dev/null +++ b/static/netbsd/man8/chown.8 @@ -0,0 +1,189 @@ +.\" Copyright (c) 1990, 1991, 1993, 1994, 2003 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)chown.8 8.3 (Berkeley) 3/31/94 +.\" $NetBSD: chown.8,v 1.14 2023/05/20 00:54:15 pgoyette Exp $ +.\" +.Dd May 19, 2023 +.Dt CHOWN 8 +.Os +.Sh NAME +.Nm chown +.Nd change file owner and group +.Sh SYNOPSIS +.Nm +.Oo +.Fl R +.Op Fl H | Fl L | Fl P +.Oc +.Op Fl dfhv +.Ar owner Ns Op Ar :group +.Ar +.Nm +.Oo +.Fl R +.Op Fl H | Fl L | Fl P +.Oc +.Op Fl dfhv +.Ar :group +.Ar +.Nm +.Oo +.Fl R +.Op Fl H | Fl L | Fl P +.Oc +.Op Fl dfhv +.Fl Fl reference=rfile +.Ar +.Sh DESCRIPTION +.Nm +sets the user ID and/or the group ID of the specified files. +Symbolic links named by arguments are silently left unchanged unless +.Fl h +is used. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl H +If the +.Fl R +option is specified, symbolic links on the command line are followed. +(Symbolic links encountered in the tree traversal are not followed.) +.It Fl L +If the +.Fl R +option is specified, all symbolic links are followed. +.It Fl P +If the +.Fl R +option is specified, no symbolic links are followed. +.It Fl R +Change the user ID and/or the group ID for the file hierarchies rooted +in the files instead of just the files themselves. +.It Fl d +Do not attempt to update a file's owner or group or its set-user-id +and set-group-id bits if they are all already set to the desired values. +.It Fl f +Do not report any failure to change file owner or group, nor modify +the exit status to reflect such failures. +.It Fl h +If +.Ar file +is a symbolic link, the owner and/or group of the link is changed. +.It Fl v +Cause +.Nm +to be verbose, showing files as they are processed. +.El +.Pp +The +.Fl H , +.Fl L +and +.Fl P +options are ignored unless the +.Fl R +option is specified. +In addition, these options override each other and the +command's actions are determined by the last one specified. +The default is as if the +.Fl P +option had been specified. +.Pp +The +.Fl L +option cannot be used together with the +.Fl h +option. +.Pp +The +.Ar owner +and +.Ar group +operands are both optional, however, one must be specified; alternatively, +both the owner and group may be specified using a reference +.Ar rfile +specified using the +.Fl Fl reference +argument. +If the +.Ar group +operand is specified, it must be preceded by a colon (``:'') character. +.Pp +The +.Ar owner +may be either a user name or a numeric user ID. +The +.Ar group +may be either a group name or a numeric group ID. +Since it is valid to have a user or group name that is numeric (and +does not have the numeric ID that matches its name) the name lookup +is always done first. +Preceding an ID with a ``#'' character will force it to be taken +as a number. +.Pp +The ownership of a file may only be altered by a super-user for +obvious security reasons. +.Pp +Unless invoked by the super-user, +.Nm +clears the set-user-id and set-group-id bits on a file to prevent +accidental or mischievous creation of set-user-id and set-group-id +programs. +.Sh EXIT STATUS +.Ex -std chown +.Sh COMPATIBILITY +Previous versions of the +.Nm +utility used the dot (``.'') character to distinguish the group name. +This has been changed to be a colon (``:'') character so that user and +group names may contain the dot character. +.Sh SEE ALSO +.Xr chflags 1 , +.Xr chgrp 1 , +.Xr find 1 , +.Xr chown 2 , +.Xr lchown 2 , +.Xr fts 3 , +.Xr symlink 7 +.Sh STANDARDS +The +.Nm +command is expected to be POSIX 1003.2 compliant. +.Pp +The +.Fl v +and +.Fl d +options and the use of ``#'' to force a numeric lookup +are extensions to +.St -p1003.2 . +.Sh HISTORY +A +.Nm +utility appeared in +.At v1 . diff --git a/static/netbsd/man8/chroot.8 b/static/netbsd/man8/chroot.8 new file mode 100644 index 00000000..1125a7df --- /dev/null +++ b/static/netbsd/man8/chroot.8 @@ -0,0 +1,100 @@ +.\" $NetBSD: chroot.8,v 1.14 2011/08/15 14:43:17 wiz Exp $ +.\" +.\" Copyright (c) 1988, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)chroot.8 8.1 (Berkeley) 6/9/93 +.\" +.Dd August 13, 2011 +.Dt CHROOT 8 +.Os +.Sh NAME +.Nm chroot +.Nd change root directory +.Sh SYNOPSIS +.Nm +.Op Fl G Ar group,group,... +.Op Fl g Ar group +.Op Fl u Ar user +.Ar newroot +.Op Ar command +.Sh DESCRIPTION +The +.Nm +command changes its root directory to the supplied directory +.Ar newroot +and exec's +.Ar command , +or, if not supplied, an interactive copy of your shell. +.Pp +If the +.Fl u , +.Fl g , +or +.Fl G +options are given, the user, group, and group list of the process are +set to these values after the chroot has taken place; see +.Xr setgid 2 , +.Xr setgroups 2 , +.Xr setuid 2 , +.Xr getgrnam 3 , +and +.Xr getpwnam 3 . +.Pp +Note: +.Ar command +or the shell are run as your real-user-id. +.Sh ENVIRONMENT +The following environment variable is referenced by +.Nm : +.Bl -tag -width SHELL +.It Ev SHELL +If set, +the string specified by +.Ev SHELL +is interpreted as the name of +the shell to exec. +If the variable +.Ev SHELL +is not set, +.Pa /bin/sh +is used. +.El +.Sh SEE ALSO +.Xr ldd 1 , +.Xr chdir 2 , +.Xr chroot 2 , +.Xr environ 7 +.Sh HISTORY +The +.Nm +utility first appeared in +.Bx 4.4 . +.Sh SECURITY CONSIDERATIONS +.Nm +should never be installed setuid root, as it would then be possible +to exploit the program to gain root privileges. diff --git a/static/netbsd/man8/cleanup.8 b/static/netbsd/man8/cleanup.8 new file mode 100644 index 00000000..2bc67076 --- /dev/null +++ b/static/netbsd/man8/cleanup.8 @@ -0,0 +1,553 @@ +.\" $NetBSD: cleanup.8,v 1.5 2025/02/25 19:15:42 christos Exp $ +.\" +.TH CLEANUP 8 +.ad +.fi +.SH NAME +cleanup +\- +canonicalize and enqueue Postfix message +.SH "SYNOPSIS" +.na +.nf +\fBcleanup\fR [generic Postfix daemon options] +.SH DESCRIPTION +.ad +.fi +The \fBcleanup\fR(8) daemon processes inbound mail, inserts it +into the \fBincoming\fR mail queue, and informs the queue +manager of its arrival. + +The \fBcleanup\fR(8) daemon performs the following transformations: +.IP \(bu +Insert missing message headers: (\fBResent\-\fR) \fBFrom:\fR, +\fBTo:\fR, \fBMessage\-Id:\fR, and \fBDate:\fR. +.br +This is enabled with the \fBlocal_header_rewrite_clients\fR and +\fBalways_add_missing_headers\fR parameter settings. +.IP \(bu +Transform envelope and header addresses to the standard +\fIuser@fully\-qualified\-domain\fR form that is expected by other +Postfix programs. +This task depends on the \fBtrivial\-rewrite\fR(8) daemon. +.br +The header transformation is enabled with the +\fBlocal_header_rewrite_clients\fR parameter setting. +.IP \(bu +Eliminate duplicate envelope recipient addresses. +.br +This is enabled with the \fBduplicate_filter_limit\fR +parameter setting. +.IP \(bu +Remove message headers: \fBBcc\fR, \fBContent\-Length\fR, +\fBResent\-Bcc\fR, \fBReturn\-Path\fR. +.br +This is enabled with the message_drop_headers parameter +setting. +.IP \(bu +Optionally, rewrite all envelope and header addresses according +to the mappings specified in the \fBcanonical\fR(5) lookup tables. +.br +The header transformation is enabled with the +\fBlocal_header_rewrite_clients\fR parameter setting. +.IP \(bu +Optionally, masquerade envelope sender addresses and message +header addresses (i.e. strip host or domain information below +all domains listed in the \fBmasquerade_domains\fR parameter, +except for user names listed in \fBmasquerade_exceptions\fR). +By default, address masquerading does not affect envelope recipients. +.br +The header transformation is enabled with the +\fBlocal_header_rewrite_clients\fR parameter setting. +.IP \(bu +Optionally, expand envelope recipients according to information +found in the \fBvirtual_alias_maps\fR lookup tables. +.PP +The \fBcleanup\fR(8) daemon performs sanity checks on the content of +each message. When it finds a problem, by default it returns a +diagnostic status to the cleanup service client, and leaves +it up to the client +to deal with the problem. Alternatively, the client can request +the \fBcleanup\fR(8) daemon to bounce the message back to the sender +in case of trouble. +.SH "STANDARDS" +.na +.nf +RFC 822 (ARPA Internet Text Messages) +RFC 2045 (MIME: Format of Internet Message Bodies) +RFC 2046 (MIME: Media Types) +RFC 2822 (Internet Message Format) +RFC 3463 (Enhanced Status Codes) +RFC 3464 (Delivery status notifications) +RFC 5322 (Internet Message Format) +RFC 8689 (TLS\-Required: message header) +.SH DIAGNOSTICS +.ad +.fi +Problems and transactions are logged to \fBsyslogd\fR(8) +or \fBpostlogd\fR(8). +.SH BUGS +.ad +.fi +Table\-driven rewriting rules make it hard to express \fBif then +else\fR and other logical relationships. +.SH "CONFIGURATION PARAMETERS" +.na +.nf +.ad +.fi +Changes to \fBmain.cf\fR are picked up automatically, as +\fBcleanup\fR(8) +processes run for only a limited amount of time. Use the command +"\fBpostfix reload\fR" to speed up a change. + +The text below provides only a parameter summary. See +\fBpostconf\fR(5) for more details including examples. +.SH "COMPATIBILITY CONTROLS" +.na +.nf +.ad +.fi +.IP "\fBundisclosed_recipients_header (see 'postconf -d' output)\fR" +Message header that the Postfix \fBcleanup\fR(8) server inserts when a +message contains no To: or Cc: message header. +.PP +Available in Postfix version 2.1 only: +.IP "\fBenable_errors_to (no)\fR" +Report mail delivery errors to the address specified with the +non\-standard Errors\-To: message header, instead of the envelope +sender address (this feature is removed with Postfix version 2.2, is +turned off by default with Postfix version 2.1, and is always turned on +with older Postfix versions). +.PP +Available in Postfix version 2.6 and later: +.IP "\fBalways_add_missing_headers (no)\fR" +Always add (Resent\-) From:, To:, Date: or Message\-ID: headers +when not present. +.PP +Available in Postfix version 2.9 and later: +.IP "\fBenable_long_queue_ids (no)\fR" +Enable long, non\-repeating, queue IDs (queue file names). +.SH "HEADER FORMATTING CONTROLS" +.na +.nf +.ad +.fi +.PP +Available in Postfix version 3.0 and later: +.IP "\fBmessage_drop_headers (bcc, content\-length, resent\-bcc, return\-path)\fR" +Names of message headers that the \fBcleanup\fR(8) daemon will remove +after applying \fBheader_checks\fR(5) and before invoking Milter applications. +.PP +Available in Postfix version 3.3 and later: +.IP "\fBheader_from_format (standard)\fR" +The format of the Postfix\-generated \fBFrom:\fR header. +.PP +Available in Postfix version 3.10 and later: +.IP "\fBfull_name_encoding_charset (utf\-8)\fR" +The character set name (also called "charset") that Postfix +will output when it automatically generates an RFC 2047 encoded +full name. +.SH "BUILT-IN CONTENT FILTERING CONTROLS" +.na +.nf +.ad +.fi +Postfix built\-in content filtering is meant to stop a flood of +worms or viruses. It is not a general content filter. +.IP "\fBbody_checks (empty)\fR" +Optional lookup tables for content inspection as specified in +the \fBbody_checks\fR(5) manual page. +.IP "\fBheader_checks (empty)\fR" +Optional lookup tables for content inspection of primary non\-MIME +message headers, as specified in the \fBheader_checks\fR(5) manual page. +.PP +Available in Postfix version 2.0 and later: +.IP "\fBbody_checks_size_limit (51200)\fR" +How much text in a message body segment (or attachment, if you +prefer to use that term) is subjected to body_checks inspection. +.IP "\fBmime_header_checks ($header_checks)\fR" +Optional lookup tables for content inspection of MIME related +message headers, as described in the \fBheader_checks\fR(5) manual page. +.IP "\fBnested_header_checks ($header_checks)\fR" +Optional lookup tables for content inspection of non\-MIME message +headers in attached messages, as described in the \fBheader_checks\fR(5) +manual page. +.PP +Available in Postfix version 2.3 and later: +.IP "\fBmessage_reject_characters (empty)\fR" +The set of characters that Postfix will reject in message +content. +.IP "\fBmessage_strip_characters (empty)\fR" +The set of characters that Postfix will remove from message +content. +.PP +Available in Postfix version 3.9, 3.8.5, 3.7.10, 3.6.14, +3.5.24, and later: +.IP "\fBcleanup_replace_stray_cr_lf (yes)\fR" +Replace each stray or character in message +content with a space character, to prevent outbound SMTP smuggling, +and to make the evaluation of Postfix\-added DKIM or other signatures +independent from how a remote mail server handles such characters. +.SH "BEFORE QUEUE MILTER CONTROLS" +.na +.nf +.ad +.fi +As of version 2.3, Postfix supports the Sendmail version 8 +Milter (mail filter) protocol. When mail is not received via +the smtpd(8) server, the cleanup(8) server will simulate +SMTP events to the extent that this is possible. For details +see the MILTER_README document. +.IP "\fBnon_smtpd_milters (empty)\fR" +A list of Milter (mail filter) applications for new mail that +does not arrive via the Postfix \fBsmtpd\fR(8) server. +.IP "\fBmilter_protocol (6)\fR" +The mail filter protocol version and optional protocol extensions +for communication with a Milter application; prior to Postfix 2.6 +the default protocol is 2. +.IP "\fBmilter_default_action (tempfail)\fR" +The default action when a Milter (mail filter) response is +unavailable (for example, bad Postfix configuration or Milter +failure). +.IP "\fBmilter_macro_daemon_name ($myhostname)\fR" +The {daemon_name} macro value for Milter (mail filter) applications. +.IP "\fBmilter_macro_v ($mail_name $mail_version)\fR" +The {v} macro value for Milter (mail filter) applications. +.IP "\fBmilter_connect_timeout (30s)\fR" +The time limit for connecting to a Milter (mail filter) +application, and for negotiating protocol options. +.IP "\fBmilter_command_timeout (30s)\fR" +The time limit for sending an SMTP command to a Milter (mail +filter) application, and for receiving the response. +.IP "\fBmilter_content_timeout (300s)\fR" +The time limit for sending message content to a Milter (mail +filter) application, and for receiving the response. +.IP "\fBmilter_connect_macros (see 'postconf -d' output)\fR" +The macros that are sent to Milter (mail filter) applications +after completion of an SMTP connection. +.IP "\fBmilter_helo_macros (see 'postconf -d' output)\fR" +The macros that are sent to Milter (mail filter) applications +after the SMTP HELO or EHLO command. +.IP "\fBmilter_mail_macros (see 'postconf -d' output)\fR" +The macros that are sent to Milter (mail filter) applications +after the SMTP MAIL FROM command. +.IP "\fBmilter_rcpt_macros (see 'postconf -d' output)\fR" +The macros that are sent to Milter (mail filter) applications +after the SMTP RCPT TO command. +.IP "\fBmilter_data_macros (see 'postconf -d' output)\fR" +The macros that are sent to version 4 or higher Milter (mail +filter) applications after the SMTP DATA command. +.IP "\fBmilter_unknown_command_macros (see 'postconf -d' output)\fR" +The macros that are sent to version 3 or higher Milter (mail +filter) applications after an unknown SMTP command. +.IP "\fBmilter_end_of_data_macros (see 'postconf -d' output)\fR" +The macros that are sent to Milter (mail filter) applications +after the message end\-of\-data. +.PP +Available in Postfix version 2.5 and later: +.IP "\fBmilter_end_of_header_macros (see 'postconf -d' output)\fR" +The macros that are sent to Milter (mail filter) applications +after the end of the message header. +.PP +Available in Postfix version 2.7 and later: +.IP "\fBmilter_header_checks (empty)\fR" +Optional lookup tables for content inspection of message headers +that are produced by Milter applications. +.PP +Available in Postfix version 3.1 and later: +.IP "\fBmilter_macro_defaults (empty)\fR" +Optional list of \fIname=value\fR pairs that specify default +values for arbitrary macros that Postfix may send to Milter +applications. +.SH "MIME PROCESSING CONTROLS" +.na +.nf +.ad +.fi +Available in Postfix version 2.0 and later: +.IP "\fBdisable_mime_input_processing (no)\fR" +Turn off MIME processing while receiving mail. +.IP "\fBmime_boundary_length_limit (2048)\fR" +The maximal length of MIME multipart boundary strings. +.IP "\fBmime_nesting_limit (100)\fR" +The maximal recursion level that the MIME processor will handle. +.IP "\fBstrict_8bitmime (no)\fR" +Enable both strict_7bit_headers and strict_8bitmime_body. +.IP "\fBstrict_7bit_headers (no)\fR" +Reject mail with 8\-bit text in message headers. +.IP "\fBstrict_8bitmime_body (no)\fR" +Reject 8\-bit message body text without 8\-bit MIME content encoding +information. +.IP "\fBstrict_mime_encoding_domain (no)\fR" +Reject mail with invalid Content\-Transfer\-Encoding: information +for the message/* or multipart/* MIME content types. +.PP +Available in Postfix version 2.5 and later: +.IP "\fBdetect_8bit_encoding_header (yes)\fR" +Automatically detect 8BITMIME body content by looking at +Content\-Transfer\-Encoding: message headers; historically, this +behavior was hard\-coded to be "always on". +.SH "AUTOMATIC BCC RECIPIENT CONTROLS" +.na +.nf +.ad +.fi +Postfix can automatically add BCC (blind carbon copy) +when mail enters the mail system: +.IP "\fBalways_bcc (empty)\fR" +Optional address that receives a "blind carbon copy" of each message +that is received by the Postfix mail system. +.PP +Available in Postfix version 2.1 and later: +.IP "\fBsender_bcc_maps (empty)\fR" +Optional BCC (blind carbon\-copy) address lookup tables, indexed +by envelope sender address. +.IP "\fBrecipient_bcc_maps (empty)\fR" +Optional BCC (blind carbon\-copy) address lookup tables, indexed by +envelope recipient address. +.SH "ADDRESS TRANSFORMATION CONTROLS" +.na +.nf +.ad +.fi +Address rewriting is delegated to the \fBtrivial\-rewrite\fR(8) daemon. +The \fBcleanup\fR(8) server implements table driven address mapping. +.IP "\fBempty_address_recipient (MAILER\-DAEMON)\fR" +The recipient of mail addressed to the null address. +.IP "\fBcanonical_maps (empty)\fR" +Optional address mapping lookup tables for message headers and +envelopes. +.IP "\fBrecipient_canonical_maps (empty)\fR" +Optional address mapping lookup tables for envelope and header +recipient addresses. +.IP "\fBsender_canonical_maps (empty)\fR" +Optional address mapping lookup tables for envelope and header +sender addresses. +.IP "\fBmasquerade_classes (envelope_sender, header_sender, header_recipient)\fR" +What addresses are subject to address masquerading. +.IP "\fBmasquerade_domains (empty)\fR" +Optional list of domains whose subdomain structure will be stripped +off in email addresses. +.IP "\fBmasquerade_exceptions (empty)\fR" +Optional list of user names that are not subjected to address +masquerading, even when their addresses match $masquerade_domains. +.IP "\fBpropagate_unmatched_extensions (canonical, virtual)\fR" +What address lookup tables copy an address extension from the lookup +key to the lookup result. +.PP +Available before Postfix version 2.0: +.IP "\fBvirtual_maps (empty)\fR" +Optional lookup tables with a) names of domains for which all +addresses are aliased to addresses in other local or remote domains, +and b) addresses that are aliased to addresses in other local or +remote domains. +.PP +Available in Postfix version 2.0 and later: +.IP "\fBvirtual_alias_maps ($virtual_maps)\fR" +Optional lookup tables that are often searched with a full email +address (including domain) and that apply to all recipients: \fBlocal\fR(8), +virtual, and remote; this is unlike alias_maps that are only searched +with an email address localpart (no domain) and that apply +only to \fBlocal\fR(8) recipients. +.PP +Available in Postfix version 2.2 and later: +.IP "\fBcanonical_classes (envelope_sender, envelope_recipient, header_sender, header_recipient)\fR" +What addresses are subject to canonical_maps address mapping. +.IP "\fBrecipient_canonical_classes (envelope_recipient, header_recipient)\fR" +What addresses are subject to recipient_canonical_maps address +mapping. +.IP "\fBsender_canonical_classes (envelope_sender, header_sender)\fR" +What addresses are subject to sender_canonical_maps address +mapping. +.IP "\fBremote_header_rewrite_domain (empty)\fR" +Rewrite or add message headers in mail from remote clients if +the remote_header_rewrite_domain parameter value is non\-empty, +updating incomplete addresses with the domain specified in the +remote_header_rewrite_domain parameter, and adding missing headers. +.SH "RESOURCE AND RATE CONTROLS" +.na +.nf +.ad +.fi +.IP "\fBduplicate_filter_limit (1000)\fR" +The maximal number of addresses remembered by the address +duplicate filter for \fBaliases\fR(5) or \fBvirtual\fR(5) alias expansion, or +for \fBshowq\fR(8) queue displays. +.IP "\fBheader_size_limit (102400)\fR" +The maximal amount of memory in bytes for storing a message header. +.IP "\fBhopcount_limit (50)\fR" +The maximal number of Received: message headers that is allowed +in the primary message headers. +.IP "\fBin_flow_delay (1s)\fR" +Time to pause before accepting a new message, when the message +arrival rate exceeds the message delivery rate. +.IP "\fBmessage_size_limit (10240000)\fR" +The maximal size in bytes of a message, including envelope information. +.PP +Available in Postfix version 2.0 and later: +.IP "\fBheader_address_token_limit (10240)\fR" +The maximal number of address tokens are allowed in an address +message header. +.IP "\fBmime_boundary_length_limit (2048)\fR" +The maximal length of MIME multipart boundary strings. +.IP "\fBmime_nesting_limit (100)\fR" +The maximal recursion level that the MIME processor will handle. +.IP "\fBqueue_file_attribute_count_limit (100)\fR" +The maximal number of (name=value) attributes that may be stored +in a Postfix queue file. +.PP +Available in Postfix version 2.1 and later: +.IP "\fBvirtual_alias_expansion_limit (1000)\fR" +The maximal number of addresses that virtual alias expansion produces +from each original recipient. +.IP "\fBvirtual_alias_recursion_limit (1000)\fR" +The maximal nesting depth of virtual alias expansion. +.PP +Available in Postfix version 3.0 and later: +.IP "\fBvirtual_alias_address_length_limit (1000)\fR" +The maximal length of an email address after virtual alias expansion. +.SH "SMTPUTF8 CONTROLS" +.na +.nf +.ad +.fi +Preliminary SMTPUTF8 support is introduced with Postfix 3.0. +.IP "\fBsmtputf8_enable (yes)\fR" +Enable preliminary SMTPUTF8 support for the protocols described +in RFC 6531, RFC 6532, and RFC 6533. +.IP "\fBsmtputf8_autodetect_classes (sendmail, verify)\fR" +Detect that a message requires SMTPUTF8 support for the specified +mail origin classes. +.PP +Available in Postfix version 3.2 and later: +.IP "\fBenable_idna2003_compatibility (no)\fR" +Enable 'transitional' compatibility between IDNA2003 and IDNA2008, +when converting UTF\-8 domain names to/from the ASCII form that is +used for DNS lookups. +.SH "TLS SUPPORT" +.na +.nf +.ad +.fi +Available in Postfix version 3.10 and later: +.IP "\fBtls_required_enable (yes)\fR" +Enable support for the "TLS\-Required: no" message header, defined +in RFC 8689. +.SH "MISCELLANEOUS CONTROLS" +.na +.nf +.ad +.fi +.IP "\fBconfig_directory (see 'postconf -d' output)\fR" +The default location of the Postfix main.cf and master.cf +configuration files. +.IP "\fBdaemon_timeout (18000s)\fR" +How much time a Postfix daemon process may take to handle a +request before it is terminated by a built\-in watchdog timer. +.IP "\fBdelay_logging_resolution_limit (2)\fR" +The maximal number of digits after the decimal point when logging +delay values. +.IP "\fBdelay_warning_time (0h)\fR" +The time after which the sender receives a copy of the message +headers of mail that is still queued. +.IP "\fBipc_timeout (3600s)\fR" +The time limit for sending or receiving information over an internal +communication channel. +.IP "\fBmax_idle (100s)\fR" +The maximum amount of time that an idle Postfix daemon process waits +for an incoming connection before terminating voluntarily. +.IP "\fBmax_use (100)\fR" +The maximal number of incoming connections that a Postfix daemon +process will service before terminating voluntarily. +.IP "\fBmyhostname (see 'postconf -d' output)\fR" +The internet hostname of this mail system. +.IP "\fBmyorigin ($myhostname)\fR" +The domain name that locally\-posted mail appears to come +from, and that locally posted mail is delivered to. +.IP "\fBprocess_id (read\-only)\fR" +The process ID of a Postfix command or daemon process. +.IP "\fBprocess_name (read\-only)\fR" +The process name of a Postfix command or daemon process. +.IP "\fBqueue_directory (see 'postconf -d' output)\fR" +The location of the Postfix top\-level queue directory. +.IP "\fBsoft_bounce (no)\fR" +Safety net to keep mail queued that would otherwise be returned to +the sender. +.IP "\fBsyslog_facility (mail)\fR" +The syslog facility of Postfix logging. +.IP "\fBsyslog_name (see 'postconf -d' output)\fR" +A prefix that is prepended to the process name in syslog +records, so that, for example, "smtpd" becomes "prefix/smtpd". +.PP +Available in Postfix version 2.1 and later: +.IP "\fBenable_original_recipient (yes)\fR" +Enable support for the original recipient address after an +address is rewritten to a different address (for example with +aliasing or with canonical mapping). +.PP +Available in Postfix 3.3 and later: +.IP "\fBservice_name (read\-only)\fR" +The master.cf service name of a Postfix daemon process. +.PP +Available in Postfix 3.5 and later: +.IP "\fBinfo_log_address_format (external)\fR" +The email address form that will be used in non\-debug logging +(info, warning, etc.). +.PP +Available in Postfix 3.9 and later: +.IP "\fBforce_mime_input_conversion (no)\fR" +Convert body content that claims to be 8\-bit into quoted\-printable, +before header_checks, body_checks, Milters, and before after\-queue +content filters. +.SH "FILES" +.na +.nf +/etc/postfix/canonical*, canonical mapping table +/etc/postfix/virtual*, virtual mapping table +.SH "SEE ALSO" +.na +.nf +trivial\-rewrite(8), address rewriting +qmgr(8), queue manager +header_checks(5), message header content inspection +body_checks(5), body parts content inspection +canonical(5), canonical address lookup table format +virtual(5), virtual alias lookup table format +postconf(5), configuration parameters +master(5), generic daemon options +master(8), process manager +postlogd(8), Postfix logging +syslogd(8), system logging +.SH "README FILES" +.na +.nf +.ad +.fi +Use "\fBpostconf readme_directory\fR" or +"\fBpostconf html_directory\fR" to locate this information. +.na +.nf +ADDRESS_REWRITING_README Postfix address manipulation +CONTENT_INSPECTION_README content inspection +.SH "LICENSE" +.na +.nf +.ad +.fi +The Secure Mailer license must be distributed with this software. +.SH "AUTHOR(S)" +.na +.nf +Wietse Venema +IBM T.J. Watson Research +P.O. Box 704 +Yorktown Heights, NY 10598, USA + +Wietse Venema +Google, Inc. +111 8th Avenue +New York, NY 10011, USA + +Wietse Venema +porcupine.org diff --git a/static/netbsd/man8/clri.8 b/static/netbsd/man8/clri.8 new file mode 100644 index 00000000..5b887e90 --- /dev/null +++ b/static/netbsd/man8/clri.8 @@ -0,0 +1,80 @@ +.\" $NetBSD: clri.8,v 1.9 2016/09/12 23:11:50 sevan Exp $ +.\" +.\" Copyright (c) 1980, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)clri.8 8.2 (Berkeley) 4/19/94 +.\" +.Dd September 13, 2016 +.Dt CLRI 8 +.Os +.Sh NAME +.Nm clri +.Nd clear an inode +.Sh SYNOPSIS +.Nm +.Ar special_device inode_number ... +.Sh DESCRIPTION +.Bf -symbolic +.Nm +is obsoleted for normal file system repair work by +.Xr fsck 8 . +.Ef +.Pp +.Nm +zeros out the inodes with the specified inode number(s) +on the filesystem residing on the given +.Ar special_device . +The +.Xr fsck 8 +utility is usually run after +.Nm +to reclaim the zero'ed inode(s) and the +blocks previously claimed by those inode(s). +Both read and write permission are required on the specified +.Ar special_device . +.Pp +The primary purpose of this routine +is to remove a file which +for some reason is not being properly handled by +.Xr fsck 8 . +Once removed, +it is anticipated that +.Xr fsck 8 +will be able to clean up the resulting mess. +.Sh SEE ALSO +.Xr fsck 8 , +.Xr fsdb 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.At v6 . +.Sh BUGS +If the file is open, the work of +.Nm +will be lost when the inode is written back to disk from the inode cache. diff --git a/static/netbsd/man8/clvmd.8 b/static/netbsd/man8/clvmd.8 new file mode 100644 index 00000000..660f2d34 --- /dev/null +++ b/static/netbsd/man8/clvmd.8 @@ -0,0 +1,82 @@ +.\" $NetBSD: clvmd.8,v 1.2 2009/02/18 12:16:13 haad Exp $ +.\" +.TH CLVMD 8 "LVM TOOLS 2.02.44-cvs (02-17-09)" "Red Hat Inc" \" -*- nroff -*- +.SH NAME +clvmd \- cluster LVM daemon +.SH SYNOPSIS +.B clvmd +[\-d []] [\-C] [\-h] +[\-R] +[\-t ] +[\-T ] +[\-V] +.SH DESCRIPTION +clvmd is the daemon that distributes LVM metadata updates around a cluster. +It must be running on all nodes in the cluster and will give an error +if a node in the cluster does not have this daemon running. +.SH OPTIONS +.TP +.I \-d [] +Enable debug logging. Value can be 0, 1 or 2. +.br +0 disables debug logging in a running clvmd +.br +1 sends debug logs to stderr (clvmd will not fork in this case) +.br +2 sends debug logs to syslog +.br +If +.B -d +is specified without a value then 1 is assumed if you are starting a +new clvmd, 2 if you are enabling debug in a running clvmd. +.TP +.I \-C +Only valid if +.B -d +is also specified. Tells all clvmds in a cluster to enable/disable debug logging. +Without this switch, only the local clvmd will change its debug level to that +given with +.B -d. +.br +This does not work correctly if specified on the command-line that starts clvmd. +If you want to start clvmd +.B and +enable cluster-wide logging then the command needs to be issued twice, eg: +.br +clvmd +.br +clvmd -d2 +.br +.TP +.I \-t +Specifies the timeout for commands to run around the cluster. This should not +be so small that commands with many disk updates to do will fail, so you +may need to increase this on systems with very large disk farms. +The default is 30 seconds. +.TP +.I \-T +Specifies the timeout for clvmd daemon startup. If the daemon does not report +that it has started up within this time then the parent command will exit with +status of 5. This does NOT mean that clvmd has not started! What it means is +that the startup of clvmd has been delayed for some reason; the most likely +cause of this is an inquorate cluster though it could be due to locking +latencies on a cluster with large numbers of logical volumes. If you get the +return code of 5 it is usually not necessary to restart clvmd - it will start +as soon as that blockage has cleared. This flag is to allow startup scripts +to exit in a timely fashion even if the cluster is stalled for some reason. +.br +The default is 0 (no timeout) and the value is in seconds. Don't set this too +small or you will experience spurious errors. 10 or 20 seconds might be +sensible. +.br +This timeout will be ignored if you start clvmd with the -d switch. +.TP +.I \-R +Tells all the running clvmds in the cluster to reload their device cache and +re-read the lvm configuration file. This command should be run whenever the +devices on a cluster system are changed. +.TP +.I \-V +Display the version of the cluster LVM daemon. +.SH SEE ALSO +.BR lvm (8) diff --git a/static/netbsd/man8/cnwctl.8 b/static/netbsd/man8/cnwctl.8 new file mode 100644 index 00000000..28b6d495 --- /dev/null +++ b/static/netbsd/man8/cnwctl.8 @@ -0,0 +1,160 @@ +.\" $NetBSD: cnwctl.8,v 1.2 1999/11/29 12:55:07 itojun Exp $ +.\" +.\" Copyright (c) 1997 Berkeley Software Design, Inc. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that this notice is retained, +.\" the conditions in the following notices are met, and terms applying +.\" to contributors in the following notices also apply to Berkeley +.\" Software Design, Inc. +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by +.\" Berkeley Software Design, Inc. +.\" 4. Neither the name of the Berkeley Software Design, Inc. nor the names +.\" of its contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN, INC. ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN, INC. BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" PAO2 Id: cnwctl.8,v 1.1.1.1 1997/12/11 14:46:06 itojun Exp +.\" +.Dd January 5, 1997 +.Dt CNWCTL 8 +.Os +.Sh NAME +.Nm cnwctl +.Nd display statistics and control Netwave AirSurfer PC Cards +.Sh SYNOPSIS +.Nm cnwctl +.Op Fl d Ar domain +.Op Fl i Ar interface +.Op Fl k Ar scramble-key +.Op Fl sS Op Ar rate +.Sh DESCRIPTION +The +.Nm cnwctl +utility is used to control Netwave AirSurfer PC Cards as well as +display statistics. +The following options are available: +. +.Bl -tag -width indent +.It Fl d +Set the domain of the card to +.Ar domain . +The domain must be between 0x000 and 0x1ff. +The domains 0x000 through 0x0ff are for access to an add-hoc network. +The domains 0x100 through 0x1ff are for access to a Netwave Access Point. +The default domain is 0x000. +A card may only talk to the access point in its domain, or other cards +in its add-hoc domain. +.It Fl i +Use +.Ar interface +as the interface rather than +.Li cnw0 . +.It Fl k +Set the scramble key to +.Ar scramble-key . +The scramble key must be between 0x0000 and 0xffff. +Both the source and the destination must use the same scramble key +in order to communicate. +.It Fl s +Display statistics. +When the optional argument +.Ar rate +(which must be the last argument to the end of the command line) +is specified as a non-zero value, statistics will be displayed +every +.Ar rate +seconds. +At the top of each +.Dq page +of statistics, column labels will be displayed. The first row of +statistics will be totals since boot, subsequent lines are deltas +from the previous row. +If +.Ar rate +is not specified, or is 0 (zero), a single page of statistics will be +displayed. These statistics are more detailed and include: +.Bl -tag -width indent +.It domain +The domain this card is part of. +.It rx +Number of packets received. +.It rxoverflow +Number of overflows detected. +.It rxoverrun +Number of overruns detected. +.It rxcrcerror +Number of CRC errors detected. +Random noise can cause these errors. +.It rxframe +Number of framing errors detected. +.It rxerrors +Number of generic errors detected. +.It rxavail +Number of times a packet was available. +.It tx +Number of packets requested to be sent. +.It txokay +Number of packets sent. +.It txabort +Number of packets aborted (not sent within 9 tries). +.It txlostcd +Number of times carrier detect was lost. +.It txerrors +Number of generic transmit errors detected. +.It txretries +Total number of retries. +.It Ar N Ns No x retries +Number of packets which were retried +.Ar N +times. +.El +.It Fl S +Display status read from the hardware. This option is only available +to the super user. +The +.Ar rate +argument is used as with the +.Fl s +option. +The following fields are displayed +.Bl -tag -width indent +.It link integrity field (lif) +A 0 value implies no links. +.It connection quality (cq) +Probably indicates the quality of the connection to the access point. +.It spu +Unknown meaning. +.It link quality (lq) +Probably indicated the quality of the link to the access point. +.It hhc +Unknown meaning. +.It mhs +Unknown meaning. +.It revision +The revision numbers of the card. +.It id +The ID of the card. +.El +.El +.Sh SEE ALSO +.Xr cnw 4 diff --git a/static/netbsd/man8/compat_30.8 4.html b/static/netbsd/man8/compat_30.8 4.html new file mode 100644 index 00000000..8126cf11 --- /dev/null +++ b/static/netbsd/man8/compat_30.8 4.html @@ -0,0 +1,145 @@ + + + + + + +
COMPAT_30(8)System Manager's ManualCOMPAT_30(8)
+
+
+

+

compat_30 — setup + procedure for backward compatibility on post-3.0 releases

+
+
+

+

options COMPAT_30

+
+
+

+

The compat_30 module allows + NetBSD to run NetBSD 3.0 + executables.

+

The support is present if the kernel was built with option + COMPAT_30. It is not available as a loadable + module.

+

Static executables typically need no additional setup. Dynamic + binaries may require shared libraries whose major version number changed + since NetBSD 3.0, which are listed below. A shadow + directory under /emul is not used; the libraries can + be obtained from a NetBSD 3.0 distribution and + installed in the original directories shown, as the major version number in + the file name will prevent conflicts. If an upgrade installation from + NetBSD 3.0 has been done and these libraries are + still present, nothing more need be done.

+
+

+
    +
  • /lib/libcrypto.so.2.1 + /lib/libcrypto.so.2
    • +
  • /usr/lib/libcrypto.so.2.1 + /usr/lib/libcrypto.so.2
    • +
  • /lib/libevent.so.0.2 + /lib/libevent.so.0
    • +
  • /usr/lib/libevent.so.0.2 + /usr/lib/libevent.so.0
    • +
  • /usr/lib/libg2c.so.2.0 + /usr/lib/libg2c.so.2
    • +
  • /usr/lib/libkadm.so.5.0 + /usr/lib/libkadm.so.5
    • +
  • /usr/lib/libkafs.so.6.0 + /usr/lib/libkafs.so.6
    • +
  • /usr/lib/libkdb.so.5.0 + /usr/lib/libkdb.so.5
    • +
  • /usr/lib/libkrb5.so.19.1 + /usr/lib/libkrb5.so.19
    • +
  • /usr/lib/libkrb.so.6.0 + /usr/lib/libkrb.so.6
    • +
  • /usr/lib/libkstream.so.2.0 + /usr/lib/libkstream.so.2
    • +
  • /usr/lib/libmagic.so.0.1 + /usr/lib/libmagic.so.0
    • +
  • /usr/lib/libpcap.so.1.4 + /usr/lib/libpcap.so.1
    • +
  • /lib/libradius.so.0.0 + /lib/libradius.so.0
    • +
  • /usr/lib/libradius.so.0.0 + /usr/lib/libradius.so.0
    • +
  • /usr/lib/libssh.so.1.0 + /usr/lib/libssh.so.1
    • +
  • /usr/lib/libssl.so.3.0 + /usr/lib/libssl.so.3
    • +
  • /usr/lib/libstdc++.so.5.0 + /usr/lib/libstdc++.so.5
    • +
  • /lib/libz.so.0.4 + /lib/libz.so.0
    • +
  • /usr/lib/libz.so.0.4 + /usr/lib/libz.so.0
    • +
  • /usr/lib/libamu.so.2.1 + /usr/lib/libamu.so.2
    • +
+
+
+
+

+

COMPAT_30 enables the + NetBSD 3.0 versions of the following system calls, + whose syscall numbers and argument structures were changed after the 3.0 + release to accommodate 64-bit filesystems: fhstat(2), + fstat(2), getdents(2), + lstat(2), stat(2).

+

The filehandle structure (formerly + fhandle_t) was made opaque to userland and + variable-sized. A fh_size argument was added to + related syscalls: fhstat(2), + fhstatvfs(2), fhstatvfs1(2), + fhopen(2), getfh(2). This changes the + API and ABI of those syscalls, COMPAT_30 enables + binary compatibility with the old ABI. Source compatibility is not provided, + as use of those syscalls is supposed to be rare.

+

The error code from the socket(2) syscall + changed from EPROTONOSUPPORT to + EAFNOSUPPORT in the case of an unsupported address + family. COMPAT_30 enables binary compatibility with + the old ABI. Source compatibility is not provided.

+

The struct ntptimeval used by + ntp_gettime(2) changed with the implementation of + timecounters.

+
+
+

+

config(1), fhstat(2), + fstat(2), getdents(2), + lstat(2), stat(2), + options(4)

+
+
+

+

NetBSD offers back-compatibility options + back to NetBSD 0.9, but the first to be documented + with a manual page is compat_30.

+
+
+

+

The compatible getdents(2) is unable to see + directory entries beneath the top layer of a union, even though the real 3.0 + getdents() did not have that problem.

+
+
+

+

Programs with security impact that receive incorrect directory + contents from getdents() may behave improperly, as + when they are unable to find, or find the wrong versions of, important + files.

+
+
+ + + + + +
December 15, 2007NetBSD 10.1
diff --git a/static/netbsd/man8/compat_bsdos.8 4.html b/static/netbsd/man8/compat_bsdos.8 4.html new file mode 100644 index 00000000..dad249b8 --- /dev/null +++ b/static/netbsd/man8/compat_bsdos.8 4.html @@ -0,0 +1,93 @@ + + + + + + +
COMPAT_BSDOS(8)System Manager's ManualCOMPAT_BSDOS(8)
+
+
+

+

compat_bsdos — + binary compatibility for BSDi releases

+
+
+

+

The COMPAT_NOMID kernel option includes + compatibility with + BSDi 1.x–3.x + a.out(5) binaries on NetBSD/i386 + and NetBSD/amd64. The option is enabled by default + in the GENERIC kernel on i386, but needs to be set + along with EXEC_AOUT on amd64.

+

Null memory protection must be disabled with the + sysctl(7) option vm.user_va0_disable + set to 0 for the binaries to run successfully.

+

BSD/OS binaries may be placed under + /emul directory to match the location of other + non-native executables on NetBSD, but the + compatibility environment does not automatically lookup libraries under + /emul/bsdos as happens with the shared libraries for + NetBSD 1.0–1.5 a.out(5) + binaries under /emul/aout.

+

BSD/386 1.0–1.1 uses static + binaries that do not dynamically load libraries at runtime.

+

BSD/OS 2.0 introduced “static + shared libraries” as the default for standard binaries. The shared + libraries are compiled from /lib and + /usr/lib to a custom format bound to memory loading + addresses for each library under /shlib. BSDi + libraries under /shlib are not in the standard + ar(5) or position-independent shared object formats and + cannot be loaded by ldconfig(8) on + NetBSD. In order for BSDi executables to access the + objects at the hardcoded /shlib path, the user may + setup a symbolic link from /shlib to + /emul/bsdos/shlib.

+

BSD/OS 4.0 switched to an ELF binary + executable format that does not run under the compatibility layers currently + available on NetBSD.

+
+
+

+

ld.aout_so(1), options(4), + a.out(5), elf(5), + sysctl(7), compat_netbsd32(8), + ldconfig(8)

+
+
+

+

BSD/386 1.0–1.1 was derived + from 4.3BSD Reno code in the Net/2 release.

+

BSD/OS 2.0 was based on + 4.4BSD Lite, but added the new static shared library + format as the runtime default for executables. The build system included the + shlicc command with the + -Bstatic flag that allowed reverting to the standard + library archive format that remained available under + /lib and /usr/lib.

+

NetBSD 1.0 added shared libraries using a + standard position-independent shared object format. The previous default + relocatable libraries in the traditional ar(5) format + remained available.

+

OpenBSD 2.2–4.7 included a + different compatibility implementation under the + COMPAT_BSDOS kernel option.

+
+
+

+

BSD/OS compatibility was broken on + NetBSD 5–6.

+

BSD/OS 3.0 added SPARC support, but the + binaries are incorrectly recognized as SunOS executables and fail on + NetBSD/sparc and + NetBSD/sparc64.

+
+
+ + + + + +
August 27, 2020NetBSD 10.1
diff --git a/static/netbsd/man8/compat_freebsd.8 4.html b/static/netbsd/man8/compat_freebsd.8 4.html new file mode 100644 index 00000000..53475343 --- /dev/null +++ b/static/netbsd/man8/compat_freebsd.8 4.html @@ -0,0 +1,258 @@ + + + + + + +
COMPAT_FREEBSD(8)System Manager's ManualCOMPAT_FREEBSD(8)
+
+
+

+

compat_freebsd — + setup procedure for running FreeBSD binaries

+
+
+

+
compat_freebsd is not maintained anymore, and new FreeBSD + binaries cannot be expected to work. The compat_freebsd feature is available + in NetBSD only to support the FreeBSD tw_cli driver.
+

NetBSD supports running + FreeBSD binaries. Most binaries should work, except + programs that use FreeBSD-specific features. These + include i386-specific calls, such as syscons utilities. The + FreeBSD compatibility feature is active for kernels + compiled with the COMPAT_FREEBSD option enabled.

+

A lot of programs are dynamically linked. This means, that you + will also need the FreeBSD shared libraries that the + program depends on, and the runtime linker. Also, you will need to create a + “shadow root” directory for FreeBSD + binaries on your NetBSD system. This directory is + named /emul/freebsd. Any file operations done by + FreeBSD programs run under + NetBSD will look in this directory first. So, if a + FreeBSD program opens, for example, + /etc/passwd, NetBSD will + first try to open /emul/freebsd/etc/passwd, and if + that does not exist open the ‘real’ + /etc/passwd file. It is recommended that you install + FreeBSD packages that include configuration files, + etc under /emul/freebsd, to avoid naming conflicts + with possible NetBSD counterparts. Shared libraries + should also be installed in the shadow tree.

+

Generally, you will need to look for the shared libraries that + FreeBSD binaries depend on only the first few times + that you install a FreeBSD program on your + NetBSD system. After a while, you will have a + sufficient set of FreeBSD shared libraries on your + system to be able to run newly imported FreeBSD + binaries without any extra work.

+
+

+

How to get to know which shared libraries + FreeBSD binaries need, and where to get them? + Basically, there are 2 possibilities (when following these instructions: you + will need to be root on your NetBSD system to do the + necessary installation steps).

+

+
    +
  1. You have access to a FreeBSD system. In this case + you can temporarily install the binary there, see what shared libraries it + needs, and copy them to your NetBSD system. + Example: you have just ftp-ed the FreeBSD binary + of SimCity. Put it on the FreeBSD system you have + access to, and check which shared libraries it needs by running + ‘ldd sim’: +
    + 
    me@freebsd% ldd /usr/local/lib/SimCity/res/sim
+/usr/local/lib/SimCity/res/sim:
+	-lXext.6 => /usr/X11R6/lib/libXext.so.6.0 (0x100c1000)
+	-lX11.6 => /usr/X11R6/lib/libX11.so.6.0 (0x100c9000)
+	-lc.2 => /usr/lib/libc.so.2.1 (0x10144000)
+	-lm.2 => /usr/lib/libm.so.2.0 (0x101a7000)
+	-lgcc.261 => /usr/lib/libgcc.so.261.0 (0x101bf000)
    +
    +

    You would need go get all the files from the last column, and + put them under /emul/freebsd. This means you + eventually have these files on your NetBSD + system:

    +
      +
    • /emul/freebsd/usr/X11R6/lib/libXext.so.6.0
      • +
    • /emul/freebsd/usr/X11R6/lib/libX11.so.6.0
      • +
    • /emul/freebsd/usr/lib/libc.so.2.1
      • +
    • /emul/freebsd/usr/lib/libm.so.2.0
      • +
    • /emul/freebsd/usr/lib/libgcc.so.261.0
      • +
    +

    Note that if you already have a + FreeBSD shared library with a matching major + revision number to the first column of the ldd + output, you won't need to copy the file named in the last column to your + system, the one you already have should work. It is advisable to copy + the shared library anyway if it is a newer version, though. You can + remove the old one. So, if you have these libraries on your system:

    +
      +
    • /emul/freebsd/usr/lib/libc.so.2.0
      • +
    +

    and you find that the ldd output for a new binary you want to + install is:

    +
    + 
    -lc.2 => /usr/lib/libc.so.2.1 (0x10144000)
    +
    +

    You won't need to worry about copying + /usr/lib/libc.so.2.1 too, because the program + should work fine with the slightly older version. You can decide to + replace the libc.so anyway, and that should leave you with:

    +
      +
    • /emul/freebsd/usr/lib/libc.so.2.1
      • +
    +

    Finally, you must make sure that you have the + FreeBSD runtime linker and its config files on + your system. You should copy these files from the + FreeBSD system to their appropriate place on + your NetBSD system (in the + /emul/freebsd tree):

    +
      +
    • usr/libexec/ld.so
      • +
    • var/run/ld.so.hints
      • +
    +
    2. +
  2. You don't have access to a FreeBSD system. In that + case, you should get the extra files you need from various ftp sites. + Information on where to look for the various files is appended below. For + now, let's assume you know where to get the files. +

    Retrieve the following files (from _one_ ftp site to avoid any + version mismatches), and install them under + /emul/freebsd (i.e. + foo/bar is installed as + /emul/freebsd/foo/bar):

    +
      +
    • sbin/ldconfig
      • +
    • usr/bin/ldd
      • +
    • usr/lib/libc.so.x.y.z
      • +
    • usr/libexec/ld.so
      • +
    +

    ldconfig and + ldd don't necessarily need to be under + /emul/freebsd, you can install them elsewhere in + the system too. Just make sure they don't conflict with their + NetBSD counterparts. A good idea would be to + install them in /usr/local/bin as + ldconfig-freebsd and + ldd-freebsd.

    +

    Run the FreeBSD ldconfig program with + directory arguments in which the FreeBSD runtime + linker should look for shared libs. /usr/lib are + standard, you could run like the following:

    +
    + 
    me@netbsd% mkdir -p /emul/freebsd/var/run
+me@netbsd% touch /emul/freebsd/var/run/ld.so.hints
+me@netbsd% ldconfig-freebsd /usr/X11R6/lib /usr/local/lib
    +
    +

    Note that argument directories of ldconfig are mapped to + /emul/freebsd/XXXX by + NetBSD's compat code, and should exist as such + on your system. Make sure + /emul/freebsd/var/run/ld.so.hints is existing + when you run FreeBSD's ldconfig, if not, you may + lose NetBSD's + /var/run/ld.so.hints. + FreeBSD ldconfig should + be statically linked, so it doesn't need any shared libraries by itself. + It will create the file + /emul/freebsd/var/run/ld.so.hints. You should + rerun the FreeBSD version of the ldconfig + program each time you add a new shared library.

    +

    You should now be set up for FreeBSD + binaries which only need a shared libc. You can test this by running the + FreeBSD ldd on itself. + Suppose that you have it installed as + ldd-freebsd, it should produce something + like:

    +
    + 
    me@netbsd% ldd-freebsd `which ldd-freebsd`
+/usr/local/bin/ldd-freebsd:
+	-lc.2 => /usr/lib/libc.so.2.1 (0x1001a000)
    +
    +

    This being done, you are ready to install new + FreeBSD binaries. Whenever you install a new + FreeBSD program, you should check if it needs + shared libraries, and if so, whether you have them installed in the + /emul/freebsd tree. To do this, you run the + FreeBSD version ldd on + the new program, and watch its output. ldd (see + also the manual page for ldd(1)) will print a list of + shared libraries that the program depends on, in the form + -l<majorname> => <fullname>.

    +

    If it prints “not found” instead of + <fullname> it means that you need an extra library. Which library + this is, is shown in <majorname>, which will be of the form + XXXX.<N> You will need to find a libXXXX.so.<N>.<mm> + on a FreeBSD ftp site, and install it on your + system. The XXXX (name) and <N> (major revision number) should + match; the minor number(s) <mm> are less important, though it is + advised to take the most recent version.

    +

    +
    3. +
  3. In some cases, FreeBSD binary needs access to + certain device file. For example, FreeBSD X server + software needs FreeBSD + /dev/ttyv0 for ioctls. In this case, create a + symbolic link from /emul/freebsd/dev/ttyv0 to a + wscons(4) device file like + /dev/ttyE0. You will need to have at least + options WSDISPLAY_COMPAT_SYSCONS and probably also + options WSDISPLAY_COMPAT_USL in your kernel (see + options(4) and wscons(4)).
    4. +
+
+
+

+

: + the information below is valid as of the time this document was written + (June, 1995), but certain details such as names of ftp sites, directories + and distribution names may have changed by the time you read this.

+

The FreeBSD distribution is available on a + lot of ftp sites. Sometimes the files are unpacked, and you can get the + individual files you need, but mostly they are stored in distribution sets, + usually consisting of subdirectories with gzipped tar files in them. The ftp + site for the distributions is: + ftp://ftp.FreeBSD.org/pub/FreeBSD

+

This distribution consists of a number of tar-ed and gzipped + files, Normally, they're controlled by an install program, but you can + retrieve files “by hand” too. The way to look something up is + to retrieve all the files in the distribution, and ``tar ztvf'' through them + for the file you need. Here is an example of a list of files that you might + need.

+
+
Needed                 Files
+
+ld.so                  2.0-RELEASE/bindist/bindist.??
+ldconfig               2.0-RELEASE/bindist/bindist.??
+ldd                    2.0-RELEASE/bindist/bindist.??
+libc.so.2              2.0-RELEASE/bindist/bindist.??
+libX11.so.6.0          2.0-RELEASE/XFree86-3.1/XFree86-3.1-bin.tar.gz
+libX11.so.6.0          XFree86-3.1.1/X311bin.tgz
+libXt.so.6.0           2.0-RELEASE/XFree86-3.1/XFree86-3.1-bin.tar.gz
+libXt.so.6.0           XFree86-3.1.1/X311bin.tgz
+
+

The files called “bindist.??” are tar-ed, gzipped + and split, so you can extract contents by “cat bindist.?? | tar zpxf + -”.

+

Extract the files from these gzipped tarfiles in your + /emul/freebsd directory (possibly omitting or + afterwards removing files you don't need), and you are done.

+
+
+
+

+

The information about FreeBSD + distributions may become outdated.

+
+
+ + + + + +
February 10, 2018NetBSD 10.1
diff --git a/static/netbsd/man8/compat_linux.8 4.html b/static/netbsd/man8/compat_linux.8 4.html new file mode 100644 index 00000000..803a4867 --- /dev/null +++ b/static/netbsd/man8/compat_linux.8 4.html @@ -0,0 +1,161 @@ + + + + + + +
COMPAT_LINUX(8)System Manager's ManualCOMPAT_LINUX(8)
+
+
+

+

compat_linux — + setup procedure for running Linux binaries

+
+
+

+

NetBSD supports running Linux binaries. + This applies to aarch64, alpha, amd64, arm, i386, m68k, and powerpc systems + for now. Both the a.out and ELF binary formats are supported. Most programs + should work. NetBSD aarch64 and amd64 can execute + both 32-bit and 64-bit Linux programs. Programs that will not work include + some that use i386-specific calls, such as enabling virtual 8086 mode. + Currently, sound is supported through OSSv3 compat.

+

The Linux compatibility feature is active for kernels compiled + with the COMPAT_LINUX option enabled. If support for + Linux a.out executables is desired, the EXEC_AOUT + option should be enabled in addition to option + COMPAT_LINUX. Similarly, if support for Linux 32-bit + and/or 64-bit ELF executables is desired, the + EXEC_ELF32 and/or EXEC_ELF64 + options (respectively) should be enabled in addition to + COMPAT_LINUX. If sound support is desired, + COMPAT_OSSAUDIO should be enabled.

+

A lot of programs are dynamically linked. This means that you will + also need the Linux shared libraries that the program depends on, and the + runtime linker. Also, you will need to create a “shadow root” + directory for Linux binaries on your NetBSD system. + This directory is named /emul/linux or + /emul/linux32 for 32-bit emulation on 64-bit + systems. Any file operations done by Linux programs run under + NetBSD will look in this directory first. So, if a + Linux program opens, for example, /etc/passwd, + NetBSD will first try to open + /emul/linux/etc/passwd, and if that does not exist + open the ‘real’ /etc/passwd file. It + is recommended that you install Linux packages that include configuration + files, etc under /emul/linux, to avoid naming + conflicts with possible NetBSD counterparts. Shared + libraries should also be installed in the shadow tree. Filenames that start + "/../" are only looked up in the real root.

+

Generally, you will need to look for the shared libraries that + Linux binaries depend on only the first few times that you install a Linux + program on your NetBSD system. After a while, you + will have a sufficient set of Linux shared libraries on your system to be + able to run newly imported Linux binaries without any extra work.

+
+

+

Find the dependencies of a Linux binary using + readelf(1):

+
+
$ readelf -d ./runner | grep Shared
+ 0x00000001 (NEEDED)                     Shared library: [libstdc++.so.6]
+ 0x00000001 (NEEDED)                     Shared library: [libz.so.1]
+ 0x00000001 (NEEDED)                     Shared library: [libXxf86vm.so.1]
+ 0x00000001 (NEEDED)                     Shared library: [libGL.so.1]
+ 0x00000001 (NEEDED)                     Shared library: [libopenal.so.1]
+ 0x00000001 (NEEDED)                     Shared library: [libm.so.6]
+ 0x00000001 (NEEDED)                     Shared library: [librt.so.1]
+ 0x00000001 (NEEDED)                     Shared library: [libpthread.so.0]
+ 0x00000001 (NEEDED)                     Shared library: [libdl.so.2]
+ 0x00000001 (NEEDED)                     Shared library: [libcrypto.so.1.0.0]
+ 0x00000001 (NEEDED)                     Shared library: [libXext.so.6]
+ 0x00000001 (NEEDED)                     Shared library: [libX11.so.6]
+ 0x00000001 (NEEDED)                     Shared library: [libXrandr.so.2]
+ 0x00000001 (NEEDED)                     Shared library: [libGLU.so.1]
+ 0x00000001 (NEEDED)                     Shared library: [libssl.so.1.0.0]
+ 0x00000001 (NEEDED)                     Shared library: [libgcc_s.so.1]
+ 0x00000001 (NEEDED)                     Shared library: [libc.so.6]
+
+

For x86, you can simply install the openSUSE shared libraries + using the pkgsrc/emulators/suse131_* or + pkgsrc/emulators/suse131_32_* packages.

+

For example, an application which requires + libcrypto.so.1.0.0, + libXext.so.6, and libGL.so.1 + will require openssl, x11, + and glx, in addition to the + base SUSE package.

+

Otherwise, you may have to obtain shared libraries from another + Linux system, and copy them to e.g. + /emul/linux/lib64.

+
+
+

+

Some Linux binaries expect procfs to be mounted and that it + contains some Linux-specific extensions. If it's not the case, they behave + unexpectedly or even crash.

+

Mount procfs on NetBSD using following + command:

+
+
+
$ mount_procfs procfs /emul/linux/proc
+
 
+
+
+

You can also set up your system so that procfs is mounted + automatically on system boot, by putting an entry like the one below to + /etc/fstab.

+
+
+
procfs /emul/linux/proc procfs ro
+
 
+
+
+

Note: mount_procfs(8) defaults to Linux flavored + procfs since NetBSD 5.0. Ensure you do not mount + procfs with nolinux.

+

See mount_procfs(8) for further information.

+
+
+

+

Newer version of Linux use + /etc/nsswitch.conf for network information, such as + NIS and DNS. You must create or get a valid copy of this file and put it in + /emul/linux/etc.

+
+
+
+

+

compat_linux is generally not enabled in + GENERIC kernels for security reasons, but is + available as a module. It must be added to modules.conf(5) + to be used. It will not be loaded automatically.

+
+
+

+

The information about Linux distributions will become + outdated.

+

Absolute pathnames pointed to by symbolic links are only looked up + in the shadow root when the symbolic link itself was found by an absolute + pathname inside the shadow root. This is not consistent.

+

Linux executables cannot handle directory offset cookies > 32 + bits. Should such an offset occur, you will see the message + “linux_getdents: dir offset too large for emulated program”. + Currently, this can only happen on NFS mounted file systems, mounted from + servers that return offsets with information in the upper 32 bits. These + errors should rarely happen, but can be avoided by mounting this file system + with offset translation enabled. See the -X option + to mount_nfs(8). The -2 option to + mount_nfs(8) will also have the desired effect, but is + less preferable.

+
+
+ + + + + +
September 26, 2021NetBSD 10.1
diff --git a/static/netbsd/man8/compat_netbsd32.8 4.html b/static/netbsd/man8/compat_netbsd32.8 4.html new file mode 100644 index 00000000..11755c86 --- /dev/null +++ b/static/netbsd/man8/compat_netbsd32.8 4.html @@ -0,0 +1,109 @@ + + + + + + +
COMPAT_NETBSD32(8)System Manager's ManualCOMPAT_NETBSD32(8)
+
+
+

+

compat_netbsd32 — + setup procedure for 32-bit compatibility on 64-bit + platforms

+
+
+

+

The compat_netbsd32 module allows + NetBSD/sparc64 to run + NetBSD/sparc executables, + NetBSD/aarch64 to run + NetBSD/arm executables, + NetBSD/mips64 to run + NetBSD/mips executables, and + NetBSD/amd64 to run + NetBSD/i386 executables. On + NetBSD/mips64 the default userland is N32 which is a + handled by compat_netbsd32 framework, and 64-bit + binaries are handled similarly to the setup for 32-bit compatibility. It + also provides compatibility between OABI and EABI binaries on 32-bit + NetBSD/arm ports.

+

To use compat_netbsd32, one must either + have COMPAT_NETBSD32 and + EXEC_ELF32 in the kernel, or load the + compat_netbsd32 and exec_elf32 kernel modules.

+

Static executables typically need no additional setup. Dynamic + binaries require the dynamic linker plus shared libraries.

+

Since NetBSD 5.0 the base system has + directly included support for 32-bit compatibility by installing 32-bit + libraries and dynamic linker into /usr. This + includes compiler support for compiling 32-bit applications on platforms + where this is supported.

+

For a.out compatibility, + /usr/libexec/ld.so from a 32-bit distribution is + required to exist, and the a.out shared libraries must be found in + /emul/aout as normal for a.out compatibility. For + 32-bit (64-bit on NetBSD/mips64) ELF compatibility, + the relevant /usr/libexec/ld.elf_so needs to be + found in

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
i386/usr/libexec/ld.elf_so-i386
sparc/usr/libexec/ld.elf_so-sparc
O32/usr/libexec/ld.elf_so-o32
N64/usr/libexec/ld.elf_so-64
powerpc/usr/libexec/ld.elf_so-powerpc
eabi/usr/libexec/ld.elf_so-eabi
+

Note that the kernel handles rewriting the built-in ELF + interpreter to the above path.

+

Before NetBSD 5.0 all of these files + needed to be placed under /emul/netbsd32.

+

The shared libraries for a.out binaries do not live under the + /emul/netbsd32 directory, but under the + /emul/aout directory, where the a.out dynamic linker + will find them.

+
+
+

+

A list of things which fail to work in compatibility mode should + be here.

+

aio(3) is not supported.

+

Some ioctl(2) commands are not supported, + including drm(4).

+
+
+ + + + + +
January 17, 2019NetBSD 10.1
diff --git a/static/netbsd/man8/compat_sunos.8 4.html b/static/netbsd/man8/compat_sunos.8 4.html new file mode 100644 index 00000000..4acb2888 --- /dev/null +++ b/static/netbsd/man8/compat_sunos.8 4.html @@ -0,0 +1,92 @@ + + + + + + +
COMPAT_SUNOS(8)System Manager's ManualCOMPAT_SUNOS(8)
+
+
+

+

compat_sunos — + setup procedure for m68k, sparc and sparc64 + architectures

+
+
+

+

NetBSD/sparc64, + NetBSD/sparc and some of the + NetBSD/m68k architectures can run SunOS executables. + Most executables will work.

+

The exceptions include programs that use the SunOS kvm + library, and various system calls, + ()'s, or + kernel semantics that are difficult to emulate. The number of reasons why a + program might fail to work is (thankfully) longer than the number of + programs that fail to run.

+

Static executables will normally run without any extra setup. This + procedure details the directories and files that must be set up to allow + dynamically linked executables to work.

+

The files you need are on your SunOS machine. You need to worry + about the legal issues of ensuring that you have a right to use the required + files on your machine. On your NetBSD machine, do + the following:

+
    +
    2. +
    3. +
    4. +
    5. +
  5. If you ever expect to use YP, you will want to create a link: +
    + 
    ln -s /var/run/ypbind.lock /etc/ypbind.lock
    +
    +
    6. +
+

Alternatively, you can use an NFS mount to accomplish the same + effect. On your NetBSD machine, do the + following:

+
    +
    2. +
    3. +
+

This will place the SunOS libraries on your + NetBSD machine in a location where the SunOS + compatibility code will look for first, where they do not conflict with the + standard libraries.

+
+
+

+

When using compat_sunos on + NetBSD/sparc64, the + COMPAT_NETBSD32 option must also be used.

+
+
+

+

A list of things which fail to work in compatibility mode should + be here.

+

SunOS executables can not handle directory offset cookies > 32 + bits. Should such an offset occur, you will see the message + “sunos_getdents: dir offset too large for emulated program”. + Currently, this can only happen on NFS mounted filesystems, mounted from + servers that return offsets with information in the upper 32 bits. These + errors should rarely happen, but can be avoided by mounting this filesystem + with offset translation enabled. See the -X option + to mount_nfs(8). The -2 option to + mount_nfs(8) will also have the desired effect, but is + less preferable.

+

The NetBSD/sparc64 support is less + complete than the other ports.

+
+
+ + + + + +
February 3, 2001NetBSD 10.1
diff --git a/static/netbsd/man8/compat_ultrix.8 4.html b/static/netbsd/man8/compat_ultrix.8 4.html new file mode 100644 index 00000000..f4275366 --- /dev/null +++ b/static/netbsd/man8/compat_ultrix.8 4.html @@ -0,0 +1,106 @@ + + + + + + +
COMPAT_ULTRIX(8)System Manager's ManualCOMPAT_ULTRIX(8)
+
+
+

+

compat_ultrix — + setup procedure for ULTRIX compatibility on MIPS and VAX + architectures

+
+
+

+

NetBSD/mips and + NetBSD/vax architectures can run Risc ULTRIX and VAX + ULTRIX executables, respectively. However, you have to worry about the legal + issues of ensuring that you have a right to use any ULTRIX binaries on your + machine.

+

Most executables will work. The exceptions include + programs that use proprietary, ULTRIX-specific features (LAT, CI support, + DECnet support) and various system calls, + ()'s, or + ULTRIX kernel semantics that are difficult to emulate (e.g. ULTRIX + packetfilter) or buggy (e.g. ULTRIX NIS).

+

All ULTRIX executables are static, so no shared libraries are + required for ULTRIX compatibility. However, ULTRIX is based on a + 4.3BSD alpha release. ULTRIX commands and libraries + are often much older than their NetBSD or even SunOS + 4.x equivalents, and may require incompatible configuration files.

+
+
+

+

Set up resolv.conf and + svc.conf as below:

+

+
+
+
# mkdir -p /emul/ultrix/etc
+
+
+
+
# cd /emul/ultrix/etc
+
+
+
+
# egrep 'domain|nameserver' /etc/resolv.conf > ./resolv.conf
+
+
+
+
# cp -p /usr/share/examples/emul/ultrix/etc/* ./
+
 
+
+
+
+

+

The ULTRIX resolver library only understands + + and + + lines in resolv.conf(5). You should create a copy of + /etc/resolv.conf containing only those commands and + put it in /emul/ultrix/etc/resolv.conf. Note that + the domain search order used by ULTRIX executables may not be the same as + native binaries; there is no good way around this.

+
+
+

+

ULTRIX uses /etc/svc.conf to select an + ordered search of NIS, Hesiod, or local flat-file mappings. You should + create an /emul/ultrix/etc/svc.conf specifying + either local files or bind (DNS) lookups for all ULTRIX name services.

+
+
+
+

+

resolv.conf(5)

+
+
+

+

RISC ULTRIX NIS (YP) is known to not work. The ULTRIX NIS + libraries have a consistent endian-ness bug. ULTRIX NIS client will not + inter-operate with the NetBSD + ypbind(8) process. The only workaround is to use + /etc/svc.conf to disable NIS (YP).

+

The ndbm hashed-password file used by ULTRIX are incompatible with + the db hashed-password file used by NetBSD. There is + no good solution for this. NIS would be a good one, if ULTRIX NIS + worked.

+

The API used by Xservers to talk to the kernel is currently + compatible with ULTRIX 4.1. An implementation of the ULTRIX 4.2 Xws + interface (used by X11R6) is in progress.

+

A complete list of things which fail to work in ULTRIX + compatibility mode should be added here.

+
+
+ + + + + +
January 16, 1999NetBSD 10.1
diff --git a/static/netbsd/man8/comsat.8 b/static/netbsd/man8/comsat.8 new file mode 100644 index 00000000..8820ac30 --- /dev/null +++ b/static/netbsd/man8/comsat.8 @@ -0,0 +1,114 @@ +.\" $NetBSD: comsat.8,v 1.15 2016/12/20 09:22:18 abhinav Exp $ +.\" +.\" Copyright (c) 1983, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)comsat.8 8.1 (Berkeley) 6/4/93 +.\" +.Dd May 29, 2010 +.Dt COMSAT 8 +.Os +.Sh NAME +.Nm comsat +.Nd biff server +.Sh SYNOPSIS +.Nm +.Op Fl l +.Sh DESCRIPTION +.Nm +is the server process which receives reports of incoming mail +and notifies users if they have requested this service. +.Nm +receives messages on a datagram port associated with the +.Dq biff +service +specification (see +.Xr services 5 +and +.Xr inetd 8 ) . +The one line messages are of the form: +.Pp +.Dl user@mailbox-offset +.Pp +If the +.Em user +specified is logged in to the system and the associated terminal has +the owner execute bit turned on (by a +.Dq Li biff y ) , +the +.Em offset +is used as a seek offset into the appropriate mailbox file and +the first 7 lines or 560 characters of the message are printed +on the user's terminal. +Lines which appear to be part of the message header other than the +.Dq From +or +.Dq Subject +lines are not included in the displayed message. +.Sh OPTIONS +The +.Nm +program supports this option: +.Bl -tag -width 12345 +.It Fl l +The +.Fl l +option turns on +.Xr syslogd 8 +log messages. +.El +.Sh FILES +To find out who's logged on and on what terminals +.Nm +consults: +.Pp +.Bl -tag -width /var/run/utmpx -compact +.It Pa /var/run/utmp +.It Pa /var/run/utmpx +.El +.Sh SEE ALSO +.Xr biff 1 , +.Xr services 5 , +.Xr inetd 8 , +.Xr syslogd 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.2 . +.Sh BUGS +The message header filtering is prone to error. +The density of the information presented is near the theoretical minimum. +.Pp +Users should be notified of mail which arrives on other +machines than the one to which they are currently logged in. +.Pp +The notification should appear in a separate window so it +does not mess up the screen. +.Pp +.Nm +runs as root so that it can open the user's maildrop. diff --git a/static/netbsd/man8/cpuctl.8 b/static/netbsd/man8/cpuctl.8 new file mode 100644 index 00000000..c4d518ea --- /dev/null +++ b/static/netbsd/man8/cpuctl.8 @@ -0,0 +1,158 @@ +.\" $NetBSD: cpuctl.8,v 1.23 2024/03/19 01:19:11 gutteridge Exp $ +.\" +.\" Copyright (c) 2007, 2008, 2012, 2015 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Andrew Doran. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 12, 2023 +.Dt CPUCTL 8 +.Os +.Sh NAME +.Nm cpuctl +.Nd program to control CPUs +.Sh SYNOPSIS +.Nm cpuctl +.Op Fl v +.Ar command +.Op Ar arguments +.Sh DESCRIPTION +The +.Nm +command can be used to control and inspect the state of CPUs in the system. +.Pp +The first argument, +.Ar command , +specifies the action to take. +Valid commands are: +.Bl -tag -width identify +.It identify Ar cpu Op Ar cpu ... +Output information on the specified CPU's features and capabilities. +Not available on all architectures. +.It intr Ar cpu Op Ar cpu ... +Enable interrupts for the specified CPUs if supported. +.It list +For each CPU in the system, display the current state and time of the last +state change. +.It nointr Ar cpu Op Ar cpu ... +Disable interrupts for the specified CPUs if supported. +.It offline Ar cpu Op Ar cpu ... +Set the specified CPUs off line. +.Pp +Unbound LWPs (lightweight processes) will not be executed on a CPU +while it is off line. +Bound LWPs will continue to be executed on the CPUs, and device interrupts +routed to the CPUs will continue to be handled. +A future release of the system may allow device interrupts to be re-routed +away from individual CPUs. +.Pp +At least one CPU in the system must remain on line. +.It online Ar cpu Op Ar cpu ... +Set the specified CPUs on line, making them available to run unbound LWPs. +.It ucode Xo +.Op Ar cpu +.Op Ar file +.Xc +This applies the microcode patch to CPUs. +Unless +.Fl v +was given, errors indicating that the microcode +already exists on the CPU in question are ignored. +If +.Ar cpu +is not specified or \-1, all CPUs are updated. +(AMD CPU updates need to update all CPUs at once.) +If +.Ar cpu +is \-2, the current CPUs are updated. +The default filename is used if no filename is specified. +The +.Ar file +pathname containing the ucode updates are searched relative to the +default firmware path found in +.Xr sysctl 7 +.Pa hw.firmware.path . +The +.Cm identify +command prints the installed version on the specified CPUs. +On success the +.Cm identify +command shows different ucode versions before and after this command. +.Pp +Some problems will only be reported in the kernel message buffer, +so check +.Xr dmesg 8 +in case of errors. +.El +.Pp +Valid flags are: +.Bl -tag -width indent +.It Fl v +Be more verbose. +.El +.Sh FILES +.Bl -tag -width /dev/cpuctl -compact +.It Pa /dev/cpuctl +control device +.It Pa /libdata/firmware/x86/amd/ +The directory to install the microcode file for AMD CPUs into. +The default filename is +.Pa microcode_amd.bin +for CPU families 0x10 to 0x14. +The default filename is +.Pa microcode_amd_famXXh.bin +where +.Dv XX +is the CPU family starting with 15 (hex). +Get it from +.Lk https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/amd-ucode +.El +.Sh EXAMPLES +Run +.Dl cpuctl identify 0 +and you should see something like this: +.Bd -literal -offset indent +cpu0: UCode version: 0x1000080 +.Ed +.Pp +After applying the microcode patch with +.Dl cpuctl ucode 0 +you can see with +.Dl cpuctl identify 0 +that the patch got applied: +.Bd -literal -offset indent +cpu0: UCode version: 0x1000083 +.Ed +.Sh SEE ALSO +.Xr intrctl 8 , +.Xr psrset 8 , +.Xr schedctl 8 , +.Xr sysctl 8 , +.Xr firmload 9 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 5.0 . diff --git a/static/netbsd/man8/crash.8 b/static/netbsd/man8/crash.8 new file mode 100644 index 00000000..b3684591 --- /dev/null +++ b/static/netbsd/man8/crash.8 @@ -0,0 +1,205 @@ +.\" $NetBSD: crash.8,v 1.12 2009/03/09 19:24:32 joerg Exp $ +.\" +.\" Copyright (c) 1980, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)crash.8 8.1 (Berkeley) 6/5/93 +.\" +.Dd June 5, 1993 +.Dt CRASH 8 vax +.Os +.Sh NAME +.Nm crash +.Nd UNIX system failures +.Sh DESCRIPTION +This section explains what happens when the system crashes +and (very briefly) how to analyze crash dumps. +.Pp +When the system crashes voluntarily it prints a message of the form +.Pp +.Dl panic: why i gave up the ghost +.Pp +on the console, takes a dump on a mass storage peripheral, +and then invokes an automatic reboot procedure as +described in +.Xr reboot 8 . +(If auto-reboot is disabled on the front panel of the machine the system +will simply halt at this point.) +Unless some unexpected inconsistency is encountered in the state +of the file systems due to hardware or software failure, the system +will then resume multi-user operations. +.Pp +The system has a large number of internal consistency checks; if one +of these fails, then it will panic with a very short message indicating +which one failed. +In many instances, this will be the name of the routine which detected +the error, or a two-word description of the inconsistency. +A full understanding of most panic messages requires perusal of the +source code for the system. +.Pp +The most common cause of system failures is hardware failure, which +can reflect itself in different ways. Here are the messages which +are most likely, with some hints as to causes. +Left unstated in all cases is the possibility that hardware or software +error produced the message in some unexpected way. +.Bl -tag -width 8n -compact +.It iinit +This cryptic panic message results from a failure to mount the root filesystem +during the bootstrap process. +Either the root filesystem has been corrupted, +or the system is attempting to use the wrong device as root filesystem. +Usually, an alternative copy of the system binary or an alternative root +filesystem can be used to bring up the system to investigate. +.It Can't exec /sbin/init +This is not a panic message, as reboots are likely to be futile. +Late in the bootstrap procedure, the system was unable to locate +and execute the initialization process, +.Xr init 8 . +The root filesystem is incorrect or has been corrupted, or the mode +or type of /sbin/init forbids execution. +.It IO err in push +.It hard IO err in swap +The system encountered an error trying to write to the paging device +or an error in reading critical information from a disk drive. +The offending disk should be fixed if it is broken or unreliable. +.It realloccg: bad optim +.It ialloc: dup alloc +.It alloccgblk: cyl groups corrupted +.It ialloccg: map corrupted +.It free: freeing free block +.It free: freeing free frag +.It ifree: freeing free inode +.It alloccg: map corrupted +These panic messages are among those that may be produced +when filesystem inconsistencies are detected. +The problem generally results from a failure to repair damaged filesystems +after a crash, hardware failures, or other condition that should not +normally occur. +A filesystem check will normally correct the problem. +.It timeout table overflow +This really shouldn't be a panic, but until the data structure +involved is made to be extensible, running out of entries causes a crash. +If this happens, make the timeout table bigger. +.It KSP not valid +.It SBI fault +.It CHM? in kernel +These indicate either a serious bug in the system or, more often, +a glitch or failing hardware. +If SBI faults recur, check out the hardware or call +field service. If the other faults recur, there is likely a bug somewhere +in the system, although these can be caused by a flakey processor. +Run processor microdiagnostics. +.It machine check %x: Em description +.It \0\0\0machine dependent machine-check information +Machine checks are different on each type of CPU. +Most of the internal processor registers are saved at the time of the fault +and are printed on the console. +For most processors, there is one line that summarizes the type of machine +check. +Often, the nature of the problem is apparent from this message +and/or the contents of key registers. +The VAX Hardware Handbook should be consulted, +and, if necessary, your friendly field service people should be informed +of the problem. +.It trap type %d, code=%x, pc=%x +A unexpected trap has occurred within the system; the trap types are: +.Bd -literal -offset indent +0 reserved addressing fault +1 privileged instruction fault +2 reserved operand fault +3 bpt instruction fault +4 xfc instruction fault +5 system call trap +6 arithmetic trap +7 ast delivery trap +8 segmentation fault +9 protection fault +10 trace trap +11 compatibility mode fault +12 page fault +13 page table fault +.Ed +.Pp +The favorite trap types in system crashes are trap types 8 and 9, +indicating +a wild reference. The code is the referenced address, and the pc at the +time of the fault is printed. These problems tend to be easy to track +down if they are kernel bugs since the processor stops cold, but random +flakiness seems to cause this sometimes. +The debugger can be used to locate the instruction and subroutine +corresponding to the PC value. +If that is insufficient to suggest the nature of the problem, +more detailed examination of the system status at the time of the trap +usually can produce an explanation. +.It init died +The system initialization process has exited. This is bad news, as no new +users will then be able to log in. Rebooting is the only fix, so the +system just does it right away. +.It out of mbufs: map full +The network has exhausted its private page map for network buffers. +This usually indicates that buffers are being lost, and rather than +allow the system to slowly degrade, it reboots immediately. +The map may be made larger if necessary. +.El +.Pp +That completes the list of panic types you are likely to see. +.Pp +When the system crashes it writes (or at least attempts to write) +an image of memory into the back end of the dump device, +usually the same as the primary swap +area. After the system is rebooted, the program +.Xr savecore 8 +runs and preserves a copy of this core image and the current +system in a specified directory for later perusal. See +.Xr savecore 8 +for details. +.Pp +To analyze a dump you should begin by running +.Ic adb +with the +.Fl k +flag on the system load image and core dump. +If the core image is the result of a panic, +the panic message is printed. +Normally the command +.Dq $c +will provide a stack trace from the point of +the crash and this will provide a clue as to +what went wrong. +For more detail +see +.Dq Using ADB to Debug the UNIX Kernel . +.Sh SEE ALSO +.Xr gdb 1 , +.Xr reboot 8 +.br +.Dq VAX 11/780 System Maintenance Guide +and +.Dq VAX Hardware Handbook +for more information about machine checks. +.br +.Dq Using ADB to Debug the UNIX Kernel diff --git a/static/netbsd/man8/creds_msdos.8 4.html b/static/netbsd/man8/creds_msdos.8 4.html new file mode 100644 index 00000000..a9d37cce --- /dev/null +++ b/static/netbsd/man8/creds_msdos.8 4.html @@ -0,0 +1,99 @@ + + + + + + +
CREDS_MSDOS(8)System Manager's ManualCREDS_MSDOS(8)
+
+
+

+

creds_msdos — + automatically add login credentials from MS-DOS + partition

+
+
+

+ + + + + +
creds_msdosstart
+
+
+

+

The creds_msdos rc.d script allows + automatic addition of login credentials during boot using a special file + found on the MS-DOS partition of a bootable image. This script is not + distributed with the normal system and is only included with pre-installed + bootable images. The goal is to allow remote access of the system without + having to edit the primary root file system (which may not be accessible + from the host the image is being written from), but place this information + in the MS-DOS partition that most platforms can easily access.

+

Typically, an installable image (such as + arm64.img) is written to an SD card or similar + media, and has both a native FFS partition as well as an MS-DOS partition + for booting. If this script is enabled and has been pointed at the boot + partition it will inspect the file creds.txt for any + credentials to be added to the system.

+

The following list gives the supported options in the credentials + files. In all cases user is the username to be + created, and the user will be added to the + ‘wheel’ group.

+
+
+ user keyfile
+
Look for the keyfile in the MS-DOS boot partition + and merge ssh keys from this file into user's + ~/.ssh/authorized_keys file.
+
+ user keystring
+
Add the keystring to the user's + ~/.ssh/authorized_keys file.
+
+ user pwhash
+
Use pwhash as the users's password hash.
+
+ user password
+
Use password as the users's unencrypted raw password + that will be hashed. +

This method is + + as it leaves unencrypted passwords around until such time that the + script runs. If this method is used then the + creds.txt file will be shredded and deleted + using ‘rm -P’ after the + credentials are updated.

+
+
+
+
+

+

/boot/creds.txt

+
+
+

+

pwhash(1), rm(1), + ssh(1), ssh_config(5), + mount_msdos(8), sshd(8), + useradd(8)

+
+
+

+

The creds_msdos script appeared in + NetBSD 9.0.

+
+
+

+

Matthew R. Green + <mrg@eterna23.net>.

+
+
+ + + + + +
June 10, 2019NetBSD 10.1
diff --git a/static/netbsd/man8/cron.8 b/static/netbsd/man8/cron.8 new file mode 100644 index 00000000..0dc55593 --- /dev/null +++ b/static/netbsd/man8/cron.8 @@ -0,0 +1,181 @@ +.\" $NetBSD: cron.8,v 1.5 2011/10/12 22:50:31 wiz Exp $ +.\" +.\" Id: cron.8,v 1.8 2004/01/23 19:03:32 vixie Exp +.\" +.Dd October 12, 2011 +.Dt CRON 8 +.Os +.Sh NAME +.Nm cron +.Nd daemon to execute scheduled commands (ISC Cron V4.1) +.Sh SYNOPSIS +.Nm +.Op Fl n +.Op Fl x Ar debugflags +.Sh DESCRIPTION +.Nm +is normally started during system boot by +.Xr rc.d 8 +framework, if cron is switched on in +.Xr rc.conf 5 . +.Pp +It will return immediately so you don't have to start it with +.Sq \*[Am] . +.Pp +.Nm +searches +.Pa /var/cron/tabs +for crontab files which are named after accounts in +.Pa /etc/passwd . +Crontabs found are loaded into memory. +.Nm +also searches for +.Pa /etc/crontab +which is in a different format (see +.Xr crontab 5 ) . +Finally +.Nm +looks for crontabs in +.Pa /etc/cron.d +if it exists, and executes each file as a crontab. +.Pp +When +.Nm +looks in a directory for crontabs (either in +.Pa /var/cron/tabs +or +.Pa /etc/cron.d ) +it will not process files that: +.Bl -dash -compact -offset indent +.It +Start with a +.Sq \&. +or a +.Sq # . +.It +End with a +.Sq ~ +or with +.Dq .rpmsave , +.Dq .rpmorig , +or +.Dq .rpmnew . +.It +Are of zero length. +.It +Their length is greater than +.Dv MAXNAMLEN . +.El +.Pp +.Nm +then wakes up every minute, examining all stored crontabs, checking each +command to see if it should be run in the current minute. +When executing commands, any output is mailed to the owner of the +crontab (or to the user named in the +.Ev MAILTO +environment variable in the crontab, if such exists). +.Pp +Events such as +.Dv START +and +.Dv FINISH +are recorded in the +.Pa /var/log/cron +log file with date and time details. +This information is useful for a number of reasons, such as +determining the amount of time required to run a particular job. +By default, root has an hourly job that rotates these log files +with compression to preserve disk space. +.Pp +Additionally, +.Nm +checks each minute to see if its spool directory's modtime (or the modtime +on +.Pa /etc/crontab +or +.Pa /etc/cron.d ) +has changed, and if it has, +.Nm +will then examine the modtime on all crontabs and reload those which have +changed. +Thus +.Nm +need not be restarted whenever a crontab file is modified. +Note that the +.Xr crontab 1 +command updates the modtime of the spool directory whenever it changes a +crontab. +.Pp +The following options are available: +.Bl -tag -width indent +.It Fl x +This flag turns on some debugging flags. +.Ar debugflags +is comma-separated list of debugging flags to turn on. +If a flag is turned on, +.Nm +writes some additional debugging information to system log during +its work. +Available debugging flags are: +.Bl -tag -width proc -compact +.It Ar sch +scheduling +.It Ar proc +process control +.It Ar pars +parsing +.It Ar load +database loading +.It Ar misc +miscellaneous +.It Ar test +test mode - do not actually execute any commands +.It Ar bit +show how various bits are set (long) +.It Ar ext +print extended debugging information +.El +.It Fl n +Stay in the foreground and don't daemonize +.Nm . +.El +.Sh Daylight Saving Time and other time changes +Local time changes of less than three hours, such as those caused +by the start or end of Daylight Saving Time, are handled specially. +This only applies to jobs that run at a specific time and jobs that +are run with a granularity greater than one hour. +Jobs that run more frequently are scheduled normally. +.Pp +If time has moved forward, those jobs that would have run in the +interval that has been skipped will be run immediately. +Conversely, if time has moved backward, care is taken to avoid running +jobs twice. +.Pp +Time changes of more than 3 hours are considered to be corrections to +the clock or timezone, and the new time is used immediately. +.Sh SIGNALS +On receipt of a +.Dv SIGHUP , +the cron daemon will close and reopen its +log file. +This is useful in scripts which rotate and age log files. +Naturally this is not relevant if cron was built to use +.Xr syslog 3 . +.Sh FILES +.Bl -tag -width /var/cron/tabs -compact +.It Pa /var/cron/tabs +.Nm +spool directory +.It Pa /etc/crontab +system crontab file +.It Pa /etc/cron.d/ +system crontab directory +.It Pa /var/log/cron +log file for cron events +.El +.Sh SEE ALSO +.Xr crontab 1 , +.Xr crontab 5 +.Sh AUTHORS +.An Paul Vixie +.Aq vixie@isc.org diff --git a/static/netbsd/man8/cvsbug.8 b/static/netbsd/man8/cvsbug.8 new file mode 100644 index 00000000..f5a96b39 --- /dev/null +++ b/static/netbsd/man8/cvsbug.8 @@ -0,0 +1,243 @@ +.\" -*- nroff -*- +.\" --------------------------------------------------------------------------- +.\" man page for send-pr (by Heinz G. Seidl, hgs@cygnus.com) +.\" updated Feb 1993 for GNATS 3.00 by Jeffrey Osier, jeffrey@cygnus.com +.\" +.\" This file is part of the Problem Report Management System (GNATS) +.\" Copyright 1992 Cygnus Support +.\" +.\" This program is free software; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public +.\" License as published by the Free Software Foundation; either +.\" version 2 of the License, or (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +.\" General Public License for more details. +.\" +.\" --------------------------------------------------------------------------- +.nh +.TH CVSBUG 8 xVERSIONx "February 1993" +.SH NAME +cvsbug \- send problem report (PR) about CVS to a central support site +.SH SYNOPSIS +.B cvsbug +[ +.I site +] +[ +.B \-f +.I problem-report +] +[ +.B \-t +.I mail-address +] +.br +.in +0.8i +[ +.B \-P +] +[ +.B \-L +] +[ +.B \-\-request-id +] +[ +.B \-v +] +.SH DESCRIPTION +.B cvsbug +is a tool used to submit +.I problem reports +.\" SITE ADMINISTRATORS - change this if you use a local default +(PRs) to a central support site. In most cases the correct +.I site +will be the default. This argument indicates the support site which +is responsible for the category of problem involved. Some sites may +use a local address as a default. +.I site +values are defined by using the +.BR aliases (5). +.LP +.B cvsbug +invokes an editor on a problem report template (after trying to fill +in some fields with reasonable default values). When you exit the +editor, +.B cvsbug +sends the completed form to the +.I Problem Report Management System +(\fBGNATS\fR) at a central support site. At the support site, the PR +is assigned a unique number and is stored in the \fBGNATS\fR database +according to its category and submitter-id. \fBGNATS\fR automatically +replies with an acknowledgement, citing the category and the PR +number. +.LP +To ensure that a PR is handled promptly, it should contain your (unique) +\fIsubmitter-id\fR and one of the available \fIcategories\fR to identify the +problem area. (Use +.B `cvsbug -L' +to see a list of categories.) +.LP +The +.B cvsbug +template at your site should already be customized with your +submitter-id (running `\|\fBinstall-sid\fP \fIsubmitter-id\fP\|' to +accomplish this is part of the installation procedures for +.BR cvsbug ). +If this hasn't been done, see your system administrator for your +submitter-id, or request one from your support site by invoking +.B `cvsbug \-\-request\-id'. +If your site does not distinguish between different user sites, or if +you are not affiliated with the support site, use +.B `net' +for this field. +.LP +The more precise your problem description and the more complete your +information, the faster your support team can solve your problems. +.SH OPTIONS +.TP +.BI \-f " problem-report" +specify a file (\fIproblem-report\fR) which already contains a +complete problem report. +.B cvsbug +sends the contents of the file without invoking the editor. If +the value for +.I problem-report +is +.BR `\|\-\|' , +then +.B cvsbug +reads from standard input. +.TP +.BI \-t " mail-address" +Change mail address at the support site for problem reports. The +default +.I mail-address +is the address used for the default +.IR site . +Use the +.I site +argument rather than this option in nearly all cases. +.TP +.B \-P +print the form specified by the environment variable +.B PR_FORM +on standard output. If +.B PR_FORM +is not set, print the standard blank PR template. No mail is sent. +.TP +.B -L +print the list of available categories. No mail is sent. +.TP +.B \-\-request\-id +sends mail to the default support site, or +.I site +if specified, with a request for your +.IR submitter-id . +If you are +not affiliated with +.IR site , +use a +.I submitter-id +of +.BR net \|'. +.TP +.B \-v +Display the +.B cvsbug +version number. +.LP +Note: use +.B cvsbug +to submit problem reports rather than mailing them directly. Using +both the template and +.B cvsbug +itself will help ensure all necessary information will reach the +support site. +.SH ENVIRONMENT +The environment variable +.B EDITOR +specifies the editor to invoke on the template. +.br +default: +.B vi +.sp +If the environment variable +.B PR_FORM +is set, then its value is used as the file name of the template for +your problem-report editing session. You can use this to start with a +partially completed form (for example, a form with the identification +fields already completed). +.SH "HOW TO FILL OUT A PROBLEM REPORT" +Problem reports have to be in a particular form so that a program can +easily manage them. Please remember the following guidelines: +.IP \(bu 3m +describe only +.B one problem +with each problem report. +.IP \(bu 3m +For follow-up mail, use the same subject line as the one in the automatic +acknowledgement. It consists of category, PR number and the original synopsis +line. This allows the support site to relate several mail messages to a +particular PR and to record them automatically. +.IP \(bu 3m +Please try to be as accurate as possible in the subject and/or synopsis line. +.IP \(bu 3m +The subject and the synopsis line are not confidential. This is +because open-bugs lists are compiled from them. Avoid confidential +information there. +.LP +See the GNU +.B Info +file +.B cvsbug.info +or the document \fIReporting Problems With cvsbug\fR\ for detailed +information on reporting problems +.SH "HOW TO SUBMIT TEST CASES, CODE, ETC." +Submit small code samples with the PR. Contact the support site for +instructions on submitting larger test cases and problematic source +code. +.SH FILES +.ta \w'/tmp/pbad$$ 'u +/tmp/p$$ copy of PR used in editing session +.br +/tmp/pf$$ copy of empty PR form, for testing purposes +.br +/tmp/pbad$$ file for rejected PRs +.SH INSTALLATION AND CONFIGURATION +See +.B INSTALL +for installation instructions. +.SH SEE ALSO +.BR gnats (l), +.BR query-pr (1), +.BR edit-pr (1), +.BR gnats (8), +.BR queue-pr (8), +.BR at-pr (8), +.BR mkcat (8), +.BR mkdist (8). +.SH AUTHORS +Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus +Support) +.SH COPYING +Copyright (c) 1992, 1993 Free Software Foundation, Inc. +.PP +Permission is granted to make and distribute verbatim copies of +this manual provided the copyright notice and this permission notice +are preserved on all copies. +.PP +Permission is granted to copy and distribute modified versions of this +manual under the conditions for verbatim copying, provided that the +entire resulting derived work is distributed under the terms of a +permission notice identical to this one. +.PP +Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be included in +translations approved by the Free Software Foundation instead of in +the original English. + diff --git a/static/netbsd/man8/dbsym.8 b/static/netbsd/man8/dbsym.8 new file mode 100644 index 00000000..707986b7 --- /dev/null +++ b/static/netbsd/man8/dbsym.8 @@ -0,0 +1,72 @@ +.\" $NetBSD: dbsym.8,v 1.4 2014/08/17 19:12:59 joerg Exp $ +.\" +.Dd August 14, 2014 +.Dt DBSYM 8 +.Os +.Sh NAME +.Nm dbsym +.Nd copy kernel symbol table into db_symtab space +.Sh SYNOPSIS +.Nm +.Op Fl Ppv +.Op Fl b Ar bfdname +.Ar kernel +.Sh DESCRIPTION +.Nm +is used to copy the symbol table in a newly linked kernel into the +.Va db_symtab +array (in the data section) so that the +.Xr ddb 4 +kernel debugger can find the symbols. +This program is only used +on systems for which the boot program does not load the symbol table +into memory with the kernel. +The space for these symbols is +reserved in the data segment using a config option like: +.Dl options SYMTAB_SPACE=72000 +The size of the db_symtab array (the value of SYMTAB_SPACE) must be +at least as large as the kernel symbol table. +If insufficient space +is reserved, dbsym will refuse to copy the symbol table. +.Pp +To recognize kernel executable format, the +.Fl b +flag specifies BFD name of kernel. +.Pp +If the +.Fl P +flag is given, +.Nm +will report the size of the kernel symbol table. +.Pp +If the +.Fl p +flag is given, +.Nm +will report the size of the kernel symbol table and the size of the +db_symtab space. +Two values are printed out in a line separated by a space. +.Pp +If the +.Fl v +flag is given, +.Nm +will print out status information as +it is copying the symbol table. +.Pp +Note that debugging symbols are not useful to the +.Xr ddb 4 +kernel debugger, so to minimize the size of the kernel, one should +either compile the kernel without debugging symbols (no +.Fl g +flag) or use the +.Xr strip 1 +command to strip debugging symbols from the kernel before +.Nm +is used to copy the symbol table. +The command +.Dl strip -d netbsd +will strip out debugging symbols. +.Sh SEE ALSO +.Xr strip 1 , +.Xr ddb 4 diff --git a/static/netbsd/man8/defer.8 b/static/netbsd/man8/defer.8 new file mode 100644 index 00000000..dc17bf22 --- /dev/null +++ b/static/netbsd/man8/defer.8 @@ -0,0 +1,3 @@ +.\" $NetBSD: defer.8,v 1.1.1.1 2009/06/23 10:08:34 tron Exp $ +.\" +.so man8/bounce.8 diff --git a/static/netbsd/man8/dev_mkdb.8 b/static/netbsd/man8/dev_mkdb.8 new file mode 100644 index 00000000..005ed05f --- /dev/null +++ b/static/netbsd/man8/dev_mkdb.8 @@ -0,0 +1,95 @@ +.\" Copyright (c) 1990, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)dev_mkdb.8 8.1 (Berkeley) 6/6/93 +.\" $NetBSD: dev_mkdb.8,v 1.14 2017/07/03 21:35:30 wiz Exp $ +.\" +.Dd June 1, 2012 +.Dt DEV_MKDB 8 +.Os +.Sh NAME +.Nm dev_mkdb +.Nd create +.Pa /dev +database +.Sh SYNOPSIS +.Nm +.Op Fl c +.Op Fl o Ar database +.Op directory +.Sh DESCRIPTION +The +.Nm +command creates a +.Xr cdbr 3 +database in +.Dq Pa /var/run/dev.cdb +which contains the names of all of the character and block special +files in the specified directory, using the file type and the +.Fa st_rdev +field as the key. +If no directory is specified, the +.Dq Pa /dev +directory is used. +.Pp +Keys are a structure containing a mode_t followed by a dev_t, +with any padding zero'd out. +The former is the type of the file (st_mode & S_IFMT), +the latter is the st_rdev field. +.Pp +The options are as follows: +.Bl -tag -width indent +.It Fl c +Create a +.Xr db 3 +database for compatibility with libc versions and statically linked programs +from before +.Nx 6.0 . +The default name is +.Dq Pa /var/run/dev.db . +.It Fl o Ar database +Put the output databases in the named file. +.El +.Sh FILES +.Bl -tag -width /var/run/dev.db -compact +.It Pa /dev +Device directory. +.It Pa /var/run/dev.db +Database file. +.El +.Sh SEE ALSO +.Xr ps 1 , +.Xr stat 2 , +.Xr db 3 , +.Xr devname 3 , +.Xr kvm_nlist 3 , +.Xr ttyname 3 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.4 . diff --git a/static/netbsd/man8/devpubd.8 b/static/netbsd/man8/devpubd.8 new file mode 100644 index 00000000..62a48386 --- /dev/null +++ b/static/netbsd/man8/devpubd.8 @@ -0,0 +1,79 @@ +.\" $NetBSD: devpubd.8,v 1.7 2020/02/24 11:59:33 wiz Exp $ +.\" +.\" Copyright (c) 2011-2013 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Thomas Klausner. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 24, 2020 +.Dt DEVPUBD 8 +.Os +.Sh NAME +.Nm devpubd +.Nd device publish daemon for automatic device node creation +.Sh SYNOPSIS +.Nm +.Op Fl 1f +.Sh DESCRIPTION +.Nm +listens on +.Xr drvctl 4 +for new devices and creates their device nodes using +.Xr MAKEDEV 8 +if they are missing. +.Pp +When +.Fl f +is specified, +.Nm +does not go into the background. +With the option +.Fl 1 +it will also exit after the initial setup of device nodes. +.Pp +.Nm +runs +.Pa /libexec/devpubd-run-hooks . +This script runs each script found in +.Pa /libexec/devpubd-hooks +in a lexical order with two arguments: +.Ar device-attach +or +.Ar device-detach +and the device file name. +The default installation supplies the +.Pa 01-makedev +script for creating a device node and the +.Pa 02-wedgenames +script for creating symlinks to wedge devices under /dev/wedges. +Additional scripts may be added for other dynamic device actions. +.Sh SEE ALSO +.Xr drvctl 8 , +.Xr MAKEDEV 8 +.Sh HISTORY +A +.Nm +utility appeared in +.Nx 6.0 . diff --git a/static/netbsd/man8/dhclient-script.8 b/static/netbsd/man8/dhclient-script.8 new file mode 100644 index 00000000..e179781c --- /dev/null +++ b/static/netbsd/man8/dhclient-script.8 @@ -0,0 +1,241 @@ +.\" $NetBSD: dhclient-script.8,v 1.3 2022/04/03 01:10:57 christos Exp $ +.\" +.\" dhclient-script.8 +.\" +.\" Copyright (C) 2004-2022 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (c) 1996-2003 by Internet Software Consortium +.\" +.\" This Source Code Form is subject to the terms of the Mozilla Public +.\" License, v. 2.0. If a copy of the MPL was not distributed with this +.\" file, You can obtain one at http://mozilla.org/MPL/2.0/. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +.\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" Internet Systems Consortium, Inc. +.\" PO Box 360 +.\" Newmarket, NH 03857 USA +.\" +.\" https://www.isc.org/ +.\" +.\" Support and other services are available for ISC products - see +.\" https://www.isc.org for more information or to learn more about ISC. +.\" +.\" Id: dhclient-script.8,v 1.14 2010/07/02 23:09:14 sar Exp +.\" +.TH dhclient-script 8 +.SH NAME +dhclient-script - DHCP client network configuration script +.SH DESCRIPTION +The DHCP client network configuration script is invoked from time to +time by \fBdhclient(8)\fR. This script is used by the dhcp client to +set each interface's initial configuration prior to requesting an +address, to test the address once it has been offered, and to set the +interface's final configuration once a lease has been acquired. If no +lease is acquired, the script is used to test predefined leases, if +any, and also called once if no valid lease can be identified. +.PP +This script is not meant to be customized by the end user. If local +customizations are needed, they should be possible using the enter and +exit hooks provided (see HOOKS for details). These hooks will allow the +user to override the default behaviour of the client in creating a +.B /etc/resolv.conf +file. +.PP +No standard client script exists for some operating systems, even though +the actual client may work, so a pioneering user may well need to create +a new script or modify an existing one. In general, customizations specific +to a particular computer should be done in the +.B ETCDIR/dhclient.conf +file. If you find that you can't make such a customization without +customizing +.B ETCDIR/dhclient.conf +or using the enter and exit hooks, please submit a bug report. +.SH HOOKS +When it starts, the client script first defines a shell function, +.B make_resolv_conf , +which is later used to create the +.B /etc/resolv.conf +file. To override the default behaviour, redefine this function in +the enter hook script. +.PP +On after defining the make_resolv_conf function, the client script checks +for the presence of an executable +.B ETCDIR/dhclient-enter-hooks +script, and if present, it invokes the script inline, using the Bourne +shell \'.\' command. The entire environment documented under OPERATION +is available to this script, which may modify the environment if needed +to change the behaviour of the script. If an error occurs during the +execution of the script, it can set the exit_status variable to a nonzero +value, and +.B CLIENTBINDIR/dhclient-script +will exit with that error code immediately after the client script exits. +.PP +After all processing has completed, +.B CLIENTBINDIR/dhclient-script +checks for the presence of an executable +.B ETCDIR/dhclient-exit-hooks +script, which if present is invoked using the \'.\' command. The exit +status of dhclient-script will be passed to dhclient-exit-hooks in the +exit_status shell variable, and will always be zero if the script +succeeded at the task for which it was invoked. The rest of the +environment as described previously for dhclient-enter-hooks is also +present. The +.B ETCDIR/dhclient-exit-hooks +script can modify the valid of exit_status to change the exit status +of dhclient-script. +.SH OPERATION +When dhclient needs to invoke the client configuration script, it +defines a set of variables in the environment, and then invokes +.B CLIENTBINDIR/dhclient-script. +In all cases, $reason is set to the name of the reason why the script +has been invoked. The following reasons are currently defined: +MEDIUM, PREINIT, BOUND, RENEW, REBIND, REBOOT, EXPIRE, FAIL, STOP, RELEASE, +NBI and TIMEOUT. +.PP +.SH MEDIUM +The DHCP client is requesting that an interface's media type +be set. The interface name is passed in $interface, and the media +type is passed in $medium. +.SH PREINIT +The DHCP client is requesting that an interface be configured as +required in order to send packets prior to receiving an actual +address. For clients which use the BSD socket library, this means +configuring the interface with an IP address of 0.0.0.0 and a +broadcast address of 255.255.255.255. For other clients, it may be +possible to simply configure the interface up without actually giving +it an IP address at all. The interface name is passed in $interface, +and the media type in $medium. +.PP +If an IP alias has been declared in dhclient.conf, its address will be +passed in $alias_ip_address, and that ip alias should be deleted from +the interface, along with any routes to it. +.SH BOUND +The DHCP client has done an initial binding to a new address. The +new ip address is passed in $new_ip_address, and the interface name is +passed in $interface. The media type is passed in $medium. Any +options acquired from the server are passed using the option name +described in \fBdhcp-options\fR, except that dashes (\'-\') are replaced +by underscores (\'_\') in order to make valid shell variables, and the +variable names start with new_. So for example, the new subnet mask +would be passed in $new_subnet_mask. Options from a non-default +universe will have the universe name prepended to the option name, for +example $new_dhcp6_server_id. The options that the client +explicitly requested via a PRL or ORO option are passed with the same +option name as above but prepended with requested_ and with a value of 1, +for example requested_subnet_mask=1. No such variable is defined for +options not requested by the client or options that don't require a +request option, such as the ip address (*_ip_address) or expiration +time (*_expiry). +.PP +Before actually configuring the address, dhclient-script should +somehow ARP for it and exit with a nonzero status if it receives a +reply. In this case, the client will send a DHCPDECLINE message to +the server and acquire a different address. This may also be done in +the RENEW, REBIND, or REBOOT states, but is not required, and indeed +may not be desirable. +.PP +When a binding has been completed, a lot of network parameters are +likely to need to be set up. A new /etc/resolv.conf needs to be +created, using the values of $new_domain_name and +$new_domain_name_servers (which may list more than one server, +separated by spaces). A default route should be set using +$new_routers, and static routes may need to be set up using +$new_static_routes. +.PP +If an IP alias has been declared, it must be set up here. The alias +IP address will be written as $alias_ip_address, and other DHCP +options that are set for the alias (e.g., subnet mask) will be passed +in variables named as described previously except starting with +$alias_ instead of $new_. Care should be taken that the alias IP +address not be used if it is identical to the bound IP address +($new_ip_address), since the other alias parameters may be incorrect +in this case. +.SH RENEW +When a binding has been renewed, the script is called as in BOUND, +except that in addition to all the variables starting with $new_, and +$requested_ there is another set of variables starting with $old_. +Persistent settings that may have changed need to be deleted - for +example, if a local route to the bound address is being configured, +the old local route should be deleted. If the default route has changed, +the old default route should be deleted. If the static routes have changed, +the old ones should be deleted. Otherwise, processing can be done as with +BOUND. +.SH REBIND +The DHCP client has rebound to a new DHCP server. This can be handled +as with RENEW, except that if the IP address has changed, the ARP +table should be cleared. +.SH REBOOT +The DHCP client has successfully reacquired its old address after a +reboot. This can be processed as with BOUND. +.SH EXPIRE +The DHCP client has failed to renew its lease or acquire a new one, +and the lease has expired. The IP address must be relinquished, and +all related parameters should be deleted, as in RENEW and REBIND. +.SH FAIL +The DHCP client has been unable to contact any DHCP servers, and any +leases that have been tested have not proved to be valid. The +parameters from the last lease tested should be deconfigured. This +can be handled in the same way as EXPIRE. +.SH STOP +The dhclient has been informed to shut down gracefully, the +dhclient-script should unconfigure or shutdown the interface as +appropriate. +.SH RELEASE +The dhclient has been executed using the -r flag, indicating that the +administrator wishes it to release its lease(s). dhclient-script should +unconfigure or shutdown the interface. +.SH NBI +No-Broadcast-Interfaces...dhclient was unable to find any interfaces +upon which it believed it should commence DHCP. What dhclient-script +should do in this situation is entirely up to the implementor. +.SH TIMEOUT +The DHCP client has been unable to contact any DHCP servers. +However, an old lease has been identified, and its parameters have +been passed in as with BOUND. The client configuration script should +test these parameters and, if it has reason to believe they are valid, +should exit with a value of zero. If not, it should exit with a +nonzero value. +.SH V6ONLY +The DHCPv4 client has received a requested valid v6-only-preferred +option. The system should disable IPv4 on the interface. On its side +the dhclient waits for V6ONLY_WAIT seconds (the timer is carried by +the option with a minimum of MIN_V6ONLY_WAIT) before returning in +the INIT state. +.PP +The usual way to test a lease is to set up the network as with REBIND +(since this may be called to test more than one lease) and then ping +the first router defined in $routers. If a response is received, the +lease must be valid for the network to which the interface is +currently connected. It would be more complete to try to ping all of +the routers listed in $new_routers, as well as those listed in +$new_static_routes, but current scripts do not do this. +.SH FILES +Each operating system should generally have its own script file, +although the script files for similar operating systems may be similar +or even identical. The script files included in Internet +Systems Consortium DHCP distribution appear in the distribution tree +under client/scripts, and bear the names of the operating systems on +which they are intended to work. +.SH BUGS +If more than one interface is being used, there's no obvious way to +avoid clashes between server-supplied configuration parameters - for +example, the stock dhclient-script rewrites /etc/resolv.conf. If +more than one interface is being configured, /etc/resolv.conf will be +repeatedly initialized to the values provided by one server, and then +the other. Assuming the information provided by both servers is +valid, this shouldn't cause any real problems, but it could be +confusing. +.SH SEE ALSO +dhclient(8), dhcpd(8), dhcrelay(8), dhclient.conf(5) and +dhclient.leases(5). +.SH AUTHOR +.B dhclient-script(8) +To learn more about Internet Systems Consortium, +see +.B https://www.isc.org. diff --git a/static/netbsd/man8/dhclient.8 b/static/netbsd/man8/dhclient.8 new file mode 100644 index 00000000..c34cd568 --- /dev/null +++ b/static/netbsd/man8/dhclient.8 @@ -0,0 +1,617 @@ +.\" $NetBSD: dhclient.8,v 1.4 2022/04/03 01:10:57 christos Exp $ +.\" +.\" Id: dhclient.8,v 1.36 2011/04/15 21:58:12 sar Exp +.\" +.\" Copyright (C) 2004-2022 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (c) 1996-2003 by Internet Software Consortium +.\" +.\" This Source Code Form is subject to the terms of the Mozilla Public +.\" License, v. 2.0. If a copy of the MPL was not distributed with this +.\" file, You can obtain one at http://mozilla.org/MPL/2.0/. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +.\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" Internet Systems Consortium, Inc. +.\" PO Box 360 +.\" Newmarket, NH 03857 USA +.\" +.\" https://www.isc.org/ +.\" +.\" Support and other services are available for ISC products - see +.\" https://www.isc.org for more information or to learn more about ISC. +.\" +.TH dhclient 8 +.SH NAME +dhclient - Dynamic Host Configuration Protocol Client +.SH SYNOPSIS +.B dhclient +[ +.B -4 +| +.B -6 +] +[ +.B -S +] +[ +.B -N +[ +.B -N... +] +] +[ +.B -T +[ +.B -T... +] +] +[ +.B -P +[ +.B -P... +] +] +[ +.B -R +] +[ +.B -i +] +[ +.B -I +] +[ +.B -4o6 +.I port +] +[ +.B -D +.I LL|LLT +] +[ +.B -p +.I port-number +] +[ +.B -d +] +[ +.B -df +.I duid-lease-file +] +[ +.B -e +.I VAR=value +] +[ +.B -m +] +[ +.B -q +] +[ +.B -1 +] +[ +.B -r +| +.B -x +] +[ +.B -lf +.I lease-file +] +[ +.B -pf +.I pid-file +] +[ +.B --no-pid +] +[ +.B -cf +.I config-file +] +[ +.B -sf +.I script-file +] +[ +.B -s +.I server-addr +] +[ +.B -g +.I relay +] +[ +.B -n +] +[ +.B -nw +] +[ +.B -w +] +[ +.B --dad-wait-time +.I seconds +] +[ +.B --prefix-len-hint +.I length +] +[ +.B --decline-wait-time +.I seconds +] +[ +.B -v +] +[ +.B --version +] +[ +.I if0 +[ +.I ...ifN +] +] +.SH DESCRIPTION +The Internet Systems Consortium DHCP Client, \fBdhclient\fR, provides a +means for configuring one or more network interfaces using the Dynamic +Host Configuration Protocol, BOOTP protocol, or if these protocols +fail, by statically assigning an address. +.SH OPERATION +.PP +The DHCP protocol allows a host to contact a central server which +maintains a list of IP addresses which may be assigned on one or more +subnets. A DHCP client may request an address from this pool, and +then use it on a temporary basis for communication on network. The +DHCP protocol also provides a mechanism whereby a client can learn +important details about the network to which it is attached, such as +the location of a default router, the location of a name server, and +so on. +.PP +There are two versions of the DHCP protocol DHCPv4 and DHCPv6. At +startup the client may be started for one or the other via the +.B -4 +or +.B -6 +options. +.PP +On startup, \fBdhclient\fR reads the dhclient.conf +for configuration instructions. It then gets a list of all the +network interfaces that are configured in the current system. For +each interface, it attempts to configure the interface using the DHCP +protocol. +.PP +In order to keep track of leases across system reboots and server +restarts, \fBdhclient\fR keeps a list of leases it has been assigned in the +dhclient.leases file. On startup, after reading the dhclient.conf +file, \fBdhclient\fR reads the dhclient.leases file to refresh its memory +about what leases it has been assigned. +.PP +When a new lease is acquired, it is appended to the end of the +dhclient.leases file. In order to prevent the file from becoming +arbitrarily large, from time to time \fBdhclient\fR creates a new +dhclient.leases file from its in-core lease database. The old version +of the dhclient.leases file is retained under the name +.IR dhclient.leases~ +until the next time \fBdhclient\fR rewrites the database. +.PP +Old leases are kept around in case the DHCP server is unavailable when +\fBdhclient\fR is first invoked (generally during the initial system boot +process). In that event, old leases from the dhclient.leases file +which have not yet expired are tested, and if they are determined to +be valid, they are used until either they expire or the DHCP server +becomes available. +.PP +A mobile host which may sometimes need to access a network on which no +DHCP server exists may be preloaded with a lease for a fixed +address on that network. When all attempts to contact a DHCP server +have failed, \fBdhclient\fR will try to validate the static lease, and if it +succeeds, will use that lease until it is restarted. +.PP +A mobile host may also travel to some networks on which DHCP is not +available but BOOTP is. In that case, it may be advantageous to +arrange with the network administrator for an entry on the BOOTP +database, so that the host can boot quickly on that network rather +than cycling through the list of old leases. +.SH COMMAND LINE +.PP +The names of the network interfaces that \fBdhclient\fR should attempt to +configure may be specified on the command line. If no interface names +are specified on the command line \fBdhclient\fR will normally identify all +network interfaces, eliminating non-broadcast interfaces if +possible, and attempt to configure each interface. +.PP +It is also possible to specify interfaces by name in the dhclient.conf +file. If interfaces are specified in this way, then the client will +only configure interfaces that are either specified in the +configuration file or on the command line, and will ignore all other +interfaces. +.PP +The client normally prints no output during its startup sequence. It +can be made to emit verbose messages displaying the startup sequence events +until it has acquired an address by supplying the +.B -v +command line argument. In either case, the client logs messages using +the +.B syslog(3) +facility. +.SH OPTIONS +.TP +.BI \-4 +Use the DHCPv4 protocol to obtain an IPv4 address and configuration +parameters. This is the default and cannot be combined with +\fB\-6\fR. +.TP +.BI \-6 +Use the DHCPv6 protocol to obtain whatever IPv6 addresses are available +along with configuration parameters. It cannot be combined with +\fB\-4\fR. The \fB\-S -T -P -N\fR and +\fB\-D\fR arguments provide more control over aspects of the DHCPv6 +processing. Note: it is not recommended to mix queries of different +types together or even to share the lease file between them. +.TP +.BI \-4o6 \ port +Participate in the DHCPv4 over DHCPv6 protocol specified by RFC 7341. +This associates a DHCPv4 and a DHCPv6 client to allow the v4 client to +send v4 requests encapsulated in a v6 packet. Communication +between the two clients is done on a pair of UDP sockets bound +to ::1 \fIport\fR and \fIport + 1\fR. Both clients must +be launched using the same \fIport\fR argument. +.TP +.BI \-1 +Try to get a lease once. On failure exit with code 2. In DHCPv6 this +sets the maximum duration of the initial exchange to +.I timeout +(from dhclient.conf with a default of sixty seconds). +.TP +.BI \-d +.\" This is not intuitive. +Force +.B dhclient +to run as a foreground process. Normally the DHCP client will run +in the foreground until is has configured an interface at which time +it will revert to running in the background. This option is useful +when running the client under a debugger, or when running it out of +inittab on System V systems. This implies \fB-v\fR. +.TP +.BI \-nw +Become a daemon immediately (nowait) rather than waiting until an +IP address has been acquired. +.TP +.BI \-m +Don't require that the responding ethernet address of the dhcp server +matches the one we expect. +.TP +.BI \-q +Be quiet at startup, this is the default. +.TP +.BI \-v +Enable verbose log messages. +.\" This prints the version, copyright and URL. +.TP +.BI \-w +Continue running even if no broadcast interfaces were found. Normally +DHCP client will exit if it isn't able to identify any network interfaces +to configure. On laptop computers and other computers with +hot-swappable I/O buses, it is possible that a broadcast interface may +be added after system startup. This flag can be used to cause the client +not to exit when it doesn't find any such interfaces. The +.B omshell(1) +program can then be used to notify the client when a network interface +has been added or removed, so that the client can attempt to configure an IP +address on that interface. +.TP +.BI \-n +Do not configure any interfaces. This is most likely to be useful in +combination with the +.B -w +flag. +.TP +.BI \-e \ VAR=value +Define additional environment variables for the environment where +.B dhclient-script +executes. You may specify multiple +.B \-e +options on the command line. +.TP +.BI \-r +Release the current lease and stop the running DHCP client as previously +recorded in the PID file. When shutdown via this method +.B dhclient-script +will be executed with the specific reason for calling the script set. +The client normally doesn't release the current lease as this is not +required by the DHCP protocol but some cable ISPs require their clients +to notify the server if they wish to release an assigned IP address. +.\" TODO what dhclient-script argument? +.\" When released, +.TP +.BI \-x +Stop the running DHCP client without releasing the current lease. +Kills existing \fBdhclient\fR process as previously recorded in the +PID file. When shutdown via this method +.B dhclient-script +will be executed with the specific reason for calling the script set. +.TP +.BI \-p \ port-number +The UDP port number on which the DHCP client should listen and transmit. +If unspecified, +.B dhclient +uses the default port of 68. This is mostly useful for debugging purposes. +If a different port is specified on which the client should listen and +transmit, the client will also use a different destination port - +one less than the specified port. +.TP +.BI \-s \ server-addr +Specify the server IP address or fully qualified domain name to use as +a destination for DHCP protocol messages before +.B dhclient +has acquired an IP address. Normally, +.B dhclient +transmits these messages to 255.255.255.255 (the IP limited broadcast +address). Overriding this is mostly useful for debugging purposes. This +feature is not supported in DHCPv6 (\fB-6\fR) mode. +.TP +.BI \-g \ relay +.\" mockup relay +Set the giaddr field of all packets to the \fIrelay\fR IP address +simulating a relay agent. This is for testing purposes only and +should not be expected to work in any consistent or useful way. +.TP +.BI \-i +Use a DUID with DHCPv4 clients. If no DUID is available in the +lease file one will be constructed and saved. The DUID will be +used to construct a RFC4361 style client id that will be included +in the client's messages. This client id can be overridden by +setting a client id in the configuration file. Overriding the +client id in this fashion is discouraged. +.TP +.BI \-I +Use the standard DDNS scheme from RFCs 4701 & 4702. +.TP +.TP +.BI \--decline-wait-time \ seconds +Specify the time (in seconds) that an IPv4 client should wait after +declining an address before issuing a discover. The default is +10 seconds as recommended by RFC 2131, Section 3.1.5. A value of +zero equates to no wait at all. +.PP +.BI \--version +Print version number and exit. +.PP +.I Options available for DHCPv6 mode: +.TP +.BI \-S +.\" TODO: mention DUID? +Use Information-request to get only stateless configuration parameters +(i.e., without address). This implies \fB\-6\fR. It also doesn't +rewrite the lease database. +.\" TODO: May not be used with -N -P or -T. ?? +.TP +.BI \-T +.\" TODO wanted_ia_ta++ +Ask for IPv6 temporary addresses, one set per \fB\-T\fR flag. This +implies \fB\-6\fR and also disables the normal address query. +See \fB\-N\fR to restore it. +.TP +.BI \-P +Enable IPv6 prefix delegation. This implies \fB\-6\fR and also +disables the normal address query. See \fB\-N\fR to restore it. +Multiple prefixes can be requested with multiple \fB\-P\fR flags. +Note only one requested interface is allowed. +.TP +.BI \-R +Require that responses include all of the items requested by any +\fB\-N\fR, \fB\-T\fR, or \fB\-P\fR options. Normally even if +the command line includes a number of these the client will be willing +to accept the best lease it can even if the lease doesn't include all +of the requested items. This option causes the client to only +accept leases that include all of the requested items. + +Note well: enabling this may prevent the client from using any +leases it receives if the servers aren't configured to supply +all of the items. +.TP +.BI \-D \ LL\ or\ LLT +Override the default when selecting the type of DUID to use. By default, +DHCPv6 \fBdhclient\fR creates an identifier based on the link-layer address +(DUID-LL) if it is running in stateless mode (with \fB\-S\fR, not +requesting an address), or it creates an identifier based on the +link-layer address plus a timestamp (DUID-LLT) if it is running in +stateful mode (without \fB\-S\fR, requesting an address). When DHCPv4 +is configured to use a DUID using \fB\-i\fR option the default is to use +a DUID-LLT. \fB\-D\fR +overrides these default, with a value of either \fILL\fR or \fILLT\fR. +.TP +.BI \-N +.\" TODO: is this for telling an already running dhclient? +Restore normal address query for IPv6. This implies \fB-6\fR. +It is used to restore normal operation after using \fB-T\fR or \fB-P\fR. +Multiple addresses can be requested with multiple \fB\-N\fR flags. +.TP +.BI \--address-prefix-len \ length +Specify the length of the prefix for IPv6 addresses. This value is passed by +dhclient into the client script via the environment variable, ip6_prefixlen, +when binding IPv6 addresses. The default value is 128. Alternatively you may +change the default at compile time by setting DHCLIENT_DEFAULT_PREFIX_LEN in +includes/site.h. +.PP +.TP +.BI \--dad-wait-time \ seconds +Specify maximum time (in seconds) that the client should wait for the +duplicate address detection (DAD) to complete on an interface. This +value is propagated to the dhclient script in a dad_wait_time environment +variable. If any of the IPv6 addresses on the interface are tentative +(DAD is in progress), the script will wait for the specified number of +seconds for DAD to complete. If the script ignores this variable the +parameter has no effect. +.PP +.TP +.BI \--prefix-len-hint \ length +When used in conjunction with -P, it directs the client to use the given +length to use a prefix hint of, "::/length", when requesting new prefixes. +.PP +.I Modifying default file locations: +The following options can be used to modify the locations a client uses +for its files. They can be particularly useful if, for example, +.B DBDIR +or +.B RUNDIR +have not been mounted when the DHCP client is started. +.TP +.BI \-cf \ config-file +Path to the client configuration file. If unspecified, the default +.B ETCDIR/dhclient.conf +is used. See \fBdhclient.conf(5)\fR for a description of this file. +.TP +.BI \-df \ duid-lease-file +Path to a secondary lease file. If the primary lease file doesn't contain +a DUID this file will be searched. The DUID read from the secondary will +be written to the primary. This option can be used to allow an IPv4 instance +of the client to share a DUID with an IPv6 instance. After starting one of +the instances the second can be started with this option pointing to the +lease file of the first instance. There is no default. If no file is +specified no search is made for a DUID should one not be found in the main +lease file. +.TP +.BI \-lf \ lease-file +Path to the lease database file. If unspecified, the default +.B DBDIR/dhclient.leases +is used. See \fBdhclient.leases(5)\fR for a description of this file. +.TP +.BI \-pf \ pid-file +Path to the process ID file. If unspecified, the default +.B RUNDIR/dhclient.pid +is used. +.TP +.BI \--no-pid +Option to disable writing pid files. By default the program +will write a pid file. If the program is invoked with this +option it will not attempt to kill any existing client processes +even if invoked with \fB-r\fR or \fB-x\fR. +.TP +.BI \-sf \ script-file +Path to the network configuration script invoked by +.B dhclient +when it gets a lease. If unspecified, the default +.B CLIENTBINDIR/dhclient-script +is used. See \fBdhclient-script(8)\fR for a description of this file. +.PP +.SH PORTS +During operations the client may use multiple UDP ports +to provide different functions. Which ports are opened depends +on both the way you compiled your code and the configuration you +supply. The following should provide you an idea of what +ports may be in use. + +Normally a DHCPv4 client will open a raw UDP socket to receive +and send most DHCPv4 packets. It also opens a fallback UDP socket +for use in sending unicast packets. Normally these will both +use the well known port number for BOOTPC. + +For DHCPv6 the client opens a UDP socket on the well known +client port and a fallback UDP socket on a random port for +use in sending unicast messages. Unlike DHCPv4 the well +known socket doesn't need to be opened in raw mode. + +If you have included an omapi port statement in your configuration +file then the client will open a TCP socket on that port to +listen for OMPAI connections. When something connects another +port will be used for the established connection. + +When DDNS is enabled at compile time (see includes/site.h) +the client will open both a v4 and a v6 UDP socket on +random ports. These ports are not opened unless/until the +client first attempts to do an update. If the client is not +configured to do updates, the ports will never be opened. +.PP +.SH CONFIGURATION +The syntax of the \fBdhclient.conf(5)\fR file is discussed separately. +.SH OMAPI +The DHCP client provides some ability to control it while it is +running, without stopping it. This capability is provided using OMAPI, +an API for manipulating remote objects. OMAPI clients connect to the +client using TCP/IP, authenticate, and can then examine the client's +current status and make changes to it. +.PP +Rather than implementing the underlying OMAPI protocol directly, user +programs should use the dhcpctl API or OMAPI itself. Dhcpctl is a +wrapper that handles some of the housekeeping chores that OMAPI does +not do automatically. Dhcpctl and OMAPI are documented in +\fBdhcpctl(3)\fR +and \fBomapi(3)\fR. Most things you'd want to do with the client can +be done directly using the \fBomshell(1)\fR command, rather than +having to write a special program. +.SH THE CONTROL OBJECT +The control object allows you to shut the client down, releasing all +leases that it holds and deleting any DNS records it may have added. +It also allows you to pause the client - this unconfigures any +interfaces the client is using. You can then restart it, which +causes it to reconfigure those interfaces. You would normally pause +the client prior to going into hibernation or sleep on a laptop +computer. You would then resume it after the power comes back. +This allows PC cards to be shut down while the computer is hibernating +or sleeping, and then reinitialized to their previous state once the +computer comes out of hibernation or sleep. +.PP +The control object has one attribute - the state attribute. To shut +the client down, set its state attribute to 2. It will automatically +do a DHCPRELEASE. To pause it, set its state attribute to 3. To +resume it, set its state attribute to 4. +.PP +.SH ENVIRONMENT VARIABLES +.PP +The following environment variables may be defined +to override the builtin defaults for file locations. +Note that use of the related command-line options +will ignore the corresponding environment variable settings. +.TP +.B PATH_DHCLIENT_CONF +The dhclient.conf configuration file. +.TP +.B PATH_DHCLIENT_DB +The dhclient.leases database. +.TP +.B PATH_DHCLIENT_PID +The dhclient PID file. +.TP +.B PATH_DHCLIENT_SCRIPT +The dhclient-script file. +.PP +.SH FILES +.B CLIENTBINDIR/dhclient-script, +.B ETCDIR/dhclient.conf, DBDIR/dhclient.leases, RUNDIR/dhclient.pid, +.B DBDIR/dhclient.leases~. +.SH SEE ALSO +dhcpd(8), dhcrelay(8), dhclient-script(8), dhclient.conf(5), +dhclient.leases(5), dhcp-eval(5). +.SH AUTHOR +.B dhclient(8) +To learn more about Internet Systems Consortium, +see +.B https://www.isc.org +.PP +This client was substantially modified and enhanced by Elliot Poger +for use on Linux while he was working on the MosquitoNet project at +Stanford. +.PP +The current version owes much to Elliot's Linux enhancements, but +was substantially reorganized and partially rewritten by Ted Lemon +so as to use the same networking framework that the Internet Systems +Consortium DHCP server uses. Much system-specific configuration code +was moved into a shell script so that as support for more operating +systems is added, it will not be necessary to port and maintain +system-specific configuration code to these operating systems - instead, +the shell script can invoke the native tools to accomplish the same +purpose. +.PP diff --git a/static/netbsd/man8/dhcpcd-run-hooks.8 b/static/netbsd/man8/dhcpcd-run-hooks.8 new file mode 100644 index 00000000..0fb18b2a --- /dev/null +++ b/static/netbsd/man8/dhcpcd-run-hooks.8 @@ -0,0 +1,241 @@ +.\" Copyright (c) 2006-2025 Roy Marples +.\" All rights reserved +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd October 6, 2025 +.Dt DHCPCD-RUN-HOOKS 8 +.Os +.Sh NAME +.Nm dhcpcd-run-hooks +.Nd DHCP client configuration script +.Sh DESCRIPTION +.Nm +is used by +.Xr dhcpcd 8 +to run any system and user defined hook scripts. +System hook scripts are found in +.Pa /libexec/dhcpcd-hooks +and the user defined hooks are +.Pa /etc/dhcpcd.enter-hook . +and +.Pa /etc/dhcpcd.exit-hook . +The default install supplies hook scripts for configuring +.Pa /etc/resolv.conf +and the hostname. +Your distribution may have included other hook scripts to say configure +ntp or ypbind. +A test hook is also supplied that simply echos the dhcp variables to the +console from DISCOVER message. +.Pp +The hooks scripts are loaded into the current shell rather than executed +in their own process. +This allows each hook script, such as +.Pa /etc/dhcpcd.enter-hook +to customise environment variables or provide alternative functions to hooks +further down the chain. +As such, using the shell builtins +.Ic exit , +.Ic exec +or similar will cause +.Nm +to exit at that point. +.Pp +Each time +.Nm +is invoked, +.Ev $interface +is set to the interface that +.Nm dhcpcd +is run on and +.Ev $reason +is set to the reason why +.Nm +was invoked. +DHCP information to be configured is held in variables starting with the word +new_ and old DHCP information to be removed is held in variables starting with +the word old_. +.Nm dhcpcd +can display the full list of variables it knows about by using the +.Fl V , -variables +argument. +.Pp +Here's a list of reasons why +.Nm +could be invoked: +.Bl -tag -width EXPIREXXXEXPIRE6 +.It Dv PREINIT +dhcpcd is starting up and any pre-initialisation required should be performed now. +.It Dv CARRIER +dhcpcd has detected the carrier is up. +This is generally just a notification and no action need be taken. +.It Dv NOCARRIER +dhcpcd lost the carrier. +The cable may have been unplugged or association to the wireless point lost. +.It Dv NOCARRIER_ROAMING +dhcpcd lost the carrier but the interface configuration is persisted. +The OS has to support wireless roaming or IP Persistence for this to happen. +.It Dv INFORM | Dv INFORM6 +dhcpcd informed a DHCP server about its address and obtained other +configuration details. +.It Dv BOUND | Dv BOUND6 +dhcpcd obtained a new lease from a DHCP server. +.It Dv RENEW | Dv RENEW6 +dhcpcd renewed its lease. +.It Dv REBIND | Dv REBIND6 +dhcpcd has rebound to a new DHCP server. +.It Dv REBOOT | Dv REBOOT6 +dhcpcd successfully requested a lease from a DHCP server. +.It Dv RELEASE | Dv RELEASE6 +dhcpcd has released the lease. +.It Dv DELEGATED6 +dhcpcd assigned a delegated prefix to the interface. +.It Dv IPV4LL +dhcpcd obtained an IPV4LL address, or one was removed. +.It Dv STATIC +dhcpcd has been configured with a static configuration which has not been +obtained from a DHCP server. +.It Dv 3RDPARTY +dhcpcd is monitoring the interface for a 3rd party to give it an IP address. +.It Dv TIMEOUT | TIMEOUT6 +dhcpcd failed to contact any DHCP servers but was able to use an old lease. +.It Dv EXPIRE | EXPIRE6 +dhcpcd's lease or state expired and it failed to obtain a new one. +.It Dv NAK +dhcpcd received a NAK from the DHCP server. +This should be treated as EXPIRE. +.It Dv RECONFIGURE +dhcpcd has been instructed to reconfigure an interface. +.It Dv ROUTERADVERT +dhcpcd has received an IPv6 Router Advertisement, or one has expired. +.It Dv STOP | Dv STOP6 +dhcpcd stopped running on the interface. +.It Dv STOPPED +dhcpcd has stopped entirely. +.It Dv DEPARTED +The interface has been removed. +.It Dv FAIL +dhcpcd failed to operate on the interface. +This normally happens when dhcpcd does not support the raw interface, which +means it cannot work as a DHCP or ZeroConf client. +Static configuration and DHCP INFORM is still allowed. +.It Dv TEST +dhcpcd received an OFFER from a DHCP server but will not configure the +interface. +This is primarily used to test the variables are filled correctly for the +script to process them. +.El +.Sh ENVIRONMENT +.Nm dhcpcd +will clear the environment variables aside from +.Ev $PATH . +The following variables will then be set, along with any protocol supplied +ones. +.Bl -tag -width xnew_delegated_dhcp6_prefix +.It Ev $interface +the name of the interface. +.It Ev $protocol +the protocol that triggered the event. +.It Ev $reason +as described above. +.It Ev $pid +the pid of +.Nm dhcpcd . +.It Ev $ifcarrier +the link status of +.Ev $interface : +.Dv unknown , +.Dv up +or +.Dv down . +.It Ev $ifmetric +.Ev $interface +preference, lower is better. +.It Ev $ifwireless +.Dv 1 if +.Ev $interface +is wireless, otherwise +.Dv 0 . +.It Ev $ifflags +.Ev $interface +flags. +.It Ev $ifmtu +.Ev $interface +MTU. +.It Ev $ifssid +the SSID the +.Ev interface +is connected to. +.It Ev $interface_order +A list of interfaces, in order of preference. +.It Ev $if_configured +.Dv true +if dhcpcd has configured the +.Ev interface +otherwise +.Dv false . +.It Ev $if_up +.Dv true +if the +.Ev interface +is up, otherwise +.Dv false . +This is more than IFF_UP and may not be equal. +.It Ev $if_down +.Dv true +if the +.Ev interface +is down, otherwise +.Dv false . +This is more than IFF_UP and may not be equal. +.It Ev $af_waiting +Address family waiting for, as defined in +.Xr dhcpcd.conf 5 . +.It Ev $profile +the name of the profile selected from +.Xr dhcpcd.conf 5 . +.It Ev $new_delegated_dhcp6_prefix +space-separated list of delegated prefixes. +.El +.Sh FILES +When +.Nm +runs, it loads +.Pa /etc/dhcpcd.enter-hook , +any scripts found in +.Pa /libexec/dhcpcd-hooks +in lexical order, then finally +.Pa /etc/dhcpcd.exit-hook . +.Sh SEE ALSO +.Xr dhcpcd 8 +.Sh AUTHORS +.An Roy Marples Aq Mt roy@marples.name +.Sh BUGS +Please report them to +.Lk https://roy.marples.name/projects/dhcpcd +.Sh SECURITY CONSIDERATIONS +.Nm dhcpcd +will validate the content of each option against its encoding. +For string, ascii, raw or binhex encoding it's up to the user to validate it +for the intended purpose. +.Pp +When used in a shell script, each variable must be quoted correctly. diff --git a/static/netbsd/man8/dhcpcd.8 b/static/netbsd/man8/dhcpcd.8 new file mode 100644 index 00000000..d1d47cc1 --- /dev/null +++ b/static/netbsd/man8/dhcpcd.8 @@ -0,0 +1,890 @@ +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Copyright (c) 2006-2025 Roy Marples +.\" All rights reserved +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd May 8, 2025 +.Dt DHCPCD 8 +.Os +.Sh NAME +.Nm dhcpcd +.Nd a DHCP client +.Sh SYNOPSIS +.Nm +.Op Fl 146ABbDdEGgHJKLMNPpqTV +.Op Fl C , Fl Fl nohook Ar hook +.Op Fl c , Fl Fl script Ar script +.Op Fl e , Fl Fl env Ar value +.Op Fl F , Fl Fl fqdn Ar FQDN +.Op Fl f , Fl Fl config Ar file +.Op Fl h , Fl Fl hostname Ar hostname +.Op Fl I , Fl Fl clientid Ar clientid +.Op Fl i , Fl Fl vendorclassid Ar vendorclassid +.Op Fl j , Fl Fl logfile Ar logfile +.Op Fl l , Fl Fl leasetime Ar seconds +.Op Fl m , Fl Fl metric Ar metric +.Op Fl O , Fl Fl nooption Ar option +.Op Fl o , Fl Fl option Ar option +.Op Fl Q , Fl Fl require Ar option +.Op Fl r , Fl Fl request Ar address +.Op Fl S , Fl Fl static Ar value +.Op Fl s , Fl Fl inform Ar address Ns Op Ar /cidr Ns Op Ar /broadcast_address +.Op Fl Fl inform6 +.Op Fl t , Fl Fl timeout Ar seconds +.Op Fl u , Fl Fl userclass Ar class +.Op Fl v , Fl Fl vendor Ar code , Ar value +.Op Fl W , Fl Fl whitelist Ar address Ns Op Ar /cidr +.Op Fl w +.Op Fl Fl waitip Ns = Ns Op 4 | 6 +.Op Fl y , Fl Fl reboot Ar seconds +.Op Fl X , Fl Fl blacklist Ar address Ns Op Ar /cidr +.Op Fl Z , Fl Fl denyinterfaces Ar pattern +.Op Fl z , Fl Fl allowinterfaces Ar pattern +.Op Fl Fl inactive +.Op Fl Fl configure +.Op Fl Fl noconfigure +.Op interface +.Op ... +.Nm +.Fl n , Fl Fl rebind +.Op interface +.Nm +.Fl k , Fl Fl release +.Op interface +.Nm +.Fl U , Fl Fl dumplease +.Op Ar interface +.Nm +.Fl Fl version +.Nm +.Fl x , Fl Fl exit +.Op interface +.Sh DESCRIPTION +.Nm +is an implementation of the DHCP client specified in +.Li RFC 2131 . +.Nm +gets the host information +.Po +IP address, routes, etc +.Pc +from a DHCP server and configures the network +.Ar interface +of the +machine on which it is running. +.Nm +then runs the configuration script which writes DNS information to +.Xr resolvconf 8 , +if available, otherwise directly to +.Pa /etc/resolv.conf . +If the hostname is currently blank, (null) or localhost, or +.Va force_hostname +is YES or TRUE or 1 then +.Nm +sets the hostname to the one supplied by the DHCP server. +.Nm +then daemonises and waits for the lease renewal time to lapse. +It will then attempt to renew its lease and reconfigure if the new lease +changes when the lease begins to expire or the DHCP server sends a message +to renew early. +.Pp +If any interface reports a working carrier then +.Nm +will try to obtain a lease before forking to the background, +otherwise it will fork right away. +This behaviour can be modified with the +.Fl b , Fl Fl background +and +.Fl w , Fl Fl waitip +options. +.Pp +.Nm +is also an implementation of the BOOTP client specified in +.Li RFC 951 . +.Pp +.Nm +is also an implementation of the IPv6 Router Solicitor as specified in +.Li RFC 4861 +and +.Li RFC 6106 . +.Pp +.Nm +is also an implementation of the IPv6 Privacy Extensions to AutoConf as +specified in +.Li RFC 4941 . +This feature needs to be enabled in the kernel and +.Nm +will start using it. +.Pp +.Nm +is also an implementation of the DHCPv6 client as specified in +.Li RFC 3315 . +By default, +.Nm +only starts DHCPv6 when instructed to do so by an IPV6 Router Advertisement. +If no Identity Association is configured, +then a Non-temporary Address is requested. +.Ss Local Link configuration +If +.Nm +failed to obtain a lease, it probes for a valid IPv4LL address +.Po +aka ZeroConf, aka APIPA +.Pc . +Once obtained it restarts the process of looking for a DHCP server to get a +proper address. +.Pp +When using IPv4LL, +.Nm +nearly always succeeds and returns an exit code of 0. +In the rare case it fails, it normally means that there is a reverse ARP proxy +installed which always defeats IPv4LL probing. +To disable this behaviour, you can use the +.Fl L , Fl Fl noipv4ll +option. +.Ss Multiple interfaces +If a list of interfaces are given on the command line, then +.Nm +only works with those interfaces, otherwise +.Nm +discovers available Ethernet interfaces that can be configured. +When +.Nm +is not limited to one interface on the command line, +it is running in Manager mode. +The +.Nm dhcpcd-ui +project expects dhcpcd to be running this way. +.Pp +If a single interface is given then +.Nm +only works for that interface and runs as a separate instance to other +.Nm +processes. +The +.Fl w , Fl Fl waitip +option is enabled in this instance to maintain compatibility with older +versions. +Using a single interface, +optionally further limited to an address protocol, +also affects the +.Fl k , +.Fl N , +.Fl n +and +.Fl x +options, where the same interface and any address protocol +will need to be specified, as a lack of an +interface will imply Manager mode which this is not. +To force starting in Manager mode with only one interface, the +.Fl M , Fl Fl manager +option can be used. +.Pp +Interfaces are preferred by carrier, DHCP lease/IPv4LL and then lowest metric. +For systems that support route metrics, each route will be tagged with the +metric, otherwise +.Nm +changes the routes to use the interface with the same route and the lowest +metric. +See options below for controlling which interfaces we allow and deny through +the use of patterns. +.Pp +Non-ethernet interfaces and some virtual ethernet interfaces +such as TAP and bridge are ignored by default, +as is the FireWire interface. +To work with these devices they either need to be specified on the command line, +be listed in +.Fl Fl allowinterfaces +or have an interface directive in +.Pa /etc/dhcpcd.conf . +.Ss Hooking into events +.Nm +runs +.Pa /libexec/dhcpcd-run-hooks , +or the script specified by the +.Fl c , Fl Fl script +option. +This script runs each script found in +.Pa /libexec/dhcpcd-hooks +in a lexical order. +The default installation supplies the scripts +.Pa 01-test , +.Pa 20-resolv.conf +and +.Pa 30-hostname . +You can disable each script by using the +.Fl C , Fl Fl nohook +option. +See +.Xr dhcpcd-run-hooks 8 +for details on how these scripts work. +.Nm +currently ignores the exit code of the script. +.Pp +More scripts are supplied in +.Pa /usr/share/dhcpcd/hooks +and need to be copied to +.Pa /libexec/dhcpcd-hooks +if you intend to use them. +For example, you could install +.Pa 29-lookup-hostname +so that +.Nm +can lookup the hostname of the IP address in DNS if no hostname +is given by the lease and one is not already set. +.Ss Fine tuning +You can fine-tune the behaviour of +.Nm +with the following options: +.Bl -tag -width indent +.It Fl b , Fl Fl background +Background immediately. +This is useful for startup scripts which don't disable link messages for +carrier status. +.It Fl c , Fl Fl script Ar script +Use this +.Ar script +instead of the default +.Pa /libexec/dhcpcd-run-hooks . +.It Fl D , Fl Fl duid Op Ar ll | lt | uuid | value +Use a DHCP Unique Identifier. +If persistent storage is available then a DUID-LLT +(link local address + time) is generated, +otherwise DUID-LL is generated (link local address). +The DUID type can be hinted as an optional parameter if the file +.Pa /var/db/dhcpcd/duid +does not exist. +If not +.Va ll , +.Va lt +or +.Va uuid +then +.Va value +will be converted from 00:11:22:33 format. +This, plus the IAID will be used as the +.Fl I , Fl Fl clientid . +The DUID generated will be held in +.Pa /var/db/dhcpcd/duid +and should not be copied to other hosts. +This file also takes precedence over the above rules except for setting a value. +.It Fl d , Fl Fl debug +Echo debug messages to the stderr and syslog. +.It Fl E , Fl Fl lastlease +If +.Nm +cannot obtain a lease, then try to use the last lease acquired for the +interface. +.It Fl Fl lastleaseextend +Same as the above, but the lease will be retained even if it expires. +.Nm +will give it up if any other host tries to claim it for their own via ARP. +This violates RFC 2131, section 3.7, which states the lease should be +dropped once it has expired. +.It Fl e , Fl Fl env Ar value +Push +.Ar value +to the environment for use in +.Xr dhcpcd-run-hooks 8 . +For example, you can force the hostname hook to always set the hostname with +.Fl e +.Va force_hostname=YES . +.It Fl g , Fl Fl reconfigure +.Nm +will re-apply IP address, routing and run +.Xr dhcpcd-run-hooks 8 +for each interface. +This is useful so that a 3rd party such as PPP or VPN can change the routing +table and / or DNS, etc and then instruct +.Nm +to put things back afterwards. +.Nm +does not read a new configuration when this happens - you should rebind if you +need that functionality. +.It Fl F , Fl Fl fqdn Ar fqdn +Requests that the DHCP server update DNS using FQDN instead of just a +hostname. +Valid values for +.Ar fqdn +are disable, none, ptr and both. +.Nm +itself never does any DNS updates. +.Nm +encodes the FQDN hostname as specified in +.Li RFC 1035 . +.It Fl f , Fl Fl config Ar file +Specify a config to load instead of +.Pa /etc/dhcpcd.conf . +.Nm +always processes the config file before any command line options. +.It Fl h , Fl Fl hostname Ar hostname +Sends +.Ar hostname +to the DHCP server so it can be registered in DNS. +If +.Ar hostname +is an empty string then the current system hostname is sent. +If +.Ar hostname +is a FQDN (i.e., contains a .) then it will be encoded as such. +.It Fl I , Fl Fl clientid Ar clientid +Send the +.Ar clientid . +If the string is of the format 01:02:03 then it is encoded as hex. +For interfaces whose hardware address is longer than 8 bytes, or if the +.Ar clientid +is an empty string then +.Nm +sends a default +.Ar clientid +of the hardware family and the hardware address. +.It Fl i , Fl Fl vendorclassid Ar vendorclassid +Override the DHCPv4 +.Ar vendorclassid +field sent. +The default is +dhcpcd-:::. +For example +.D1 dhcpcd-5.5.6:NetBSD-6.99.5:i386:i386 +If not set then none is sent. +Some badly configured DHCP servers reject unknown vendorclassids. +To work around it, try and impersonate Windows by using the MSFT vendorclassid. +.It Fl j , Fl Fl logfile Ar logfile +Writes to the specified +.Ar logfile . +.Nm +still writes to +.Xr syslog 3 . +The +.Ar logfile +is reopened when +.Nm +receives the +.Dv SIGUSR2 +signal. +.It Fl k , Fl Fl release Op Ar interface +This causes an existing +.Nm +process running on the +.Ar interface +to release its lease and de-configure the +.Ar interface +regardless of the +.Fl p , Fl Fl persistent +option. +If no +.Ar interface +is specified then this applies to all interfaces in Manager mode. +If no interfaces are left running, +.Nm +will exit. +.It Fl l , Fl Fl leasetime Ar seconds +Request a lease time of +.Ar seconds . +.Ar -1 +represents an infinite lease time. +By default +.Nm +does not request any lease time and leaves it in the hands of the +DHCP server. +.It Fl M , Fl Fl manager +Start +.Nm +in Manager mode even if only one interface specified on the command line. +See the Multiple Interfaces section above. +.It Fl m , Fl Fl metric Ar metric +Metrics are used to prefer an interface over another one, lowest wins. +.Nm +will supply a default metric of 1000 + +.Xr if_nametoindex 3 . +This will be offset by 2000 for wireless interfaces, with additional offsets +of 1000000 for IPv4LL and 2000000 for roaming interfaces. +.It Fl n , Fl Fl rebind Op Ar interface +Notifies +.Nm +to reload its configuration and rebind the specified +.Ar interface . +If no +.Ar interface +is specified then this applies to all interfaces in Manager mode. +If +.Nm +is not running, then it starts up as normal. +.It Fl N , Fl Fl renew Op Ar interface +Notifies +.Nm +to renew existing addresses on the specified +.Ar interface . +If no +.Ar interface +is specified then this applies to all interfaces in Manager mode. +If +.Nm +is not running, then it starts up as normal. +Unlike the +.Fl n , Fl Fl rebind +option above, the configuration for +.Nm +is not reloaded. +.It Fl o , Fl Fl option Ar option +Request the DHCP +.Ar option +variable for use in +.Pa /libexec/dhcpcd-run-hooks . +.It Fl p , Fl Fl persistent +.Nm +de-configures the +.Ar interface +when it exits unless this option is enabled. +Sometimes, this isn't desirable if, for example, you have root mounted over +NFS or SSH clients connect to this host and they need to be notified of +the host shutting down. +You can use this option to stop this from happening. +.It Fl r , Fl Fl request Ar address +Request the +.Ar address +in the DHCP DISCOVER message. +There is no guarantee this is the address the DHCP server will actually give. +If no +.Ar address +is given then the first address currently assigned to the +.Ar interface +is used. +.It Fl s , Fl Fl inform Ar address Ns Op Ar /cidr Ns Op Ar /broadcast_address +Behaves like +.Fl r , Fl Fl request +as above, but sends a DHCP INFORM instead of DISCOVER/REQUEST. +This does not get a lease as such, just notifies the DHCP server of the +.Ar address +in use. +You should also include the optional +.Ar cidr +network number in case the address is not already configured on the interface. +.Nm +remains running and pretends it has an infinite lease. +.Nm +will not de-configure the interface when it exits. +If +.Nm +fails to contact a DHCP server then it returns a failure instead of falling +back on IPv4LL. +.It Fl Fl inform6 +Performs a DHCPv6 Information Request. +No address is requested or specified, but all other DHCPv6 options are allowed. +This is normally performed automatically when the IPv6 Router Advertises +that the client should perform this operation. +This option is only needed when +.Nm +is not processing IPv6RA messages and the need for DHCPv6 Information Request +exists. +.It Fl S , Fl Fl static Ar value +Configures a static DHCP +.Ar value . +If you set +.Ic ip_address +then +.Nm +will not attempt to obtain a lease and just use the value for the address with +an infinite lease time. +.Pp +Here is an example which configures a static address, routes and DNS. +.D1 dhcpcd -S ip_address=192.168.0.10/24 \e +.D1 -S routers=192.168.0.1 \e +.D1 -S domain_name_servers=192.168.0.1 \e +.D1 eth0 +.Pp +You cannot presently set static DHCPv6 values. +Use the +.Fl e , Fl Fl env +option instead. +.It Fl t , Fl Fl timeout Ar seconds +Timeout after +.Ar seconds , +instead of the default 30. +On timeout, +.Nm +will exit if the +.Fl 1 , +.Fl Fl oneshot +option has been given, +otherwise it will fork into the background and keep on +trying. +A setting of 0 +.Ar seconds +causes +.Nm +to wait forever to get a lease. +.It Fl u , Fl Fl userclass Ar class +Tags the DHCPv4 message with the userclass +.Ar class . +DHCP servers use this to give members of the class DHCP options other than the +default, without having to know things like hardware address or hostname. +.It Fl v , Fl Fl vendor Ar code , Ns Ar value +Add an encapsulated vendor option. +.Ar code +should be between 1 and 254 inclusive. +To add a raw vendor string, omit +.Ar code +but keep the comma. +Examples. +.Pp +Set the vendor option 01 with an IP address. +.D1 dhcpcd \-v 01,192.168.0.2 eth0 +Set the vendor option 02 with a hex code. +.D1 dhcpcd \-v 02,01:02:03:04:05 eth0 +Set the vendor option 03 with an IP address as a string. +.D1 dhcpcd \-v 03,\e"192.168.0.2\e" eth0 +Set un-encapsulated vendor option to hello world. +.D1 dhcpcd \-v ,"hello world" eth0 +.It Fl Fl version +Display both program version and copyright information. +.Nm +then exits before doing any configuration. +.It Fl w +Wait for an address to be assigned before forking to the background. +Does not take an argument, unlike the below option. +.It Fl Fl waitip Ns = Ns Op 4 | 6 +Wait for an address to be assigned before forking to the background. +4 means wait for an IPv4 address to be assigned. +6 means wait for an IPv6 address to be assigned. +If no argument is given, +.Nm +will wait for any address protocol to be assigned. +It is possible to wait for more than one address protocol and +.Nm +will only fork to the background when all waiting conditions are satisfied. +.It Fl x , Fl Fl exit Op Ar interface +This will signal an existing +.Nm +process running on the +.Ar interface +to exit. +If no +.Ar interface +is specified, then the above is applied to all interfaces in Manager mode. +See the +.Fl p , Fl Fl persistent +option to control configuration persistence on exit, +which is enabled by default in +.Xr dhcpcd.conf 5 . +.Nm +then waits until this process has exited. +.It Fl y , Fl Fl reboot Ar seconds +Allow +.Ar reboot +seconds before moving to the discover phase if we have an old lease to use. +Allow +.Ar reboot +seconds before starting fallback states from the discover phase. +IPv4LL is started when the first +.Ar reboot +timeout is reached. +The default is 5 seconds. +A setting of 0 seconds causes +.Nm +to skip the reboot phase and go straight into discover. +This has no effect on DHCPv6 other than skipping the reboot phase. +.El +.Ss Restricting behaviour +.Nm +will try to do as much as it can by default. +However, there are sometimes situations where you don't want the things to be +configured exactly how the DHCP server wants. +Here are some options that deal with turning these bits off. +.Pp +Note that when +.Nm +is restricted to a single interface then the interface also needs to be +specified when asking +.Nm +to exit using the commandline. +If the protocol is restricted as well then the protocol needs to be included +with the exit instruction. +.Bl -tag -width indent +.It Fl 1 , Fl Fl oneshot +Exit after configuring an interface. +Use the +.Fl w , Fl Fl waitip +option to specify which protocol(s) to configure before exiting. +.It Fl 4 , Fl Fl ipv4only +Configure IPv4 only. +.It Fl 6 , Fl Fl ipv6only +Configure IPv6 only. +.It Fl A , Fl Fl noarp +Don't request or claim the address by ARP. +This also disables IPv4LL. +.It Fl B , Fl Fl nobackground +Don't run in the background when we acquire a lease. +This is mainly useful for running under the control of another process, such +as a debugger or a network manager. +.It Fl C , Fl Fl nohook Ar script +Don't run this hook script. +Matches full name, or prefixed with 2 numbers optionally ending with +.Pa .sh . +.Pp +So to stop +.Nm +from touching your DNS settings you would do:- +.D1 dhcpcd -C resolv.conf eth0 +.It Fl G , Fl Fl nogateway +Don't set any default routes. +.It Fl H , Fl Fl xidhwaddr +Use the last four bytes of the hardware address as the DHCP xid instead +of a randomly generated number. +.It Fl J , Fl Fl broadcast +Instructs the DHCP server to broadcast replies back to the client. +Normally this is only set for non-Ethernet interfaces, +such as FireWire and InfiniBand. +In most instances, +.Nm +will set this automatically. +.It Fl K , Fl Fl nolink +Don't receive link messages for carrier status. +You should only have to use this with buggy device drivers or running +.Nm +through a network manager. +.It Fl L , Fl Fl noipv4ll +Don't use IPv4LL (aka APIPA, aka Bonjour, aka ZeroConf). +.It Fl O , Fl Fl nooption Ar option +Removes the +.Ar option +from the DHCP message before processing. +.It Fl P , Fl Fl printpidfile +Print the +.Pa pidfile +.Nm +will use based on command-line arguments to stdout. +.It Fl Q , Fl Fl require Ar option +Requires the +.Ar option +to be present in all DHCP messages, otherwise the message is ignored. +To enforce that +.Nm +only responds to DHCP servers and not BOOTP servers, you can +.Fl Q +.Ar dhcp_message_type . +.It Fl q , Fl Fl quiet +Quiet +.Nm +on the command line, only warnings and errors will be displayed. +If this option is used another time then all console output is disabled. +These messages are still logged via +.Xr syslog 3 . +.It Fl T , Fl Fl test +On receipt of DHCP messages just call +.Pa /libexec/dhcpcd-run-hooks +with the reason of TEST which echos the DHCP variables found in the message +to the console. +The interface configuration isn't touched and neither are any configuration +files. +The +.Ar rapid_commit +option is not sent in TEST mode so that the server does not lease an address. +To test INFORM the interface needs to be configured with the desired address +before starting +.Nm . +.It Fl U , Fl Fl dumplease Op Ar interface +Dumps the current lease for the +.Ar interface +to stdout. +If no +.Ar interface +is given then all interfaces are dumped. +Use the +.Fl 4 +or +.Fl 6 +flags to specify an address family. +If a lease is piped in via standard input then use the special interface named +.Ar - +to dump it. +In this case, specifying an address family is mandatory. +.It Fl V , Fl Fl variables +Display a list of option codes, the associated variable and encoding for use in +.Xr dhcpcd-run-hooks 8 . +Variables are prefixed with new_ and old_ unless the option number is -. +Variables without an option are part of the DHCP message and cannot be +directly requested. +.It Fl W , Fl Fl whitelist Ar address Ns Op /cidr +Only accept packets from +.Ar address Ns Op /cidr . +.Fl X , Fl Fl blacklist +is ignored if +.Fl W , Fl Fl whitelist +is set. +.It Fl X , Fl Fl blacklist Ar address Ns Op Ar /cidr +Ignore all packets from +.Ar address Ns Op Ar /cidr . +.It Fl Z , Fl Fl denyinterfaces Ar pattern +When discovering interfaces, the interface name must not match +.Ar pattern +which is a space or comma separated list of patterns passed to +.Xr fnmatch 3 . +.It Fl z , Fl Fl allowinterfaces Ar pattern +When discovering interfaces, the interface name must match +.Ar pattern +which is a space or comma separated list of patterns passed to +.Xr fnmatch 3 . +If the same interface is matched in +.Fl Z , Fl Fl denyinterfaces +then it is still denied. +.It Fl Fl inactive +Don't start any interfaces other than those specified on the command line. +This allows +.Nm +to be started in Manager mode and then wait for subsequent +.Nm +commands to start each interface as required. +.It Fl Fl configure +Allows +.Nm +to configure the system. +This is the default behaviour and sets +.Ev if_configured=true . +.It Fl Fl noconfigure +.Nm +will not configure the system at all. +This is only of use if the +.Fl Fl script +that +.Nm +calls at each network event configures the system instead. +This is different from +.Fl T , Fl Fl test +mode in that it's not one shot and the only change to the environment is the +addition of +.Ev if_configured=false . +.It Fl Fl nodev +Don't load any +.Pa /dev +management modules. +.El +.Sh 3RDPARTY LINK MANAGEMENT +Some interfaces require configuration by 3rd parties, such as PPP or VPN. +When an interface configuration in +.Nm +is marked as STATIC or INFORM without an address then +.Nm +will monitor the interface until an address is added or removed from it and +act accordingly. +For point to point interfaces (like PPP), a default route to its +destination is automatically added to the configuration. +If the point to point interface is configured for INFORM, then +.Nm +unicasts INFORM to the destination, otherwise it defaults to STATIC. +.Sh NOTES +.Nm +requires a Berkeley Packet Filter, or BPF device on BSD based systems and a +Linux Socket Filter, or LPF device on Linux based systems for all IPv4 +configuration. +.Pp +If restricting +.Nm +to a single interface and optionally address family via the command-line +then all further calls to +.Nm +to rebind, reconfigure or exit need to include the same restrictive flags +so that +.Nm +knows which process to signal. +.Pp +Some DHCP servers implement ClientID filtering. +If +.Nm +is replacing an in-use DHCP client then you might need to adjust the clientid +option +.Nm +sends to match. +If using a DUID in place of the ClientID, edit +.Pa /var/db/dhcpcd/duid +accordingly. +.Sh FILES +.Bl -ohang +.It Pa /etc/dhcpcd.conf +Configuration file for dhcpcd. +If you always use the same options, put them here. +.It Pa /libexec/dhcpcd-run-hooks +Bourne shell script that is run to configure or de-configure an interface. +.It Pa /lib/dhcpcd/dev +Linux +.Pa /dev +management modules. +.It Pa /libexec/dhcpcd-hooks +A directory containing Bourne shell scripts that are run by the above script. +Each script can be disabled by using the +.Fl C , Fl Fl nohook +option described above. +.It Pa /var/db/dhcpcd/duid +Text file that holds the DUID used to identify the host. +.It Pa /var/db/dhcpcd/secret +Text file that holds a secret key known only to the host. +.It Pa /var/db/dhcpcd/ Ns Ar interface Ns Ar -ssid Ns .lease +The actual DHCP message sent by the server. +We use this when reading the last +lease and use the file's mtime as when it was issued. +.It Pa /var/db/dhcpcd/ Ns Ar interface Ns Ar -ssid Ns .lease6 +The actual DHCPv6 message sent by the server. +We use this when reading the last +lease and use the file's mtime as when it was issued. +.It Pa /var/db/dhcpcd/rdm_monotonic +Stores the monotonic counter used in the +.Ar replay +field in Authentication Options. +.It Pa /var/run/dhcpcd/pid +Stores the PID of +.Nm +running on all interfaces. +.It Pa /var/run/dhcpcd/ Ns Ar interface Ns .pid +Stores the PID of +.Nm +running on the +.Ar interface . +.It Pa /var/run/dhcpcd/sock +Control socket to the manager daemon. +.It Pa /var/run/dhcpcd/unpriv.sock +Unprivileged socket to the manager daemon, only allows state retrieval. +.It Pa /var/run/dhcpcd/ Ns Ar interface Ns .sock +Control socket to per interface daemon. +.It Pa /var/run/dhcpcd/ Ns Ar interface Ns .unpriv.sock +Unprivileged socket to per interface daemon, only allows state retrieval. +.El +.Sh SEE ALSO +.Xr fnmatch 3 , +.Xr if_nametoindex 3 , +.Xr dhcpcd.conf 5 , +.Xr resolv.conf 5 , +.Xr dhcpcd-run-hooks 8 , +.Xr resolvconf 8 +.Sh STANDARDS +RFC\ 951, RFC\ 1534, RFC\ 2104, RFC\ 2131, RFC\ 2132, RFC\ 2563, RFC\ 2855, +RFC\ 3004, RFC\ 3118, RFC\ 3203, RFC\ 3315, RFC\ 3361, RFC\ 3633, RFC\ 3396, +RFC\ 3397, RFC\ 3442, RFC\ 3495, RFC\ 3925, RFC\ 3927, RFC\ 4039, RFC\ 4075, +RFC\ 4242, RFC\ 4361, RFC\ 4390, RFC\ 4702, RFC\ 4074, RFC\ 4861, RFC\ 4833, +RFC\ 4941, RFC\ 5227, RFC\ 5942, RFC\ 5969, RFC\ 6106, RFC\ 6334, RFC\ 6355, +RFC\ 6603, RFC\ 6704, RFC\ 7217, RFC\ 7550, RFC\ 7844. +.Sh AUTHORS +.An Roy Marples Aq Mt roy@marples.name +.Sh BUGS +Please report them to +.Lk https://roy.marples.name/projects/dhcpcd diff --git a/static/netbsd/man8/dhcpd.8 b/static/netbsd/man8/dhcpd.8 new file mode 100644 index 00000000..688f7ca1 --- /dev/null +++ b/static/netbsd/man8/dhcpd.8 @@ -0,0 +1,891 @@ +.\" $NetBSD: dhcpd.8,v 1.3 2022/04/03 01:10:59 christos Exp $ +.\" +.\" dhcpd.8 +.\" +.\" Copyright (C) 2004-2022 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (c) 1996-2003 by Internet Software Consortium +.\" +.\" This Source Code Form is subject to the terms of the Mozilla Public +.\" License, v. 2.0. If a copy of the MPL was not distributed with this +.\" file, You can obtain one at http://mozilla.org/MPL/2.0/. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +.\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" Internet Systems Consortium, Inc. +.\" PO Box 360 +.\" Newmarket, NH 03857 USA +.\" +.\" https://www.isc.org/ +.\" +.\" This software has been written for Internet Systems Consortium +.\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc. +.\" +.\" Support and other services are available for ISC products - see +.\" https://www.isc.org for more information or to learn more about ISC. +.\" +.\" Id: dhcpd.8,v 1.35 2011/05/20 13:48:33 tomasz Exp +.\" +.TH dhcpd 8 +.SH NAME +dhcpd - Dynamic Host Configuration Protocol Server +.SH SYNOPSIS +.B dhcpd +[ +.B -p +.I port +] +[ +.B -f +] +[ +.B -d +] +[ +.B -q +] +[ +.B -t +| +.B -T +] +[ +.B -4 +| +.B -6 +] +[ +.B -4o6 +.I port +] +[ +.B -s +.I server +] +[ +.B -cf +.I config-file +] +[ +.B -lf +.I lease-file +] +[ +.B -pf +.I pid-file +] +[ +.B --no-pid +] +[ +.B -user +.I user +] +[ +.B -group +.I group +] +[ +.B -chroot +.I dir +] +[ +.B -tf +.I trace-output-file +] +[ +.B -play +.I trace-playback-file +] +[ +.I if0 +[ +.I ...ifN +] +] + +.B dhcpd +--version +.SH DESCRIPTION +The Internet Systems Consortium DHCP Server, dhcpd, implements the +Dynamic Host Configuration Protocol (DHCP) and the Internet Bootstrap +Protocol (BOOTP). DHCP allows hosts on a TCP/IP network to request +and be assigned IP addresses, and also to discover information about +the network to which they are attached. BOOTP provides similar +functionality, with certain restrictions. +.SH OPERATION +.PP +The DHCP protocol allows a host which is unknown to the network +administrator to be automatically assigned a new IP address out of a +pool of IP addresses for its network. In order for this to work, the +network administrator allocates address pools in each subnet and +enters them into the dhcpd.conf(5) file. +.PP +There are two versions of the DHCP protocol DHCPv4 and DHCPv6. At +startup the server may be started for one or the other via the +.B -4 +or +.B -6 +arguments. +.PP +On startup, dhcpd reads the +.IR dhcpd.conf +file and stores a list of available addresses on each subnet in +memory. When a client requests an address using the DHCP protocol, +dhcpd allocates an address for it. Each client is assigned a lease, +which expires after an amount of time chosen by the administrator (by +default, one day). Before leases expire, the clients to which leases +are assigned are expected to renew them in order to continue to use +the addresses. Once a lease has expired, the client to which that +lease was assigned is no longer permitted to use the leased IP +address. +.PP +In order to keep track of leases across system reboots and server +restarts, dhcpd keeps a list of leases it has assigned in the +dhcpd.leases(5) file. Before dhcpd grants a lease to a host, it +records the lease in this file and makes sure that the contents of the +file are flushed to disk. This ensures that even in the event of a +system crash, dhcpd will not forget about a lease that it has +assigned. On startup, after reading the dhcpd.conf file, dhcpd +reads the dhcpd.leases file to refresh its memory about what leases +have been assigned. +.PP +New leases are appended to the end of the dhcpd.leases +file. In order to prevent the file from becoming arbitrarily large, +from time to time dhcpd creates a new dhcpd.leases file from its +in-core lease database. Once this file has been written to disk, the +old file is renamed +.IR dhcpd.leases~ , +and the new file is renamed dhcpd.leases. If the system crashes in +the middle of this process, whichever dhcpd.leases file remains will +contain all the lease information, so there is no need for a special +crash recovery process. +.PP +BOOTP support is also provided by this server. Unlike DHCP, the BOOTP +protocol does not provide a protocol for recovering +dynamically-assigned addresses once they are no longer needed. It is +still possible to dynamically assign addresses to BOOTP clients, but +some administrative process for reclaiming addresses is required. By +default, leases are granted to BOOTP clients in perpetuity, although +the network administrator may set an earlier cutoff date or a shorter +lease length for BOOTP leases if that makes sense. +.PP +BOOTP clients may also be served in the old standard way, which is to +simply provide a declaration in the dhcpd.conf file for each +BOOTP client, permanently assigning an address to each client. +.PP +Whenever changes are made to the dhcpd.conf file, dhcpd must be +restarted. To restart dhcpd, send a SIGTERM (signal 15) to the +process ID contained in +.IR RUNDIR/dhcpd.pid , +and then re-invoke dhcpd. Because the DHCP server database is not as +lightweight as a BOOTP database, dhcpd does not automatically restart +itself when it sees a change to the dhcpd.conf file. +.PP +Note: We get a lot of complaints about this. We realize that it would +be nice if one could send a SIGHUP to the server and have it reload +the database. This is not technically impossible, but it would +require a great deal of work, our resources are extremely limited, and +they can be better spent elsewhere. So please don't complain about +this on the mailing list unless you're prepared to fund a project to +implement this feature, or prepared to do it yourself. +.SH COMMAND LINE +.PP +The names of the network interfaces on which dhcpd should listen for +broadcasts may be specified on the command line. This should be done +on systems where dhcpd is unable to identify non-broadcast interfaces, +but should not be required on other systems. If no interface names +are specified on the command line dhcpd will identify all network +interfaces which are up, eliminating non-broadcast interfaces if +possible, and listen for DHCP broadcasts on each interface. +.PP +.SH COMMAND LINE OPTIONS +.TP +.BI \-4 +Run as a DHCP server. This is the default and cannot be combined with +\fB\-6\fR. +.TP +.BI \-6 +Run as a DHCPv6 server. This cannot be combined with \fB\-4\fR. +.TP +.BI \-4o6 \ port +Participate in the DHCPv4 over DHCPv6 protocol specified by RFC 7341. +This associates a DHCPv4 and a DHCPv6 server to allow the v4 server to +receive v4 requests that were encapsulated in a v6 packet. Communication +between the two servers is done on a pair of UDP sockets bound +to ::1 \fIport\fR and \fIport + 1\fR. Both servers must +be launched using the same \fIport\fR argument. +.TP +.BI \-p \ port +The UDP port number on which +.B dhcpd +should listen. If unspecified +.B dhcpd +uses the default port of 67. This is mostly useful for debugging +purposes. +.TP +.BI \-s \ address +Specify an address or host name to which +.B dhcpd +should send replies rather than the broadcast address (255.255.255.255). +This option is only supported in IPv4. +.TP +.BI \-f +Force +.B dhcpd +to run as a foreground process instead of as a daemon in the background. +This is useful when running +.B dhcpd +under a debugger, or when running it +out of inittab on System V systems. +.TP +.BI \-d +Send log messages to the standard error descriptor. +This can be useful for debugging, and also at sites where a +complete log of all dhcp activity must be kept but syslogd is not +reliable or otherwise cannot be used. Normally, +.B dhcpd +will log all +output using the \fBsyslog(3)\fR function with the log facility set to +LOG_DAEMON. Note that \fB\-d\fR implies \fB\-f\fR (the daemon will +not fork itself into the background). +.TP +.BI \-q +Be quiet at startup. This suppresses the printing of the entire +copyright message during startup. This might be desirable when +starting +.B dhcpd +from a system startup script (e.g., /etc/rc). +.TP +.BI \-t +Test the configuration file. The server tests the configuration file +for correct syntax, but will not attempt to perform any network +operations. This can be used to test a new configuration file +automatically before installing it. +.TP +.BI \-T +Test the lease file. The server tests the lease file +for correct syntax, but will not attempt to perform any network +operations. In addition to reading the lease file it will also +write the leases to a temporary lease file. The current lease +file will not be modified and the temporary lease file will be +removed upon completion of the test. This can be used to test a +new lease file automatically before installing it. +.TP +.BI \-user \ user +Setuid to user after completing privileged operations, +such as creating sockets that listen on privileged ports. +This also causes the lease file to be owned by user. +This option is only available if the code was compiled +with the PARANOIA patch (./configure --enable-paranoia). +.TP +.BI \-group \ group +Setgid to group after completing privileged operations, +such as creating sockets that listen on privileged ports. +This also causes the lease file to use group. +This option is only available if the code was compiled +with the PARANOIA patch (./configure --enable-paranoia). +.TP +.BI \-chroot \ dir +Chroot to directory. This may occur before or after +reading the configuration files depending on whether +the code was compiled with the EARLY_CHROOT option +enabled (./configure --enable-early-chroot). +This option is only available if the code was compiled +with the PARANOIA patch (./configure --enable-paranoia). +.TP +.BI \-tf \ tracefile +Specify a file into which the entire startup state of the server and +all the transactions it processes are logged. This can be +useful in submitting bug reports - if you are getting a core dump +every so often, you can start the server with the \fB-tf\fR option and +then, when the server dumps core, the trace file will contain all the +transactions that led up to it dumping core, so that the problem can +be easily debugged with \fB-play\fR. +.TP +.BI \-play \ playfile +Specify a file from which the entire startup state of the server and +all the transactions it processed are read. The \fB-play\fR option +must be specified with an alternate lease file, +using the \fB-lf\fR switch, so that the DHCP server doesn't wipe out +your existing lease file with its test data. The DHCP server will +refuse to operate in playback mode unless you specify an alternate +lease file. +.TP +.BI --version +Print version number and exit. +.PP +.I Modifying default file locations: +The following options can be used to modify the locations +.B dhcpd +uses for its files. Because of the importance of using the same +lease database at all times when running dhcpd in production, these +options should be used \fBonly\fR for testing lease files or database +files in a non-production environment. +.TP +.BI \-cf \ config-file +Path to alternate configuration file. +.TP +.BI \-lf \ lease-file +Path to alternate lease file. +.TP +.BI \-pf \ pid-file +Path to alternate pid file. +.TP +.BI \--no-pid +Option to disable writing pid files. By default the program +will write a pid file. If the program is invoked with this +option it will not check for an existing server process. +.PP +.SH PORTS +During operations the server may use multiple UDP and TCP ports +to provide different functions. Which ports are opened depends +on both the way you compiled your code and the configuration you +supply. The following should provide you an idea of what +ports may be in use. + +Normally a DHCPv4 server will open a raw UDP socket to receive +and send most DHCPv4 packets. It also opens a fallback UDP socket +for use in sending unicast packets. Normally these will both +use the well known port number for BOOTPS. + +For each DHCPv4 failover peer you list in the configuration file +there will be a TCP socket listening for connections on the +ports specified in the configuration file. When the peer connects +there will be another socket for the established connection. +For the established connection the side (primary or secondary) +opening the connection will use a random port. + +For DHCPv6 the server opens a UDP socket on the well known +dhcpv6-server port. + +The server opens an icmp socket for doing ping requests to check +if addresses are in use. + +If you have included an omapi-port statement in your configuration +file then the server will open a TCP socket on that port to +listen for OMPAI connections. When something connects another +port will be used for the established connection. + +When DDNS is enabled at compile time (see includes/site.h) +the server will open both a v4 and a v6 UDP socket on +random ports, unless DDNS updates are globally disabled by +setting ddns-update-style to none in the configuration file. +.PP +.SH CONFIGURATION +The syntax of the dhcpd.conf(5) file is discussed separately. This +section should be used as an overview of the configuration process, +and the dhcpd.conf(5) documentation should be consulted for detailed +reference information. +.PP +.SH Subnets +dhcpd needs to know the subnet numbers and netmasks of all subnets for +which it will be providing service. In addition, in order to +dynamically allocate addresses, it must be assigned one or more ranges +of addresses on each subnet which it can in turn assign to client +hosts as they boot. Thus, a very simple configuration providing DHCP +support might look like this: +.nf +.sp 1 + subnet 239.252.197.0 netmask 255.255.255.0 { + range 239.252.197.10 239.252.197.250; + } +.fi +.PP +Multiple address ranges may be specified like this: +.nf +.sp 1 + subnet 239.252.197.0 netmask 255.255.255.0 { + range 239.252.197.10 239.252.197.107; + range 239.252.197.113 239.252.197.250; + } +.fi +.PP +If a subnet will only be provided with BOOTP service and no dynamic +address assignment, the range clause can be left out entirely, but the +subnet statement must appear. +.PP +.SH Lease Lengths +DHCP leases can be assigned almost any length from zero seconds to +infinity. What lease length makes sense for any given subnet, or for +any given installation, will vary depending on the kinds of hosts +being served. +.PP +For example, in an office environment where systems are added from +time to time and removed from time to time, but move relatively +infrequently, it might make sense to allow lease times of a month or +more. In a final test environment on a manufacturing floor, it may +make more sense to assign a maximum lease length of 30 minutes - +enough time to go through a simple test procedure on a network +appliance before packaging it up for delivery. +.PP +It is possible to specify two lease lengths: the default length that +will be assigned if a client doesn't ask for any particular lease +length, and a maximum lease length. These are specified as clauses +to the subnet command: +.nf +.sp 1 + subnet 239.252.197.0 netmask 255.255.255.0 { + range 239.252.197.10 239.252.197.107; + default-lease-time 600; + max-lease-time 7200; + } +.fi +.PP +This particular subnet declaration specifies a default lease time of +600 seconds (ten minutes), and a maximum lease time of 7200 seconds +(two hours). Other common values would be 86400 (one day), 604800 +(one week) and 2592000 (30 days). +.PP +Each subnet need not have the same lease\(emin the case of an office +environment and a manufacturing environment served by the same DHCP +server, it might make sense to have widely disparate values for +default and maximum lease times on each subnet. +.SH BOOTP Support +Each BOOTP client must be explicitly declared in the dhcpd.conf +file. A very basic client declaration will specify the client +network interface's hardware address and the IP address to assign to +that client. If the client needs to be able to load a boot file from +the server, that file's name must be specified. A simple bootp +client declaration might look like this: +.nf +.sp 1 + host haagen { + hardware ethernet 08:00:2b:4c:59:23; + fixed-address 239.252.197.9; + filename "/tftpboot/haagen.boot"; + } +.fi +.SH Options +DHCP (and also BOOTP with Vendor Extensions) provide a mechanism +whereby the server can provide the client with information about how +to configure its network interface (e.g., subnet mask), and also how +the client can access various network services (e.g., DNS, IP routers, +and so on). +.PP +These options can be specified on a per-subnet basis, and, for BOOTP +clients, also on a per-client basis. In the event that a BOOTP +client declaration specifies options that are also specified in its +subnet declaration, the options specified in the client declaration +take precedence. A reasonably complete DHCP configuration might +look something like this: +.nf +.sp 1 + subnet 239.252.197.0 netmask 255.255.255.0 { + range 239.252.197.10 239.252.197.250; + default-lease-time 600; + max-lease-time 7200; + option subnet-mask 255.255.255.0; + option broadcast-address 239.252.197.255; + option routers 239.252.197.1; + option domain-name-servers 239.252.197.2, 239.252.197.3; + option domain-name "isc.org"; + } +.fi +.PP +A bootp host on that subnet that needs to be in a different domain and +use a different name server might be declared as follows: +.nf +.sp 1 + host haagen { + hardware ethernet 08:00:2b:4c:59:23; + fixed-address 239.252.197.9; + filename "/tftpboot/haagen.boot"; + option domain-name-servers 192.5.5.1; + option domain-name "example.com"; + } +.fi +.PP +A more complete description of the dhcpd.conf file syntax is provided +in dhcpd.conf(5). +.SH OMAPI +The DHCP server provides the capability to modify some of its +configuration while it is running, without stopping it, modifying its +database files, and restarting it. This capability is currently +provided using OMAPI - an API for manipulating remote objects. OMAPI +clients connect to the server using TCP/IP, authenticate, and can then +examine the server's current status and make changes to it. +.PP +Rather than implementing the underlying OMAPI protocol directly, user +programs should use the dhcpctl API or OMAPI itself. Dhcpctl is a +wrapper that handles some of the housekeeping chores that OMAPI does +not do automatically. Dhcpctl and OMAPI are documented in \fBdhcpctl(3)\fR +and \fBomapi(3)\fR. +.PP +OMAPI exports objects, which can then be examined and modified. The +DHCP server exports the following objects: lease, host, +failover-state and group. Each object has a number of methods that +are provided: lookup, create, and destroy. In addition, it is +possible to look at attributes that are stored on objects, and in some +cases to modify those attributes. +.SH THE LEASE OBJECT +Leases can't currently be created or destroyed, but they can be looked +up to examine and modify their state. +.PP +Leases have the following attributes: +.PP +.B state \fIinteger\fR lookup, examine +.RS 0.5i +.nf +1 = free +2 = active +3 = expired +4 = released +5 = abandoned +6 = reset +7 = backup +8 = reserved +9 = bootp +.fi +.RE +.PP +.B ip-address \fIdata\fR lookup, examine +.RS 0.5i +The IP address of the lease. +.RE +.PP +.B dhcp-client-identifier \fIdata\fR lookup, examine, update +.RS 0.5i +The +client identifier that the client used when it acquired the lease. +Not all clients send client identifiers, so this may be empty. +.RE +.PP +.B client-hostname \fIdata\fR examine, update +.RS 0.5i +The value the client sent in the host-name option. +.RE +.PP +.B host \fIhandle\fR examine +.RS 0.5i +the host declaration associated with this lease, if any. +.RE +.PP +.B subnet \fIhandle\fR examine +.RS 0.5i +the subnet object associated with this lease (the subnet object is not +currently supported). +.RE +.PP +.B pool \fIhandle\fR examine +.RS 0.5i +the pool object associated with this lease (the pool object is not +currently supported). +.RE +.PP +.B billing-class \fIhandle\fR examine +.RS 0.5i +the handle to the class to which this lease is currently billed, if +any (the class object is not currently supported). +.RE +.PP +.B hardware-address \fIdata\fR examine, update +.RS 0.5i +the hardware address (chaddr) field sent by the client when it +acquired its lease. +.RE +.PP +.B hardware-type \fIinteger\fR examine, update +.RS 0.5i +the type of the network interface that the client reported when it +acquired its lease. +.RE +.PP +.B ends \fItime\fR examine +.RS 0.5i +the time when the lease's current state ends, as understood by the +client. +.RE +.PP +.B tstp \fItime\fR examine +.RS 0.5i +the time when the lease's current state ends, as understood by the +server. +.RE +.B tsfp \fItime\fR examine +.RS 0.5i +the adjusted time when the lease's current state ends, as understood by +the failover peer (if there is no failover peer, this value is +undefined). Generally this value is only adjusted for expired, released, +or reset leases while the server is operating in partner-down state, and +otherwise is simply the value supplied by the peer. +.RE +.B atsfp \fItime\fR examine +.RS 0.5i +the actual tsfp value sent from the peer. This value is forgotten when a +lease binding state change is made, to facilitate retransmission logic. +.RE +.PP +.B cltt \fItime\fR examine +.RS 0.5i +The time of the last transaction with the client on this lease. +.RE +.SH THE HOST OBJECT +Hosts can be created, destroyed, looked up, examined and modified. +If a host declaration is created or deleted using OMAPI, that +information will be recorded in the dhcpd.leases file. It is +permissible to delete host declarations that are declared in the +dhcpd.conf file. +.PP +Hosts have the following attributes: +.PP +.B name \fIdata\fR lookup, examine, modify +.RS 0.5i +the name of the host declaration. This name must be unique among all +host declarations. +.RE +.PP +.B group \fIhandle\fR examine, modify +.RS 0.5i +the named group associated with the host declaration, if there is one. +.RE +.PP +.B hardware-address \fIdata\fR lookup, examine, modify +.RS 0.5i +the link-layer address that will be used to match the client, if any. +Only valid if hardware-type is also present. +.RE +.PP +.B hardware-type \fIinteger\fR lookup, examine, modify +.RS 0.5i +the type of the network interface that will be used to match the +client, if any. Only valid if hardware-address is also present. +.RE +.PP +.B dhcp-client-identifier \fIdata\fR lookup, examine, modify +.RS 0.5i +the dhcp-client-identifier option that will be used to match the +client, if any. +.RE +.PP +.B ip-address \fIdata\fR examine, modify +.RS 0.5i +a fixed IP address which is reserved for a DHCP client that matches +this host declaration. The IP address will only be assigned to the +client if it is valid for the network segment to which the client is +connected. +.RE +.PP +.B statements \fIdata\fR modify +.RS 0.5i +a list of statements in the format of the dhcpd.conf file that will be +executed whenever a message from the client is being processed. +.RE +.PP +.B known \fIinteger\fR examine, modify +.RS 0.5i +if nonzero, indicates that a client matching this host declaration +will be treated as \fIknown\fR in pool permit lists. If zero, the +client will not be treated as known. +.RE +.SH THE GROUP OBJECT +Named groups can be created, destroyed, looked up, examined and +modified. If a group declaration is created or deleted using OMAPI, +that information will be recorded in the dhcpd.leases file. It is +permissible to delete group declarations that are declared in the +dhcpd.conf file. +.PP +Named groups currently can only be associated with +hosts - this allows one set of statements to be efficiently attached +to more than one host declaration. +.PP +Groups have the following attributes: +.PP +.B name \fIdata\fR +.RS 0.5i +the name of the group. All groups that are created using OMAPI must +have names, and the names must be unique among all groups. +.RE +.PP +.B statements \fIdata\fR +.RS 0.5i +a list of statements in the format of the dhcpd.conf file that will be +executed whenever a message from a client whose host declaration +references this group is processed. +.RE +.SH THE CONTROL OBJECT +The control object allows you to shut the server down. If the server +is doing failover with another peer, it will make a clean transition +into the shutdown state and notify its peer, so that the peer can go +into partner down, and then record the "recover" state in the lease +file so that when the server is restarted, it will automatically +resynchronize with its peer. +.PP +On shutdown the server will also attempt to cleanly shut down all +OMAPI connections. If these connections do not go down cleanly after +five seconds, they are shut down preemptively. It can take as much +as 25 seconds from the beginning of the shutdown process to the time +that the server actually exits. +.PP +To shut the server down, open its control object and set the state +attribute to 2. +.SH THE FAILOVER-STATE OBJECT +The failover-state object is the object that tracks the state of the +failover protocol as it is being managed for a given failover peer. +The failover object has the following attributes (please see +.B dhcpd.conf (5) +for explanations about what these attributes mean): +.PP +.B name \fIdata\fR examine +.RS 0.5i +Indicates the name of the failover peer relationship, as described in +the server's \fBdhcpd.conf\fR file. +.RE +.PP +.B partner-address \fIdata\fR examine +.RS 0.5i +Indicates the failover partner's IP address. +.RE +.PP +.B local-address \fIdata\fR examine +.RS 0.5i +Indicates the IP address that is being used by the DHCP server for +this failover pair. +.RE +.PP +.B partner-port \fIdata\fR examine +.RS 0.5i +Indicates the TCP port on which the failover partner is listening for +failover protocol connections. +.RE +.PP +.B local-port \fIdata\fR examine +.RS 0.5i +Indicates the TCP port on which the DHCP server is listening for +failover protocol connections for this failover pair. +.RE +.PP +.B max-outstanding-updates \fIinteger\fR examine +.RS 0.5i +Indicates the number of updates that can be outstanding and +unacknowledged at any given time, in this failover relationship. +.RE +.PP +.B mclt \fIinteger\fR examine +.RS 0.5i +Indicates the maximum client lead time in this failover relationship. +.RE +.PP +.B load-balance-max-secs \fIinteger\fR examine +.RS 0.5i +Indicates the maximum value for the secs field in a client request +before load balancing is bypassed. +.RE +.PP +.B load-balance-hba \fIdata\fR examine +.RS 0.5i +Indicates the load balancing hash bucket array for this failover +relationship. +.RE +.PP +.B local-state \fIinteger\fR examine, modify +.RS 0.5i +Indicates the present state of the DHCP server in this failover +relationship. Possible values for state are: +.RE +.RS 1i +.PP +.nf +1 - startup +2 - normal +3 - communications interrupted +4 - partner down +5 - potential conflict +6 - recover +7 - paused +8 - shutdown +9 - recover done +10 - resolution interrupted +11 - conflict done +254 - recover wait +.fi +.RE +.PP +.RS 0.5i +(Note that some of the above values have changed since DHCP 3.0.x.) +.RE +.PP +.RS 0.5i +In general it is not a good idea to make changes to this state. +However, in the case that the failover partner is known to be down, it +can be useful to set the DHCP server's failover state to partner +down. At this point the DHCP server will take over service of the +failover partner's leases as soon as possible, and will give out +normal leases, not leases that are restricted by MCLT. If you do put +the DHCP server into the partner-down when the other DHCP server is +not in the partner-down state, but is not reachable, IP address +assignment conflicts are possible, even likely. Once a server has +been put into partner-down mode, its failover partner must not be +brought back online until communication is possible between the two +servers. +.RE +.PP +.B partner-state \fIinteger\fR examine +.RS 0.5i +Indicates the present state of the failover partner. +.RE +.PP +.B local-stos \fIinteger\fR examine +.RS 0.5i +Indicates the time at which the DHCP server entered its present state +in this failover relationship. +.RE +.PP +.B partner-stos \fIinteger\fR examine +.RS 0.5i +Indicates the time at which the failover partner entered its present state. +.RE +.PP +.B hierarchy \fIinteger\fR examine +.RS 0.5i +Indicates whether the DHCP server is primary (0) or secondary (1) in +this failover relationship. +.RE +.PP +.B last-packet-sent \fIinteger\fR examine +.RS 0.5i +Indicates the time at which the most recent failover packet was sent +by this DHCP server to its failover partner. +.RE +.PP +.B last-timestamp-received \fIinteger\fR examine +.RS 0.5i +Indicates the timestamp that was on the failover message most recently +received from the failover partner. +.RE +.PP +.B skew \fIinteger\fR examine +.RS 0.5i +Indicates the skew between the failover partner's clock and this DHCP +server's clock +.RE +.PP +.B max-response-delay \fIinteger\fR examine +.RS 0.5i +Indicates the time in seconds after which, if no message is received +from the failover partner, the partner is assumed to be out of +communication. +.RE +.PP +.B cur-unacked-updates \fIinteger\fR examine +.RS 0.5i +Indicates the number of update messages that have been received from +the failover partner but not yet processed. +.RE +.SH FILES +.B ETCDIR/dhcpd.conf, DBDIR/dhcpd.leases, RUNDIR/dhcpd.pid, +.B DBDIR/dhcpd.leases~. +.SH SEE ALSO +dhclient(8), dhcrelay(8), dhcpd.conf(5), dhcpd.leases(5) +.SH AUTHOR +.B dhcpd(8) +was originally written by Ted Lemon under a contract with Vixie Labs. +Funding for this project was provided by Internet Systems +Consortium. Version 3 of the DHCP server was funded by Nominum, Inc. +Information about Internet Systems Consortium is available at +.B https://www.isc.org/\fR. diff --git a/static/netbsd/man8/dhcrelay.8 b/static/netbsd/man8/dhcrelay.8 new file mode 100644 index 00000000..f8144dc4 --- /dev/null +++ b/static/netbsd/man8/dhcrelay.8 @@ -0,0 +1,357 @@ +.\" $NetBSD: dhcrelay.8,v 1.3 2022/04/03 01:10:59 christos Exp $ +.\" +.\" dhcrelay.8 +.\" +.\" Copyright (C) 2004-2022 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (c) 1997-2003 by Internet Software Consortium +.\" +.\" This Source Code Form is subject to the terms of the Mozilla Public +.\" License, v. 2.0. If a copy of the MPL was not distributed with this +.\" file, You can obtain one at http://mozilla.org/MPL/2.0/. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +.\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" Internet Systems Consortium, Inc. +.\" PO Box 360 +.\" Newmarket, NH 03857 USA +.\" +.\" https://www.isc.org/ +.\" +.\" This software has been written for Internet Systems Consortium +.\" by Ted Lemon in cooperation with Vixie Enterprises. +.\" +.\" Support and other services are available for ISC products - see +.\" https://www.isc.org for more information or to learn more about ISC. +.\" +.\" Id: dhcrelay.8,v 1.20 2012/05/14 23:17:43 sar Exp +.\" +.TH dhcrelay 8 +.SH NAME +dhcrelay - Dynamic Host Configuration Protocol Relay Agent +.SH SYNOPSIS +.B dhcrelay +[ +.B -4 +] +[ +.B -dqaD +] +[ +.B -p +.I port +| +.B -rp +.I relay-port +] +[ +.B -c +.I count +] +[ +.B -A +.I length +] +[ +.B -pf +.I pid-file +] +[ +.B --no-pid +] +[ +.B -m +.I append +| +.I replace +| +.I forward +| +.I discard +] +[ +.B -i +.I interface0 +[ +.B ... +.B -i +.I interfaceN +] +] +[ +.B -iu +.I interface0 +[ +.B ... +.B -iu +.I interfaceN +] +] +[ +.B -id +.I interface0 +[ +.B ... +.B -id +.I interfaceN +] +] +[ +.B -U +.I interface +] +[ +.B -g +.I ipaddr +] +.I server0 +[ +.I ...serverN +] +.PP +.B dhcrelay -6 +[ +.B -dqI +] +[ +.B -p +.I port +| +.B -rp +.I relay-port +] +[ +.B -c +.I count +] +[ +.B -pf +.I pid-file +] +[ +.B --no-pid +] +[ +.B -s +.I subscriber-id +] +.B -l +.I lower0 +[ +.B ... +.B -l +.I lowerN +] +.B -u +.I upper0 +[ +.B ... +.B -u +.I upperN +] +.SH DESCRIPTION +The Internet Systems Consortium DHCP Relay Agent, dhcrelay, provides a +means for relaying DHCP and BOOTP requests from a subnet to which +no DHCP server is directly connected to one or more DHCP servers on +other subnets. It supports both DHCPv4/BOOTP and DHCPv6 protocols. +.SH OPERATION +.PP +The DHCP Relay Agent listens for DHCPv4 or DHCPv6 queries from clients or +other relay agents on one or more interfaces, passing them along to +``upstream'' servers or relay agents as specified on the command line. +When a reply is received from upstream, it is multicast or unicast back +downstream to the source of the original request. +.SH COMMAND LINE +.PP +\fIProtocol selection options:\fR +.TP +-6 +Run dhcrelay as a DHCPv6 relay agent. Incompatible with the \fB-4\fR +option. +.TP +-4 +Run dhcrelay as a DHCPv4/BOOTP relay agent. This is the default mode of +operation, so the argument is not necessary, but may be specified for +clarity. Incompatible with \fB-6\fR. +.PP +\fISpecifying DHCPv4/BOOTP servers\fR +.PP +In DHCPv4 mode, a list of one or more server addresses must be specified on +the command line, to which DHCP/BOOTP queries should be relayed. +.PP +\fIOptions available for both DHCPv4 and DHCPv6:\fR +.TP +-c \fIcount\fR +Maximum hop count. When forwarding packets, dhcrelay discards packets +which have reached a hop count of COUNT. Default is 10. Maximum is 255. +.TP +-d +Force dhcrelay to run as a foreground process. Useful when running +dhcrelay under a debugger, or running out of inittab on System V systems. +.TP +-p \fIport\fR +Listen and transmit on port PORT. This is mostly useful for debugging +purposes. Default is port 67 for DHCPv4/BOOTP, or port 547 for DHCPv6. +Incompatible with \fB-rp\fR. +.TP +-rp \fIrelay-port\fR +Alternative source port for upstream (i.e toward the server) messages +with DHCPv4 RAI relay-port sub-option or DHCPv6 relay-source-port +option. Relay port support is only available if the code was compiled +with (./configure --enable-relay-port) and requires LPF or BPF link +layer access. +.TP +-q +Quiet mode. Prevents dhcrelay6 from printing its network configuration +on startup. +.TP +-pf pid-file +Path to alternate pid file. +.TP +--no-pid +Option to disable writing pid files. By default the program +will write a pid file. +.PP +\fIOptions available in DHCPv4 mode only:\fR +.TP +-a +Append an agent option field to each request before forwarding it to +the server. Agent option fields in responses sent from servers to +clients will be stripped before forwarding such responses back to the +client. The agent option field will contain two agent options: the Circuit +ID suboption and the Remote ID suboption. Currently, the Circuit ID will +be the printable name of the interface on which the client request was +received. The client supports inclusion of a Remote ID suboption as well, +but this is not used by default. +.TP +-A \fIlength\fR +Specify the maximum packet size to send to a DHCPv4/BOOTP server. This +might be done to allow sufficient space for addition of relay agent +options while still fitting into the Ethernet MTU size. +.TP +-D +Drop packets from upstream servers if they contain Relay Agent +Information options that indicate they were generated in response to +a query that came via a different relay agent. If this option is not +specified, such packets will be relayed anyway. +.TP +-g \fIipaddr\fR +When a package gets sent back to the client, replace the gateway's IP +address (giaddr) with the given \fIipaddr\fR. This can be used as a +workaround for bogus clients like Solaris 11 grub, which use the giaddr +instead of the announced router (3) to setup its default route. +.TP +-i \fIifname\fR +Listen for DHCPv4/BOOTP traffic on interface \fIifname\fR. Multiple +interfaces may be specified by using more than one \fB-i\fR option. If +no interfaces are specified on the command line, dhcrelay will identify +all network interfaces, eliminating non-broadcast interfaces if possible, +and attempt to listen on all of them. +.TP +-iu \fIifname\fR +Specifies an upstream network interface: an interface from which replies +from servers and other relay agents will be accepted. Multiple interfaces +may be specified by using more than one \fB-iu\fR option. This argument is + intended to be used in conjunction with one or more -i or -id arguments. +.TP +-id \fIifname\fR +Specifies a downstream network interface: an interface from which requests +from clients and other relay agents will be accepted. Multiple interfaces +may be specified by using more than one \fB-id\fR option. This argument is +intended to be used in conjunction with one or more -i or -iu arguments. +.TP +-m \fIappend\fR|\fIreplace\fR|\fIforward\fR|\fIdiscard\fR +Control the handling of incoming DHCPv4 packets which already contain +relay agent options. If such a packet does not have \fIgiaddr\fR set in +its header, the DHCP standard requires that the packet be discarded. +However, if \fIgiaddr\fR is set, the relay agent may handle the situation +in four ways: It may \fIappend\fR its own set of relay options to the +packet, leaving the supplied option field intact; it may \fIreplace\fR the +existing agent option field; it may \fIforward\fR the packet unchanged; or, +it may \fIdiscard\fR it. +.TP +-U \fIifname\fR +Enables the addition of a RFC 3527 compliant link selection suboption for +clients directly connected to the relay. This RFC allows a relay to +specify two different IP addresses: one for the server to use when +communicating with the relay (giaddr) the other for choosing the subnet +for the client (the suboption). This can be useful if the server is +unable to send packets to the relay via the address used for the subnet. + +When enabled, dhcrelay will add an agent option (as per \fB-a\fR above) that +includes the link selection suboption to the forwarded packet. This will only +be done to packets received from clients that are directly connected to the +relay (i.e. giaddr is zero). The address used in the suboption will be that +of the link upon which the inbound packet was received (which would otherwise +be used for giaddr). The value of giaddr will be set to that of interface +\fIifname\fR. + +Only one interface should be marked in this fashion. Currently enabling +this option on an interface causes the relay to process all DHCP traffic +similar to the \fI-i\fR option, in the future we may split the two more +completely. + +This option is off by default. Note that enabling this option automatically +enables the \fB-a\fR option. + +Keep in mind that using options such as \fB-m replace\fR or \fB-m discard\fR +on relays upstream from one using \fB-U\fR can pose problems. The upstream +relay will wipe out the initial agent option containing the link selection +while leaving the re-purposed giaddr value in place, causing packets to go +astray. + +.PP +\fIOptions available in DHCPv6 mode only:\fR +.TP +-I +Force use of the DHCPv6 Interface-ID option. This option is +automatically sent when there are two or more downstream interfaces +in use, to disambiguate between them. The \fB-I\fR option causes +dhcrelay to send the option even if there is only one downstream +interface. +.TP +-s subscriber-id +Add an option with the specified subscriber-id into the packet. This +feature is for testing rather than production as it will put the same +subscriber-id into the packet for all clients. +.TP +-l [\fIaddress%\fR]\fIifname\fR[\fI#index\fR] +Specifies the ``lower'' network interface for DHCPv6 relay mode: the +interface on which queries will be received from clients or from other +relay agents. At least one \fB-l\fR option must be included in the command +line when running in DHCPv6 mode. The interface name \fIifname\fR is a +mandatory parameter. The link address can be specified by \fIaddress%\fR; +if it isn't, dhcrelay will use the first non-link-local address configured +on the interface. The optional \fI#index\fR parameter specifies the +interface index. +.TP +-u [\fIaddress%\fR]\fIifname\fR +Specifies the ``upper'' network interface for DHCPv6 relay mode: the +interface to which queries from clients and other relay agents should be +forwarded. At least one \fB-u\fR option must be included in the command +line when running in DHCPv6 mode. The interface name \fIifname\fR is a +mandatory parameter. The destination unicast or multicast address can be +specified by \fIaddress%\fR; if not specified, the relay agent will forward +to the DHCPv6 \fIAll_DHCP_Relay_Agents_and_Servers\fR multicast address. +.PP +It is possible to specify the same interface with different addresses +more than once, and even, when the system supports it, to use the same +interface as both upper and lower interfaces. +.SH SEE ALSO +dhclient(8), dhcpd(8), RFC3315, RFC2132, RFC2131. +.SH BUGS +.PP +Using the same interface on both upper and lower sides may cause +loops, so when running this way, the maximum hop count should be set +to a low value. +.PP +The loopback interface is not (yet) recognized as a valid interface. +.SH AUTHOR +.B dhcrelay(8) +To learn more about Internet Systems Consortium, see +.B https://www.isc.org diff --git a/static/netbsd/man8/discard.8 b/static/netbsd/man8/discard.8 new file mode 100644 index 00000000..33dc283d --- /dev/null +++ b/static/netbsd/man8/discard.8 @@ -0,0 +1,136 @@ +.\" $NetBSD: discard.8,v 1.3 2020/03/18 19:05:14 christos Exp $ +.\" +.TH DISCARD 8 +.ad +.fi +.SH NAME +discard +\- +Postfix discard mail delivery agent +.SH "SYNOPSIS" +.na +.nf +\fBdiscard\fR [generic Postfix daemon options] +.SH DESCRIPTION +.ad +.fi +The Postfix \fBdiscard\fR(8) delivery agent processes +delivery requests from +the queue manager. Each request specifies a queue file, a sender +address, a next\-hop destination that is treated as the reason for +discarding the mail, and recipient information. +The reason may be prefixed with an RFC 3463\-compatible detail code. +This program expects to be run from the \fBmaster\fR(8) process +manager. + +The \fBdiscard\fR(8) delivery agent pretends to deliver all recipients +in the delivery request, logs the "next\-hop" destination +as the reason for discarding the mail, updates the +queue file, and either marks recipients as finished or informs the +queue manager that delivery should be tried again at a later time. + +Delivery status reports are sent to the \fBtrace\fR(8) +daemon as appropriate. +.SH "SECURITY" +.na +.nf +.ad +.fi +The \fBdiscard\fR(8) mailer is not security\-sensitive. It does not talk +to the network, and can be run chrooted at fixed low privilege. +.SH "STANDARDS" +.na +.nf +RFC 3463 (Enhanced Status Codes) +.SH DIAGNOSTICS +.ad +.fi +Problems and transactions are logged to \fBsyslogd\fR(8) +or \fBpostlogd\fR(8). + +Depending on the setting of the \fBnotify_classes\fR parameter, +the postmaster is notified of bounces and of other trouble. +.SH "CONFIGURATION PARAMETERS" +.na +.nf +.ad +.fi +Changes to \fBmain.cf\fR are picked up automatically as \fBdiscard\fR(8) +processes run for only a limited amount of time. Use the command +"\fBpostfix reload\fR" to speed up a change. + +The text below provides only a parameter summary. See +\fBpostconf\fR(5) for more details including examples. +.IP "\fBconfig_directory (see 'postconf -d' output)\fR" +The default location of the Postfix main.cf and master.cf +configuration files. +.IP "\fBdaemon_timeout (18000s)\fR" +How much time a Postfix daemon process may take to handle a +request before it is terminated by a built\-in watchdog timer. +.IP "\fBdelay_logging_resolution_limit (2)\fR" +The maximal number of digits after the decimal point when logging +sub\-second delay values. +.IP "\fBdouble_bounce_sender (double\-bounce)\fR" +The sender address of postmaster notifications that are generated +by the mail system. +.IP "\fBipc_timeout (3600s)\fR" +The time limit for sending or receiving information over an internal +communication channel. +.IP "\fBmax_idle (100s)\fR" +The maximum amount of time that an idle Postfix daemon process waits +for an incoming connection before terminating voluntarily. +.IP "\fBmax_use (100)\fR" +The maximal number of incoming connections that a Postfix daemon +process will service before terminating voluntarily. +.IP "\fBprocess_id (read\-only)\fR" +The process ID of a Postfix command or daemon process. +.IP "\fBprocess_name (read\-only)\fR" +The process name of a Postfix command or daemon process. +.IP "\fBqueue_directory (see 'postconf -d' output)\fR" +The location of the Postfix top\-level queue directory. +.IP "\fBsyslog_facility (mail)\fR" +The syslog facility of Postfix logging. +.IP "\fBsyslog_name (see 'postconf -d' output)\fR" +A prefix that is prepended to the process name in syslog +records, so that, for example, "smtpd" becomes "prefix/smtpd". +.PP +Available in Postfix 3.3 and later: +.IP "\fBservice_name (read\-only)\fR" +The master.cf service name of a Postfix daemon process. +.SH "SEE ALSO" +.na +.nf +qmgr(8), queue manager +bounce(8), delivery status reports +error(8), Postfix error delivery agent +postconf(5), configuration parameters +master(5), generic daemon options +master(8), process manager +postlogd(8), Postfix logging +syslogd(8), system logging +.SH "LICENSE" +.na +.nf +.ad +.fi +The Secure Mailer license must be distributed with this software. +.SH HISTORY +.ad +.fi +This service was introduced with Postfix version 2.2. +.SH "AUTHOR(S)" +.na +.nf +Victor Duchovni +Morgan Stanley + +Based on code by: +Wietse Venema +IBM T.J. Watson Research +P.O. Box 704 +Yorktown Heights, NY 10598, USA + +Wietse Venema +Google, Inc. +111 8th Avenue +New York, NY 10011, USA diff --git a/static/netbsd/man8/disklabel.8 b/static/netbsd/man8/disklabel.8 new file mode 100644 index 00000000..18251873 --- /dev/null +++ b/static/netbsd/man8/disklabel.8 @@ -0,0 +1,411 @@ +.\" $NetBSD: disklabel.8,v 1.70 2019/07/02 16:47:19 wiz Exp $ +.\" +.\" Copyright (c) 1987, 1988, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" This code is derived from software contributed to Berkeley by +.\" Symmetric Computer Systems. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)disklabel.8 8.2 (Berkeley) 4/19/94 +.\" +.Dd July 2, 2019 +.Dt DISKLABEL 8 +.Os +.Sh NAME +.Nm disklabel +.Nd read and write disk pack label +.Sh SYNOPSIS +.\" disklabel: read label +.Nm +.Op Fl ACDFmnrtv +.Op Fl B Ar endian +.Op Fl L Ar sector +.Op Fl M Ar machine +.Op Fl O Ar offset +.Op Fl P Ar size +.Ar disk +.\" disklabel -e: read/modify/write using $EDITOR +.Nm +.Fl e +.Op Fl CDFImnrv +.Op Fl B Ar endian +.Op Fl L Ar sector +.Op Fl M Ar machine +.Op Fl O Ar offset +.Op Fl P Ar size +.Ar disk +.\" disklabel -i: read/modify/write using builtin commands +.Nm +.Fl i +.Op Fl DFImnrv +.Op Fl B Ar endian +.Op Fl L Ar sector +.Op Fl M Ar machine +.Op Fl O Ar offset +.Op Fl P Ar size +.Ar disk +.\" disklabel -R: write from edited output +.Nm +.Fl R +.Op Fl DFmnrv +.Op Fl B Ar endian +.Op Fl L Ar sector +.Op Fl M Ar machine +.Op Fl O Ar offset +.Op Fl P Ar size +.Ar disk Ar protofile +.\" disklabel -w: write from disctab entry +.Nm +.Fl w +.Op Fl DFmnrv +.Op Fl B Ar endian +.Op Fl L Ar sector +.Op Fl M Ar machine +.Op Fl O Ar offset +.Op Fl P Ar size +.Op Fl f Ar disktab +.Ar disk Ar disktype +.Oo Ar packid Oc +.\" disklabel -NW: disallow/allow writes to the label sector +.Nm +.Op Fl NW +.Ar disk +.\" disklabel -l: list all know file system types +.Nm +.Fl l +.Sh DESCRIPTION +.Nm +can be used to install, examine, or modify the label on a disk drive or pack. +When writing the label, it can be used to change the drive identification, +the disk partitions on the drive, or to replace a damaged label. +.Pp +The +.Fl e , i , l , N , R , W , +and +.Fl w +options determine the basic operation. +If none are specified the label +is displayed. +.Bl -tag -width flag +.It Fl e +Edit the existing label (using +.Ev EDITOR ) +and write it back to the disk. +If +.Ev EDITOR +is undefined, then +.Xr vi 1 +is used. +.It Fl i +Interactively update the existing label and write it back to the disk. +.It Fl l +Show all known file system types (those that can be specified along a +partition within the label) and exit. +.It Fl N +Disallow writes to the disk sector that contains the label. +This is the default state. +.It Fl R +Write (restore) a label by reading it from +.Ar protofile . +The file should be in the same format as the default output. +.It Fl W +Allow writes to the disk sector that contains the label. +This state may not persist if no programs have the disk open. +.It Fl w +Write a standard label for the specified +.Ar disktype . +See +.Xr disktab 5 . +.El +.Pp +The majority of the rest of the options affect more than one form of the +command: +.Bl -tag -width flag +.It Fl A +Read all labels from the disk, including ones deleted with +.Nm +.Fl D . +Implies +.Fl r . +.It Fl B Ar endian +Specify the byteorder of the label to be written. +It should be: +.Dq be +or +.Dq le . +.It Fl C +Output the partition offset and size values in +.Aq cylinder/head/sector +format. +Note this format is always accepted on input with either the +.Fl e +or +.Fl R +flags. +.It Fl D +Delete all existing labels (by 1's complementing the magic number) before +writing any labels to their default location. +Implies +.Fl r . +If +.Fl D +is specified without a request to write the label, then existing labels are +just deleted. +.It Fl F +Treat +.Ar disk +as a regular file. +This suppresses all +.Xr ioctl 2 +calls, and is the default if +.Ar disk +is a regular file. +.Ar disk +is always opened using +.Xr opendisk 3 +even if +.Fl F +is specified. +Implies +.Fl r . +.It Fl f Ar disktab +Specify the name of a file to use instead of +.Pa /etc/disktab . +.It Fl I +If a label cannot be read from +.Ar disk +request the default one from the kernel. +Implies +.Fl r . +.It Fl L Ar sector +Specify the relative sector number of the disklabel +similar to the environment variable +.Ev DISKLABELSECTOR . +.It Fl M Ar machine +Specify the machine to generate a label for. +Defaults to the current machine it is compiled for. +Specific details can be overridden via environment +and with the options +.Fl B , L , m , n , O , +and +.Fl P . +.It Fl m +Expect the label to have an MBR. +.It Fl n +Expect the label not to have an MBR. +.It Fl O Ar offset +Specify the relative byte offset of the disklabel +similar to the environment variable +.Ev DISKLABELOFFSET . +.It Fl P Ar size +Specify the size of the partition table. +.It Fl r +Read/write the disk directly rather than using +.Xr ioctl 2 +requests on the kernel. +When writing a label, the kernel will be told about the label before the +label is written and asked to write afterwards. +This is the historic behaviour and can be suppressed by specifying +.Fl F . +.It Fl t +Format the output as a +.Xr disktab 5 +entry. +.It Fl v +Be verbose about the operations being done, in particular the disk sectors +being read and written. +Specifying +.Fl v +more than once will increase the verbosity. +.El +.Pp +On systems that expect to have disks with MBR partitions (see +.Xr fdisk 8 ) +.Nm +will find, and update if requested, labels in the first 8k of type 169 +.Pq Nx +MBR labels and within the first 8k of the physical disk. +On other systems +.Nm +will only look at the start of the disk. +The offset at which the labels are written is also system dependent. +.Pp +.Nm +will detect byteswapped labels, but currently cannot display them. +.Pp +Previous versions of +.Nm +could update the bootstrap code on some architectures. +This functionality has been subsumed by +.Xr installboot 8 . +.Sh FILES +.Bl -tag -width /etc/disktab -compact +.It Pa /etc/disktab +.El +.Sh EXIT STATUS +The exit status of +.Nm +is set to indicate any errors or warnings. +The values used are: +.Bl -tag -width indent +.It 0 +The +.Nm +utility has completed successfully. +.It 1 +A fatal error has occurred, such as unknown options passed on the +command line, or writing the disklabel failed. +.It 4 +An I/O error of some sort occurred. +.It 101..n +One or more warnings occurred while reading the disklabel. +Subtract 100 to get the number of warnings detected. +.El +.Sh EXAMPLES +.Dl Ic disklabel sd0 +.Pp +Display the in-core label for sd0 as obtained via +.Pa /dev/rsd0c . +.Pp +.Dl Ic disklabel -i -r sd0 +.Pp +Read the on-disk label for sd0, edit it using the built-in interactive editor and reinstall in-core as well +as on-disk. +.Pp +.Dl Ic disklabel -i -I sd0 +.Pp +As previous, but do not fail if there was no label on the disk yet; +provide some default values instead. +.Pp +.Dl Ic disklabel -e -I sd0 +.Pp +As previous, only edit using $EDITOR +.Pp +.Dl Ic disklabel -w -r /dev/rsd0c sd2212 foo +.Pp +Create a label for sd0 based on information for +.Dq sd2212 +found in +.Pa /etc/disktab , +using +.Pa foo +as the disk pack label. +If you do not have an entry for your disk in +.Pa /etc/disktab , +you can use this style to put +an initial label onto a new disk. +Then dump the label to a file (using +.Ic disklabel sd0 > protofile ) , +editing the file, and replacing the label with +.Ic disklabel -R sd0 protofile . +.Pp +.Dl Ic disklabel -R sd0 mylabel +.Pp +Restore the on-disk and in-core label for sd0 from information in +.Pa mylabel . +.Sh DIAGNOSTICS +The kernel device drivers will not allow the size of a disk partition +to be decreased or the offset of a partition to be changed while it is open. +Some device drivers create a label containing only a single large partition +if a disk is unlabeled; thus, the label must be written to the +.Dq a +partition of the disk while it is open. +This sometimes requires the desired label to be set in two steps, +the first one creating at least one other partition, +and the second setting the label on the new partition +while shrinking the +.Dq a +partition. +.Sh SEE ALSO +.Xr opendisk 3 , +.Xr disklabel 5 , +.Xr disktab 5 , +.Xr dkctl 8 , +.Xr fdisk 8 , +.Xr gpt 8 , +.Xr installboot 8 , +.Xr mbrlabel 8 , +.Xr mscdlabel 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Bx 4.3 Tahoe . +.Sh BUGS +The +.Nm +structure stored on disk cannot support partitions/disks greater than 2TB. +Please use +.Xr gpt 8 +and +.Xr dkctl 8 +to manage partitions and disks larger than 2TB. +.Pp +If the disk partition is not specified in the disk name +(i.e., +.Ar xy0 +instead of +.Ar /dev/rxy0c ) , +.Nm +will construct the full pathname of the disk and use the +.Dq d +partition on i386, hpcmips, or arc, and the +.Dq c +partition on all others. +.Pp +On the sparc, sparc64, sun2, and sun3 +.Nx +systems, the size of each partition must be a multiple of the number +of sectors per cylinder (i.e., each partition must be an integer +number of cylinders), or the boot ROMs will declare the label +invalid and fail to boot the system. +.Pp +In addition, the +.Fl r +option should never be used on a sparc, sparc64, sun2, or sun3 system +boot disk - the +.Nx +kernel translates the +.Nx +disk label into a SunOS compatible format (which is required by the +boot PROMs) when it writes the label. +Using the +.Fl r +flag causes +.Nm +to write directly to disk, and bypass the format translation. +This will result in a disk label that the PROMs will not recognize, +and that therefore cannot be booted from. +.Pp +The +.Fl m +flag previously toggled between using an MBR and not using an MBR, +with the default being implied by the machine type. +It now always enables MBR mode, independent of the machine default. +Use the +.Fl n +flag to disable MBR mode. diff --git a/static/netbsd/man8/diskless.8 4.html b/static/netbsd/man8/diskless.8 4.html new file mode 100644 index 00000000..0ff9e35e --- /dev/null +++ b/static/netbsd/man8/diskless.8 4.html @@ -0,0 +1,542 @@ + + + + + + +
DISKLESS(8)System Manager's ManualDISKLESS(8)
+
+
+

+

diskless — booting + a system over the network

+
+
+

+

The ability to boot a system over the network is useful for two + kinds of systems:

+
+
+
a system with no attached mass storage media to boot or run from (e.g. a + network computer).
+
+
a system with a hard drive that only contains system and application + software, and user data is mounted over the network from a central + server.
+
+

It can also be done as a temporary measure while repairing or + re-installing file systems on a local disk. This capability is necessarily + platform dependent because of its dependence on system firmware support; not + all platforms supported by NetBSD are capable of + being network booted.

+

The protocols used to obtain a network address (e.g. an IP host + address), include, but are not limited to:

+

+
+
+
RARP
+
Reverse Address Resolution Protocol (ARP)
+
DHCP
+
Dynamic Host Configuration Protocol
+
BOOTP
+
Bootstrap Protocol
+
+
+

This information can also be derived from non-volatile RAM or by a + transform of a network interface (e.g. Ethernet) MAC address.

+

The protocols used to load a NetBSD kernel + over a network include, but are not limited to:

+

+
+
+
TFTP
+
Trivial File Transfer Protocol
+
NFS
+
Sun Network File System
+
RMP
+
HP Remote Maintenance Protocol
+
MOP
+
DEC Maintenance Operations Protocol
+
+
+

Derivation of the filename of the secondary bootstrap program can + be done by a transform of a network interface MAC address (or other protocol + address), or provided by a server as with BOOTP, and DHCP. How this is done + is platform dependent; see boot(8).

+

The NetBSD kernel doesn't care how it gets + loaded and started. The protocols used to boot + NetBSD can be completely different from the ones + that NetBSD uses operationally, i.e. you can netboot + the system using HP RMP and the NetBSD kernel can + use IP to communicate after bootstrap.

+

There is no standard way to pass all the required information from + a boot loader to an operating system kernel, so the + NetBSD kernel usually has to recapitulate the same + (or similar) protocol exchanges over the network to obtain a network + address, determine which servers to use, and so on. + NetBSD supports obtaining this information from + RARP, BOOTP, DHCP, and Sun RPC "bootparams". See + options(4) for a list of methods that can be compiled into + a NetBSD kernel.

+

NetBSD only supports the Sun Network File + System (NFS) for mounting its root file system over a network. + NetBSD can use any local mass storage device for + which it has a driver, after bootstrap, even if that device is not supported + by the system's firmware for booting.

+

N.B. DHCP is essentially a series of extensions + to BOOTP; the NetBSD dhcpd(8) is + capable of responding to both kinds of protocol requests.

+

In the majority of configurations, network boot servers and + clients are attached to the same LAN so that broadcast queries from the + clients can be heard by the servers. Unless specially configured, routers + block broadcasts from propagating from LAN to LAN; some routers can be + configured to "forward" broadcast BOOTP packets to another LAN + attached to that router, which permits a server on that remote LAN to + respond to the client's broadcast query.

+
+
+

+

When booting a system over the network, there are three phases of + interaction between client and server:

+

+
    +
  1. The system firmware (or stage-1 bootstrap) loads a boot program.
    2. +
  2. The boot program loads a NetBSD kernel.
    3. +
  3. The NetBSD kernel performs an NFS mount of the + root file system.
    4. +
+

Each of these phases is described in further detail below.

+
+

+

In phase 1, the system firmware loads a boot program. Firmware + designs vary widely, so this phase is inherently machine-specific. Some + examples:

+

DEC Alpha systems use BOOTP to determine the client's IP address + and then use TFTP to load a secondary bootstrap program from the server and + filename specified in the BOOTP reply. DEC Alpha systems can also use MOP to + load a program to run the system.

+

Sun systems use RARP to determine the client's IP address, + transform that address to a hexadecimal string to form the filename of the + secondary boot program, and then use TFTP to download the boot program from + the server that sent the RARP reply.

+

HP 300-series systems use the HP RMP to download a boot + program.

+

Typical personal computers may load a network boot program either + from diskette or from a PROM on a Network Interface Card (NIC). Some + BIOSes support booting from a network interface.

+
+
+

+

In phase 2, the secondary boot program loads a kernel. Operation + in this phase depends on the design of the boot program. A secondary + bootstrap program that uses RARP and Sun RPC BOOTPARAMS typically does the + following:

+

+
    +
  1. gets the client IP address using RARP.
    2. +
  2. gets the client name and server IP address by broadcasting an RPC / + BOOTPARAMS / WHOAMI request with the client IP address.
    3. +
  3. gets the server path for this client's root using an RPC / BOOTPARAMS / + GETFILE request with the client name.
    4. +
  4. gets the root file handle by calling mountd(8) with the + server path for the client root file system.
    5. +
  5. gets the kernel file handle by calling NFS + () + on the root file handle.
    6. +
  6. loads the kernel using NFS read calls on the kernel file handle.
    7. +
  7. transfers control to the kernel entry point.
    8. +
+

A secondary bootstrap program that uses BOOTP and/or DHCP + typically does the following:

+

+
    +
  1. query for the client's bootstrap parameters. The response must include the + client's IP address, server's IP address, an NFS root path, and a filename + to load the NetBSD kernel from.
    2. +
  2. gets the root file handle by calling mountd(8) with the + server path for the client root file system.
    3. +
  3. gets the kernel file handle by calling NFS + () + on the root file handle.
    4. +
  4. loads the kernel using NFS read calls on the kernel file handle.
    5. +
  5. transfers control to the kernel entry point.
    6. +
+
+
+

+

In phase 3, the kernel performs an NFS mount of the root file + system. The kernel repeats much of the work done by the boot program because + there is no standard way for the boot program to pass the information it + gathered on to the kernel.

+

In general, the GENERIC kernel config(1) file + for any particular architecture will specify compile-time options to use the + same protocol used by the secondary boot program for that architecture. A + NetBSD kernel can be compiled to use any of BOOTP, + DHCP, or Sun RPC BOOTPARAMS; see options(4).

+

The procedure typically used by the kernel is as follows:

+

+
    +
  1. The kernel finds a boot server using the same procedures as described + above to determine the client's IP address, an NFS server, etc.
    2. +
  2. The kernel gets the NFS file handle for root using the same procedure as + described above.
    3. +
  3. The kernel calls the NFS + () + function to get the last-modified time of the root directory, and uses it + to check the system clock.
    4. +
+
+
+
+

+

Before a client can bootstrap over the network, its server must be + configured. Each daemon that implements these protocols must be set up so + that it can answer queries from the clients. Some of these daemons are + invoked as packets come in, by inetd(8), and some must run + independently, started from /etc/rc; see + rc.conf(5).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RARPrarpdrc.conf(5)
DHCPdhcpdrc.conf(5)
BOOTPbootpdinetd.conf(5)
TFTPtftpdinetd.conf(5)
Sun RPCrpcbindrc.conf(5)
Sun RPCrpc.bootparamdrc.conf(5)
Sun NFSmountdrc.conf(5)
Sun NFSnfsiodrc.conf(5)
HP RMPrbootdrc.conf(5)
+

N.B. DHCP is essentially a series of extensions + to BOOTP; the NetBSD dhcpd(8) is + capable of responding to both kinds of protocol requests. Since they both + bind to the same UDP port, only one may be run on a given server.

+

In the following examples, the client's hostname is + myclient; the server is myserver, and + the addresses are all fictional. In these examples the hostnames may be + Fully Qualified Domain Names (FQDN, e.g. "myclient.mydomain.com") + provided that they are used consistently.

+
+

+

For clients that use RARP to obtain their IP address, an entry + must be added for each client to /etc/ethers with + the client's Ethernet MAC address and Internet hostname:

+

+
+
8:0:20:7:c5:c7          myclient
+
+

This will be used by rarpd(8) to reply to + queries from the clients. There must be one entry per client system.

+

A client system's Ethernet MAC address is often printed on the + system case, or on a chip on its motherboard, or on the NIC. If not, + "sniffing" the network with tcpdump(8) when the + client is powered-on should reveal its Ethernet MAC address.

+

Each client system that uses RARP must have its own, unique IP + address assigned to it. Assign an IP address for myclient in your + /etc/hosts file, or in the master file for your DNS + zone. For /etc/hosts the entry should look like:

+

+
+
192.197.96.12           myclient
+
+
+
+

+

The NetBSD DHCP server + dhcpd(8) was developed by the Internet Software Consortium + (ISC).

+

DHCP can provide a wide range of information to a requesting + client; the key data for bootstrapping a diskless client are:

+

+
    +
  1. an IP address
    2. +
  2. a subnet mask
    3. +
  3. a TFTP server address for loading the secondary bootstrap and the + NetBSD kernel
    4. +
  4. a filename of the secondary bootstrap
    5. +
  5. an NFS server address for the client's file system
    6. +
  6. the client's root file system path, to be NFS mounted.
    7. +
+

An example for /etc/dhcpd.conf

+
+
host myclient {
+	hardware ethernet 8:0:20:7:c5:c7;
+	fixed-address myclient;		# client's assigned IP address
+	filename "myclient.netboot";	# secondary bootstrap
+	next-server myserver;		# TFTP server for secondary bootstrap
+	option swap-server myserver;	# NFS server for root filesystem
+	option root-path "/export/myclient/root";
+}
+
+

That + declaration + goes inside a + + declaration, which gives parameters for all hosts on the subnet that will be + using DHCP, such as the "routers" (the default route), + "subnet-mask", "broadcast-address", + "domain-name-servers", etc. See dhcpd.conf(5) + for details. In that example, myclient has an assigned IP + address.

+

The DHCP parameters required for network bootstrapping a system + will vary from platform to platform, as dictated by each system's firmware. + In particular, because DHCP is extensible, some hardware vendors have + specified DHCP options to return information to requesting clients that are + specific to that platform. Please see your platform's + boot(8) for details.

+
+
+

+

If booting a Sun system, or other system that expects to use TFTP, + ensure that inetd(8) is configured to run + tftpd(8). The tftpd(8) server should be + set up to serve the directory /tftpboot.

+

If booting a SPARC system, install a copy of the appropriate + diskless secondary boot loader (such as + /usr/mdec/boot or + ofwboot.net) in the + /tftpboot directory. Make a link such that the boot + program is accessible by a filename composed of the client's IP address in + hexadecimal, a dot, and the architecture name (all upper case). For + example:

+

+
+
# cd /tftpboot
+# ln -s boot C0C5600C.SUN4
+
+

For a Sun-3 or UltraSPARC system, the filename would be just + C0C5600C (these systems' firmware does not append the architecture name). + The name used is architecture dependent, it simply has to match what the + booting client's system firmware wishes it to be.

+

If the client's system firmware fails to fetch the expected file, + tcpdump(8) can be used to discover which filename the + client is requesting. Also, examination of tftpd(8) log + entries (typically in /var/log/messages) should show + whether the server is hearing the client system, and what filename the + client is asking for.

+
+
+

+

If booting an HP 300-series system, ensure that + /etc/rbootd.conf is configured properly to transfer + the boot program to the client. An entry might look like this:

+

+
+
08:00:09:01:23:E6	SYS_UBOOT	# myclient
+
+

The secondary bootstrap program for an HP 300-series system + SYS_UBOOT (which may be called + uboot.lif before installation) must be installed in + the directory /usr/mdec/rbootd.

+

See the rbootd(8) manual page for more + information.

+
+
+

+

Add myclient to the bootparams database in + /etc/bootparams:

+

+
+
myclient  root=myserver:/export/myclient/root \
+          swap=myserver:/export/myclient/root/swap \
+          dump=myserver:/export/myclient/root/swap
+
+

and ensure that rpc.bootparamd(8) and + rpcbind(8) are running. Both myclient + and myserver must have IP addresses in the DNS or + /etc/hosts.

+
+
+

+

Build the swap file for myclient on the NFS + server:

+

+
+
# cd /export/myclient/root
+# dd if=/dev/zero of=swap bs=16k count=1024
+
+

This creates a 16 megabyte swap file.

+

Populate myclient's root + file system on the NFS server. How this is done depends on the client + architecture and the version of the NetBSD + distribution. It can be as simple as copying and modifying the server's root + file system, or unpack a complete NetBSD binary + distribution for the appropriate platform.

+

If the NFS server is going to support multiple different + architectures (e.g. Alpha, PowerPC, SPARC, MIPS), then it is important to + think carefully about how to lay out the NFS server's exported file systems, + to share what can be shared (e.g. text files, configuration files, user home + directories), and separate that which is distinct to each architecture (e.g. + binary executables, libraries).

+
+
+

+

Export the client-populated file systems on the NFS server in + /etc/exports:

+

+
+
/usr -ro myclient
+# for SunOS:
+# /export/myclient -rw=myclient,root=myclient
+# for NetBSD:
+/export/myclient -maproot=root -alldirs myclient
+
+

If the server and client are of the same architecture, then the + client can share the server's /usr file system (as + is done above). If not, you must build a properly fleshed out + /usr partition for the client in some other part of + the server's file system, to serve to the client.

+

If your server is a SPARC, and your client a Sun-3, you might + create and fill /export/usr.sun3 and then use the + following /etc/exports lines:

+

+
+
/export/usr.sun3 -ro myclient
+/export/myclient -rw=myclient,root=myclient
+
+

Of course, in either case you will have to have an NFS server + running on the server side.

+
+
+
+

+

Copy and customize at least the following files in + /export/myclient/root:

+

+
+
# cd /export/myclient/root/etc
+# vi fstab
+# cp /etc/hosts hosts
+# echo 'hostname="myclient"' >> rc.conf
+# echo "inet 192.197.96.12" > ifconfig.le0
+
+

Note that "le0" above should be replaced with the name + of the network interface that the client will use for booting; the network + interface name is device dependent in NetBSD.

+

Correct the critical mount points and the swap file in the + client's /etc/fstab (which will be + /export/myclient/root/etc/fstab) i.e.

+

+
+
myserver:/export/myclient/root  /    nfs  rw 0 0
+myserver:/usr                   /usr nfs  rw 0 0
+/swap                           none swap sw 0 0
+
+

Note, you + specify the + swap file in /etc/fstab or it will not be used! See + swapctl(8).

+

It may be useful to set “flushroutes=NO” in + /etc/rc.conf to avoid the default route supplied by + the boot setup disappearing mid-boot.

+
+
+

+
+
/etc/hosts
+
table of associated IP addresses and IP host names; see + hosts(5)
+
/etc/ethers
+
table of associated Ethernet MAC addresses and IP host names used by + rarpd(8); see ethers(5)
+
/etc/bootparams
+
client root pathname and swap pathname; see + bootparams(5)
+
/etc/exports
+
exported NFS mount points; see exports(5)
+
/etc/rbootd.conf
+
configuration file for HP RMP; see rbootd(8)
+
/usr/mdec/rbootd
+
location of boot programs offered by rbootd(8)
+
/tftpboot
+
location of boot programs offered by tftpd(8)
+
+
+
+

+

bootparams(5), dhcpd.conf(5), + ethers(5), exports(5), + fstab(5), hosts(5), + networks(5), boot(8), + dhcpd(8), mopd(8), + mountd(8), nfsd(8), + rarpd(8), rbootd(8), + reboot(8), rpc.bootparamd(8), + tftpd(8)

+

Reverse Address Resolution + Protocol, RFC, 903, + June 1984.

+

Bootstrap Loading using + TFTP, RFC, 906, + June 1984.

+

Bootstrap Protocol, + RFC, 951, + September 1985.

+

The TFTP Protocol (Revision + 2), RFC, 1350, + July 1992.

+

Dynamic Host Configuration + Protocol, RFC, + 2131, March + 1997.

+

DHCP Options and BOOTP Vendor + Extensions, RFC, + 2132, March + 1997.

+

RFC Editor

+
+
+ + + + + +
January 8, 2026NetBSD 10.1
diff --git a/static/netbsd/man8/diskpart.8 b/static/netbsd/man8/diskpart.8 new file mode 100644 index 00000000..41331cde --- /dev/null +++ b/static/netbsd/man8/diskpart.8 @@ -0,0 +1,140 @@ +.\" Copyright (c) 1983, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)diskpart.8 8.1 (Berkeley) 6/6/93 +.\" $NetBSD: diskpart.8,v 1.9 2009/03/15 10:09:29 joerg Exp $ +.\" +.Dd June 6, 1993 +.Dt DISKPART 8 +.Os +.Sh NAME +.Nm diskpart +.Nd calculate default disk partition sizes +.Sh SYNOPSIS +.Nm +.Op Fl d +.Op Fl p +.Op Fl s Ar size +.Ar disk-type +.Sh DESCRIPTION +.Nm +is used to calculate the disk partition sizes based on the +default rules used at Berkeley. +.Pp +Available options and operands: +.Bl -tag -width Fl +.It Fl d +An entry suitable for inclusion in the disk +description file +.Pa /etc/disktab +is generated; for example, +.Xr disktab 5 . +.It Fl p +Tables suitable for inclusion in a device driver +are produced. +.It Fl s Ar size +The size of the disk may be limited to +.Ar size +with the +.Fl s +option. +.El +.Pp +On disks that use +.Xr bad144 8 +type of +bad-sector forwarding, +space is normally left in the last partition on the disk +for a bad sector forwarding table, although this space +is not reflected in the tables produced. The space reserved +is one track for the replicated copies of the table and +sufficient tracks to hold a pool of 126 sectors to which bad sectors +are mapped. For more information, see +.Xr bad144 8 . +The +.Fl s +option is intended for other controllers which reserve some space at the end +of the disk for bad-sector replacements or other control areas, +even if not a multiple of cylinders. +.Pp +The disk partition sizes are based on the total amount of +space on the disk as given in the table below (all values +are supplied in units of sectors). The +.Ql c +partition +is, by convention, used to access the entire physical disk. +The device driver tables include +the space reserved for the bad sector forwarding table in the +.Ql c +partition; +those used in the disktab and default formats exclude reserved tracks. +In normal operation, either the +.Ql g +partition is used, or the +.Ql d , +.Ql e , +and +.Ql f +partitions are used. The +.Ql g +and +.Ql f +partitions +are variable-sized, occupying whatever space remains after allocation +of the fixed sized partitions. +If the disk is smaller than 20 Megabytes, then +.Nm +aborts with the message +.Dq Li disk too small, calculate by hand . +.Bl -column Partition 20-60\ MB 61-205\ MB 206-355\ MB 356+\ MB +.It Partition 20-60 MB 61-205 MB 206-355 MB 356+ MB +.It a 15884 15884 15884 15884 +.It b 10032 33440 33440 66880 +.It d 15884 15884 15884 15884 +.It e unused 55936 55936 307200 +.It h unused unused 291346 291346 +.El +.Pp +If an unknown disk type is specified, +.Nm +will prompt for the required disk geometry information. +.Sh SEE ALSO +.Xr disktab 5 , +.Xr bad144 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.2 . +.Sh BUGS +Most default partition sizes are based on historical artifacts +(like the RP06), and may result in unsatisfactory layouts. +.Pp +When using the +.Fl d +flag, alternative disk names are not included +in the output. diff --git a/static/netbsd/man8/dkctl.8 b/static/netbsd/man8/dkctl.8 new file mode 100644 index 00000000..5f7ceeda --- /dev/null +++ b/static/netbsd/man8/dkctl.8 @@ -0,0 +1,231 @@ +.\" $NetBSD: dkctl.8,v 1.30 2024/09/14 08:30:44 mlelstv Exp $ +.\" +.\" Copyright 2002 Wasabi Systems, Inc. +.\" All rights reserved. +.\" +.\" Written by Jason R. Thorpe for Wasabi Systems, Inc. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed for the NetBSD Project by +.\" Wasabi Systems, Inc. +.\" 4. The name of Wasabi Systems, Inc. may not be used to endorse +.\" or promote products derived from this software without specific prior +.\" written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd March 29, 2020 +.Dt DKCTL 8 +.Os +.Sh NAME +.Nm dkctl +.Nd program to manipulate disks +.Sh SYNOPSIS +.Nm +.Ar device +.Nm +.Ar device +.Ar command +.Op Ar arg Op ... +.Sh DESCRIPTION +.Nm +allows a user or system administrator to manipulate and configure disks +in various ways. +It is used by specifying a disk to manipulate, the command +to perform, and any arguments the command may require. +.Ar device +is the disk (wdN, sdN, ...) containing the wedges unless noted otherwise. +If +.Nm +is called without any command, it displays strategy, cache, and all of +the wedges of the specified device. +.Sh COMMANDS +The following commands are supported: +.Bl -tag -width XXstrategyXXnameXX +.It Ic addwedge Ar name Ar startblk Ar blkcnt Ar ptype +Define a +.Dq wedge +on the specified disk starting at block number +.Ar startblk +and spanning +.Ar blkcnt +blocks. +You need to create the partition first with +.Xr fdisk 8 +or +.Xr gpt 8 , +.Nm +will just name it. +The wedge will have the volume name +.Ar name +and the partition type +.Ar ptype . +Valid choices for ptype would be +.Ar unused , +.Ar swap , +.Ar ffs , +.Ar lfs , +.Ar ext2fs , +.Ar cd9660 , +.Ar ados , +.Ar hfs , +.Ar msdos , +.Ar filecore , +.Ar raidframe , +.Ar ccd , +.Ar appleufs , +.Ar ntfs , +.Ar cgd , +and +.Ar zfs . +.Pp +The device name of the virtual block device assigned to the wedge will be +displayed after the wedge has been successfully created. +See +.Xr dk 4 +for more information about disk wedges. +.It Ic badsector Ar flush | list | retry +Used for managing the kernel's bad sector list for +.Xr wd 4 +devices. +The software bad sector list is only maintained if the option +.Dq WD_SOFTBADSECT +was specified on kernel configuration. +.Bl -tag -width XflushXX -offset indent +.It flush +Clears the in kernel list of bad sectors. +.It list +Prints out the list of bad sector ranges recorded by the kernel. +.It retry +Flushes the in kernel list and then retries all of the previously recorded +bad sectors, causing the list to self update. +This option +.Em can only +be used with character devices. +.El +.It Ic delwedge Ar dk +Delete the wedge specified by its device name +.Ar dk +from the specified disk. +.It Ic getcache +Get and display the cache enables for the specified device. +.It Ic getwedgeinfo +Display information about the specified disk wedge. +.Ar device +in this case is the wedge name. +.It Ic getgeometry +Display media and sector size of the specified disk, wedge or volume. +.It Ic keeplabel Op Ar yes | no +Specify to keep or drop the in-core disklabel on the last close of +the disk device. +(Keep if +.Ar yes +is specified, drop if +.Ar no +is specified.) +.It Ic listwedges Oo Fl e Oc Op Fl q +List all of the wedges configured on the specified disk. +With +.Fl e +exit with a non-zero exit status if there are no wedges +configured on that disk. +With +.Fl q +(quiet mode) +there is no output related to the wedges that do, or do not, exist. +.It Ic makewedges +Delete all wedges configured on the specified disk, and autodiscover +the wedges again. +Wedges that are in use are not deleted and conflicting +or overlapping wedges are not created. +You need to list wedges to find out what has changed. +.It Ic setcache Ar none | r | w | rw Op Ar save +Set the cache enables for the specified device. +The enables are as follows: +.Bl -tag -offset indent -width XsaveX +.It none +Disable all caches on the disk. +.It r +Enable the read cache, and disable all other caches on the disk. +.It w +Enable the write cache, and disable all other caches on the disk. +.It rw +Enable both the read and write caches on the disk. +.It save +If specified, and the cache enables are savable, saves the cache +enables in the disk's non-volatile parameter storage. +.El +.It Ic strategy Op Ar name +Get and set the disk I/O scheduler (buffer queue strategy) on the +drive. +If you do not provide a +.Ar name +argument, the currently selected strategy will be shown. +To set the bufq strategy, the +.Ar name +argument must be specified. +.Ar name +must be the name of one of the built-in kernel disk I/O schedulers. +To get the list of supported schedulers, use the following command: +.Bd -literal -offset indent +$ sysctl kern.bufq.strategies +.Ed +.It Ic synccache Op Ar force +Causes the cache on the disk to be synchronized, flushing all dirty +write cache blocks to the media. +If +.Ar force +is specified, the cache synchronization command will be issued even +if the kernel does not believe that there are any dirty cache blocks +in the disk's cache. +.El +.Pp +Note: The +.Ic addwedge +and +.Ic delwedge +commands only modify the in-kernel representation of disks; for +modifying information on the disks themselves, refer to +.Xr fdisk 8 +or +.Xr gpt 8 . +.Sh SEE ALSO +.Xr ioctl 2 , +.Xr dk 4 , +.Xr sd 4 , +.Xr wd 4 , +.Xr disklabel 5 , +.Xr atactl 8 , +.Xr fdisk 8 , +.Xr gpt 8 , +.Xr scsictl 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 1.6 . +.Sh AUTHORS +The +.Nm +command was written by +.An Jason R. Thorpe +of Wasabi Systems, Inc. diff --git a/static/netbsd/man8/dkscan_bsdlabel.8 b/static/netbsd/man8/dkscan_bsdlabel.8 new file mode 100644 index 00000000..4b544af6 --- /dev/null +++ b/static/netbsd/man8/dkscan_bsdlabel.8 @@ -0,0 +1,76 @@ +.\" $NetBSD: dkscan_bsdlabel.8,v 1.3 2021/11/10 17:19:29 msaitoh Exp $ +.\" +.\" Copyright (c) 2007 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Martin Husemann . +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 27, 2007 +.Dt DKSCAN_BSDLABEL 8 +.Os +.Sh NAME +.Nm dkscan_bsdlabel +.Nd program to create wedges from a BSD disklabel +.Sh SYNOPSIS +.Nm +.Op Fl nv +.Ar device +.Sh DESCRIPTION +.Nm +scans a disk for a BSD disklabel, which does not need to be the +label variant used on the architecture currently running, or even +the same endianness. +.Pp +The following options are supported: +.Bl -tag -width device -compact +.It Fl n +No execution - list the wedges, but do not create them. +.It Fl v +Be more verbose - print additional information. +.El +The argument +.Ar device +specifices the disk on which the disklabel is scanned and to which +the wedges are added. +.Sh EXAMPLES +.Dl Nm Fl v Ar wd1 +Create wedges from all recognized partitions on wd1 +.Sh SEE ALSO +.Xr dk 4 , +.Xr disklabel 5 , +.Xr dkctl 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 5.0 . +.Sh AUTHORS +.An -nosplit +.An Martin Huseman +wrote the +.Nm +utility. +It is reusing a lot of kernel code written by +.An Jason R. Thorpe . diff --git a/static/netbsd/man8/dm.8 b/static/netbsd/man8/dm.8 new file mode 100644 index 00000000..a30ec11d --- /dev/null +++ b/static/netbsd/man8/dm.8 @@ -0,0 +1,106 @@ +.\" $NetBSD: dm.8,v 1.9 2003/08/07 09:37:11 agc Exp $ +.\" +.\" Copyright (c) 1987, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)dm.8 8.1 (Berkeley) 5/31/93 +.\" +.Dd May 31, 1993 +.Dt DM 8 +.Os +.Sh NAME +.Nm dm +.Nd dungeon master +.Sh SYNOPSIS +.Nm ln +.Fl s Cm dm Ar game +.Sh DESCRIPTION +.Nm +is a program used to regulate game playing. +.Nm +expects to be invoked with the name of a game that a user wishes to play. +This is done by creating symbolic links to +.Nm , +in the directory +.Pa /usr/games +for all of the regulated games. +The actual binaries for these games should be placed in a +.Dq hidden +directory, +.Pa /usr/games/hide , +that may only be accessed by the +.Nm +program. +.Nm +determines if the requested game is available and, if so, runs it. +The file +.Pa /etc/dm.conf +controls the conditions under which games may be run. +.Pp +The file +.Pa /etc/nogames +may be used to +.Dq turn off +game playing. +If the file exists, no game playing is allowed; the contents of the file +will be displayed to any user requesting a game. +.Sh FILES +.Bl -tag -width /var/log/games.log -compact +.It Pa /etc/dm.conf +configuration file +.It Pa /etc/nogames +turns off game playing +.It Pa /usr/games/hide +directory of ``real'' binaries +.It Pa /var/log/games.log +game logging file +.El +.Sh SEE ALSO +.Xr dm.conf 5 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.3 tahoe . +.Sh SECURITY CONSIDERATIONS +Two issues result from +.Nm +running the games setgid +.Dq games . +First, all games that allow users to run +.Ux +commands should carefully +set both the real and effective group ids immediately before executing +those commands. +Probably more important is that +.Nm +never be setgid anything but +.Dq games +so that compromising a game will result only in +the user's ability to play games at will. +Secondly, games which previously had no reason to run setgid and which +accessed user files may have to be modified. diff --git a/static/netbsd/man8/dmctl.8 b/static/netbsd/man8/dmctl.8 new file mode 100644 index 00000000..b897f657 --- /dev/null +++ b/static/netbsd/man8/dmctl.8 @@ -0,0 +1,69 @@ +.\" $NetBSD: dmctl.8,v 1.5 2017/06/04 08:34:34 abhinav Exp $ +.\" +.\" Copyright (c) 2004,2009 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Adam Hamsik. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.Dd September 11, 2016 +.Dt DMCTL 8 +.Os +.Sh NAME +.Nm dmctl +.Nd manipulate device-mapper driver command +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +.Nm +works with the device-mapper kernel driver. +It can send and receive information and commands from the dm driver. +.Bl -column -offset indent "suspend" "Switch active and passive tables for" +.It Li version Ta Print driver and lib version. +.It Li targets Ta List available kernel targets. +.It Li create Ta Create device with [dm device name]. +.It Li ls Ta List existing dm devices. +.It Li info Ta Get info about device with [dm device name]. +.It Li rename Ta Rename device with [dm device name] to [dm device new name]. +.It Li remove Ta Remove device with [dm device name]. +.It Li resume Ta Resume IO on dm device [dm device name]. +.It Li suspend Ta Suspend IO on dm device [dm device name]. +.It Li deps Ta Print physical dependencies for dm device [dm device name]. +.It Li reload Ta Switch active and passive tables for [dm device name]. +.It Li status Ta Print status for device with [dm device name]. +.It Li table Ta Print active table for device with [dm device name]. +.El +.Sh SEE ALSO +.Xr dm 3 , +.Xr dm 4 +.Sh HISTORY +The +.Nm +utility appeared in +.Nx 6.0 . +.Sh AUTHORS +.Nm +was written and contributed to +.Nx +by +.An Adam Hamsik . diff --git a/static/netbsd/man8/dmesg.8 b/static/netbsd/man8/dmesg.8 new file mode 100644 index 00000000..f508d147 --- /dev/null +++ b/static/netbsd/man8/dmesg.8 @@ -0,0 +1,122 @@ +.\" $NetBSD: dmesg.8,v 1.26 2018/10/30 19:40:36 kre Exp $ +.\" +.\" Copyright (c) 1980, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)dmesg.8 8.1 (Berkeley) 6/5/93 +.\" +.Dd October 30, 2018 +.Dt DMESG 8 +.Os +.Sh NAME +.Nm dmesg +.Nd display the system message buffer +.Sh SYNOPSIS +.Nm +.Op Fl dTt +.Op Fl M Ar core +.Op Fl N Ar system +.Sh DESCRIPTION +.Nm +displays the contents of the system message buffer. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl d +Show the timestamp deltas. +Used together with +.Fl t +only the deltas are shown. +.It Fl M +Extract values associated with the name list from the specified core +instead of the default ``/dev/mem''. +.It Fl N +Extract the name list from the specified system instead of the default +``/netbsd''. +.It Fl T +Format uptime timestamps in a human readable form (using +.Xr ctime 3 ) +using output suitable for the local locale as set in the environment. +Repeating this option prints the uptime in ISO 8601 duration form, +giving the duration since boot, in hours, minutes, and seconds (to +millisecond resolution). +A third occurrence causes the duration to always be represented +to millisecond precision, even where that means trailing zeroes +appear. +.It Fl t +Quiet printing, don't print timestamps. +.El +.Pp +The system message buffer is a circular buffer of a fixed size. +If the buffer has been filled, the first line of the +.Nm +output may not be complete. +The size of the message buffer is configurable at compile-time on +most systems with the +.Dv MSGBUFSIZE +kernel option. +Look for +.Dv MSGBUFSIZE +in +.Xr options 4 +for details. +.Sh FILES +.Bl -tag -width /var/run/dmesg.boot -compact +.It Pa /var/run/dmesg.boot +copy of dmesg at the time of last boot. +.El +.Sh SEE ALSO +.Xr options 4 , +.Xr syslogd 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 3.0 . +.Sh BUGS +The +.Fl T +option will report nonsense when displaying lines from +the message buffer that were not added by the current +running kernel. +.Pp +When +.Fl TT +is used, the duration is always given with maximum units of hours, +even when the number of hours is in the hundreds, thousands, or more. +This is because converting hours to days, over periods when +.Dq time skips +occur, such as summer time beginning or ending, is not trivial. +A duration of 26 hours might be 1D3H or 1D1H at such events, +rather than the usual 1D2H, +and when a time zone alters its offset, +even more complex calculations are needed. +None of those calculations are done +.Pq even to account for sub-hour time zone shifts , +the duration indicated is always calculated by simple division of +seconds by 60 to produce minutes, and again to produce hours. +Most of the time\ [!] this is correct. diff --git a/static/netbsd/man8/dmesgfs.8 b/static/netbsd/man8/dmesgfs.8 new file mode 100644 index 00000000..9ad75459 --- /dev/null +++ b/static/netbsd/man8/dmesgfs.8 @@ -0,0 +1,96 @@ +.\" +.\" Copyright © 2007 Alistair Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd May 16, 2007 +.Dt DMESGFS 8 +.Os +.Sh NAME +.Nm dmesgfs +.Nd refuse-based virtual file system to display devices found in dmesg +.Sh SYNOPSIS +.Nm +.Op Fl f +.Op Fl l +.Op Fl n Ar nexus +.Op Fl v +.Ar mount_point +.Sh DESCRIPTION +The +.Nm +utility can be used to mount a virtual file system which +shows the tree of devices present in the computer. +This tree is found by using the output of the +.Xr dmesg 8 +command. +.Pp +The following arguments can be used: +.Bl -tag -width Ds +.It Fl f +present the attachment information in the virtual file system +as files. +.It Fl l +present the attachment information in the virtual file system +as symbolic links. +This is the default mode of operation. +.It Fl n Ar nexus +Use the nexus name +as the root of the device tree. +The default value for Nexus is +.Dq mainbus0 . +.It Fl v +Produce verbose output +.El +.Pp +The +.Nm +utility makes use of the +.Xr virtdir 3 +virtual directory routines. +.Pp +The +.Xr refuse 3 +library is used to provide the file system features. +.Pp +The mandatory parameter is +the local mount +point. +.Pp +The +.Xr dmesg 8 +utility is used to retrieve the information. +.Sh SEE ALSO +.Xr librefuse 3 , +.Xr puffs 3 , +.Xr virtdir 3 , +.Xr dmesg 8 . +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 5.0 . +.Sh AUTHORS +.An Alistair Crooks Aq Mt agc@NetBSD.org diff --git a/static/netbsd/man8/dmsetup.8 b/static/netbsd/man8/dmsetup.8 new file mode 100644 index 00000000..3cb413f0 --- /dev/null +++ b/static/netbsd/man8/dmsetup.8 @@ -0,0 +1,364 @@ +.\" $NetBSD: dmsetup.8,v 1.3 2016/06/09 09:01:21 abhinav Exp $ +.\" +.TH DMSETUP 8 "Apr 06 2006" "Linux" "MAINTENANCE COMMANDS" +.SH NAME +dmsetup \- low level logical volume management +.SH SYNOPSIS +.ad l +.B dmsetup help +.I [-c|-C|--columns] +.br +.B dmsetup create +.I device_name [-u uuid] [--notable | --table | table_file] +.br +.B dmsetup remove +.I [-f|--force] device_name +.br +.B dmsetup remove_all +.I [-f|--force] +.br +.B dmsetup suspend +.I [--nolockfs] [--noflush] device_name +.br +.B dmsetup resume +.I device_name +.br +.B dmsetup load +.I device_name [--table
| table_file] +.br +.B dmsetup clear +.I device_name +.br +.B dmsetup reload +.I device_name [--table
| table_file] +.br +.B dmsetup rename +.I device_name new_name +.br +.B dmsetup message +.I device_name sector message +.br +.B dmsetup ls +.I [--target target_type] [--exec command] [--tree [-o options]] +.br +.B dmsetup info +.I [device_name] +.br +.B dmsetup info -c|-C|--columns +.I [--noheadings] [--separator separator] [-o fields] [-O|--sort sort_fields] +.I [device_name] +.br +.B dmsetup deps +.I [device_name] +.br +.B dmsetup status +.I [--target target_type] +.I [device_name] +.br +.B dmsetup table +.I [--target target_type] +.I [device_name] +.br +.B dmsetup wait +.I device_name +.I [event_nr] +.br +.B dmsetup mknodes +.I [device_name] +.br +.B dmsetup targets +.br +.B dmsetup version +.br +.B dmsetup setgeometry +.I device_name cyl head sect start +.br + +.B devmap_name +.I major minor +.br +.B devmap_name +.I major:minor +.ad b +.SH DESCRIPTION +dmsetup manages logical devices that use the device-mapper driver. +Devices are created by loading a table that specifies a target for +each sector (512 bytes) in the logical device. + +The first argument to dmsetup is a command. +The second argument is the logical device name or uuid. + +Invoking the command as \fBdevmap_name\fP is equivalent to +.br +\fBdmsetup info -c --noheadings -j \fImajor\fB -m \fIminor\fP. +.SH OPTIONS +.IP \fB-c|-C|--columns +.br +Display output in columns rather than as Field: Value lines. +.IP \fB-j|--major\ \fImajor +.br +Specify the major number. +.IP \fB-m|--minor\ \fIminor +.br +Specify the minor number. +.IP \fB-n|--noheadings +.br +Suppress the headings line when using columnar output. +.IP \fB--noopencount +.br +Tell the kernel not to supply the open reference count for the device. +.IP \fB--notable +.br +When creating a device, don't load any table. +.IP \fB-o|--options +.br +Specify which fields to display. +.IP \fB-r|--readonly +.br +Set the table being loaded read-only. +.IP \fB--readahead\ [+]|auto|none +.br +Specify read ahead size in units of sectors. +The default value is "auto" which allows the kernel to choose +a suitable value automatically. The + prefix lets you +specify a minimum value which will not be used if it is +smaller than the value chosen by the kernel. +"None" is equivalent to specifying zero. +.IP \fB--table\
+.br +Specify a one-line table directly on the command line. +.IP \fB-u|--uuid +.br +Specify the uuid. +.IP \fB-v|--verbose\ [-v|--verbose] +.br +Produce additional output. +.IP \fB--version +.br +Display the library and kernel driver version. +.SH COMMANDS +.IP \fBcreate +.I device_name [-u uuid] [--notable | --table
| table_file] +.br +Creates a device with the given name. +If table_file or
is supplied, the table is loaded and made live. +Otherwise a table is read from standard input unless --notable is used. +The optional uuid can be used in place of +device_name in subsequent dmsetup commands. +If successful a device will appear as +/dev/device-mapper/. +See below for information on the table format. +.IP \fBdeps +.I [device_name] +.br +Outputs a list of (major, minor) pairs for devices referenced by the +live table for the specified device. +.IP \fBhelp +.I [-c|-C|--columns] +.br +Outputs a summary of the commands available, optionally including +the list of report fields. +.IP \fBinfo +.I [device_name] +.br +Outputs some brief information about the device in the form: +.br + State: SUSPENDED|ACTIVE, READ-ONLY +.br + Tables present: LIVE and/or INACTIVE +.br + Open reference count +.br + Last event sequence number (used by \fBwait\fP) +.br + Major and minor device number +.br + Number of targets in the live table +.br + UUID +.IP \fBinfo -c|-C|--columns +.I [--noheadings] [--separator separator] [-o fields] [-O|--sort sort_fields] +.I [device_name] +.br +Output you can customise. +Fields are comma-separated and chosen from the following list: +name, major, minor, attr, open, segments, events, uuid. +Attributes are: (L)ive, (I)nactive, (s)uspended, (r)ead-only, read-(w)rite. +Precede the list with '+' to append +to the default selection of columns instead of replacing it. +Precede any sort_field with - for a reverse sort on that column. +.IP \fBls +.I [--target target_type] +.I [--exec command] +.I [--tree [-o options]] +.br +List device names. Optionally only list devices that have at least +one target of the specified type. Optionally execute a command for +each device. The device name is appended to the supplied command. +--tree displays dependencies between devices as a tree. +It accepts a comma-separate list of options. +Some specify the information displayed against each node: +device/nodevice; active, open, rw, uuid. +Others specify how the tree is displayed: +ascii, utf, vt100; compact, inverted, notrunc. +.IP \fBload|reload +.I device_name [--table
| table_file] +.br +Loads
or table_file into the inactive table slot for device_name. +If neither is supplied, reads a table from standard input. +.IP \fBmessage +.I device_name sector message +.br +Send message to target. If sector not needed use 0. +.IP \fBmknodes +.I [device_name] +.br +Ensure that the node in /dev/mapper for device_name is correct. +If no device_name is supplied, ensure that all nodes in /dev/mapper +correspond to mapped devices currently loaded by the device-mapper kernel +driver, adding, changing or removing nodes as necessary. +.IP \fBremove +.I [-f|--force] device_name +.br +Removes a device. It will no longer be visible to dmsetup. +Open devices cannot be removed except with older kernels +that contain a version of device-mapper prior to 4.8.0. +In this case the device will be deleted when its open_count +drops to zero. From version 4.8.0 onwards, if a device can't +be removed because an uninterruptible process is waiting for +I/O to return from it, adding --force will replace the table +with one that fails all I/O, which might allow the +process to be killed. +.IP \fBremove_all +.I [-f|--force] +.br +Attempts to remove all device definitions i.e. reset the driver. +Use with care! From version 4.8.0 onwards, if devices can't +be removed because uninterruptible processes are waiting for +I/O to return from them, adding --force will replace the table +with one that fails all I/O, which might allow the +process to be killed. This also runs \fBmknodes\fP afterwards. +.IP \fBrename +.I device_name new_name +.br +Renames a device. +.IP \fBresume +.I device_name +.br +Un-suspends a device. +If an inactive table has been loaded, it becomes live. +Postponed I/O then gets re-queued for processing. +.IP \fBsetgeometry +.I device_name cyl head sect start +.br +Sets the device geometry to C/H/S. +.IP \fBstatus +.I [--target target_type] +.I [device_name] +.br +Outputs status information for each of the device's targets. +With --target, only information relating to the specified target type +is displayed. +.IP \fBsuspend +.I [--nolockfs] [--noflush] +.I device_name +.br +Suspends a device. Any I/O that has already been mapped by the device +but has not yet completed will be flushed. Any further I/O to that +device will be postponed for as long as the device is suspended. +If there's a filesystem on the device which supports the operation, +an attempt will be made to sync it first unless --nolockfs is specified. +Some targets such as recent (October 2006) versions of multipath may support +the --noflush option. This lets outstanding I/O that has not yet reached the +device to remain unflushed. +.IP \fBtable +.I [--target target_type] +.I [device_name] +.br +Outputs the current table for the device in a format that can be fed +back in using the create or load commands. +With --target, only information relating to the specified target type +is displayed. +.IP \fBtargets +.br +Displays the names and versions of the currently-loaded targets. +.IP \fBversion +.br +Outputs version information. +.IP \fBwait +.I device_name +.I [event_nr] +.br +Sleeps until the event counter for device_name exceeds event_nr. +Use -v to see the event number returned. +To wait until the next event is triggered, use \fBinfo\fP to find +the last event number. +.SH TABLE FORMAT +Each line of the table specifies a single target and is of the form: +.br + logical_start_sector num_sectors target_type target_args +.br +.br + +There are currently three simple target types available together +with more complex optional ones that implement snapshots and mirrors. + +.IP \fBlinear +.I destination_device start_sector +.br +The traditional linear mapping. + +.IP \fBstriped +.I num_stripes chunk_size [destination start_sector]+ +.br +Creates a striped area. +.br +e.g. striped 2 32 /dev/hda1 0 /dev/hdb1 0 +will map the first chunk (16k) as follows: +.br + LV chunk 1 -> hda1, chunk 1 +.br + LV chunk 2 -> hdb1, chunk 1 +.br + LV chunk 3 -> hda1, chunk 2 +.br + LV chunk 4 -> hdb1, chunk 2 +.br + etc. + +.IP \fBerror +.br +Errors any I/O that goes to this area. Useful for testing or +for creating devices with holes in them. + +.SH EXAMPLES + +# A table to join two disks together +.br +.br +0 1028160 linear /dev/hda 0 +.br +1028160 3903762 linear /dev/hdb 0 + + +# A table to stripe across the two disks, +.br +# and add the spare space from +.br +# hdb to the back of the volume + +0 2056320 striped 2 32 /dev/hda 0 /dev/hdb 0 +.br +2056320 2875602 linear /dev/hdb 1028160 + +.SH ENVIRONMENT VARIABLES +.TP +\fBDM_DEV_DIR\fP +The device directory name. +Defaults to "/dev" and must be an absolute path. + +.SH AUTHORS +Original version: Joe Thornber (thornber@sistina.com) + +.SH SEE ALSO +Device-mapper resource page: http://sources.redhat.com/dm/ diff --git a/static/netbsd/man8/dnsblog.8 b/static/netbsd/man8/dnsblog.8 new file mode 100644 index 00000000..f5389cb5 --- /dev/null +++ b/static/netbsd/man8/dnsblog.8 @@ -0,0 +1,111 @@ +.\" $NetBSD: dnsblog.8,v 1.5 2025/02/25 19:15:42 christos Exp $ +.\" +.TH DNSBLOG 8 +.ad +.fi +.SH NAME +dnsblog +\- +Postfix DNS allow/denylist logger +.SH "SYNOPSIS" +.na +.nf +\fBdnsblog\fR [generic Postfix daemon options] +.SH DESCRIPTION +.ad +.fi +The \fBdnsblog\fR(8) server implements an ad\-hoc DNS +allow/denylist lookup service. This may eventually be +replaced by an UDP client that is built directly into the +\fBpostscreen\fR(8) server. +.SH "PROTOCOL" +.na +.nf +.ad +.fi +With each connection, the \fBdnsblog\fR(8) server receives +a DNS allow/denylist domain name, an IP address, and an ID. +If the IP address is listed under the DNS allow/denylist, the +\fBdnsblog\fR(8) server logs the match and replies with the +query arguments plus an address list with the resulting IP +addresses, separated by whitespace, and the reply TTL. +Otherwise it replies with the query arguments plus an empty +address list and the reply TTL; the reply TTL is \-1 if there +is no reply, or a negative reply that contains no SOA record. +Finally, the \fBdnsblog\fR(8) server closes the connection. +.SH DIAGNOSTICS +.ad +.fi +Problems and transactions are logged to \fBsyslogd\fR(8) +or \fBpostlogd\fR(8). +.SH "CONFIGURATION PARAMETERS" +.na +.nf +.ad +.fi +Changes to \fBmain.cf\fR are picked up automatically, as +\fBdnsblog\fR(8) processes run for only a limited amount +of time. Use the command "\fBpostfix reload\fR" to speed +up a change. + +The text below provides only a parameter summary. See +\fBpostconf\fR(5) for more details including examples. +.IP "\fBconfig_directory (see 'postconf -d' output)\fR" +The default location of the Postfix main.cf and master.cf +configuration files. +.IP "\fBdaemon_timeout (18000s)\fR" +How much time a Postfix daemon process may take to handle a +request before it is terminated by a built\-in watchdog timer. +.IP "\fBpostscreen_dnsbl_sites (empty)\fR" +Optional list of patterns with DNS allow/denylist domains, filters +and weight +factors. +.IP "\fBipc_timeout (3600s)\fR" +The time limit for sending or receiving information over an internal +communication channel. +.IP "\fBprocess_id (read\-only)\fR" +The process ID of a Postfix command or daemon process. +.IP "\fBprocess_name (read\-only)\fR" +The process name of a Postfix command or daemon process. +.IP "\fBqueue_directory (see 'postconf -d' output)\fR" +The location of the Postfix top\-level queue directory. +.IP "\fBsyslog_facility (mail)\fR" +The syslog facility of Postfix logging. +.IP "\fBsyslog_name (see 'postconf -d' output)\fR" +A prefix that is prepended to the process name in syslog +records, so that, for example, "smtpd" becomes "prefix/smtpd". +.PP +Available in Postfix 3.3 and later: +.IP "\fBservice_name (read\-only)\fR" +The master.cf service name of a Postfix daemon process. +.SH "SEE ALSO" +.na +.nf +smtpd(8), Postfix SMTP server +postconf(5), configuration parameters +postlogd(8), Postfix logging +syslogd(8), system logging +.SH "LICENSE" +.na +.nf +.ad +.fi +The Secure Mailer license must be distributed with this software. +.SH HISTORY +.ad +.fi +.ad +.fi +This service was introduced with Postfix version 2.8. +.SH "AUTHOR(S)" +.na +.nf +Wietse Venema +IBM T.J. Watson Research +P.O. Box 704 +Yorktown Heights, NY 10598, USA + +Wietse Venema +Google, Inc. +111 8th Avenue +New York, NY 10011, USA diff --git a/static/netbsd/man8/dosboot.8 b/static/netbsd/man8/dosboot.8 new file mode 100644 index 00000000..90ad455f --- /dev/null +++ b/static/netbsd/man8/dosboot.8 @@ -0,0 +1,163 @@ +.\" $NetBSD: dosboot.8,v 1.4 2023/04/24 13:55:45 manu Exp $ +.\" +.\" Copyright (c) 1997 +.\" Matthias Drochner. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)boot_i386.8 8.2 (Berkeley) 4/19/94 +.\" +.Dd February 17, 2017 +.Dt DOSBOOT 8 x86 +.Os +.Sh NAME +.Nm dosboot +.Nd boot NetBSD/x86 from DOS +.Sh SYNOPSIS +.Nm +.Op Fl u +.Op Fl c Ar command +.Op Fl i +.Op Ar path Op Fl adqsv +.Sh DESCRIPTION +.Nm +is an +.Tn MS-DOS +program. +It is a boot loader for +.Nx Ns Tn /x86 +designed to permit +.Nx +to be booted directly from +.Tn MS-DOS . +By default, it boots a file with name +.Pa NETBSD +in the current +.Tn MS-DOS +directory. +.Nm +shares common code with the standard boot loader, +.Xr x86/boot 8 . +.Pp +The recognized options are: +.Bl -tag -width "-adqsv" -offset 04n +.It Fl c +Execute +.Ar command +(see below). +.It Fl i +Enter interactive mode. +.Nm +will present a prompt, allowing input of commands (see below). +.It Fl u +Boot from a UFS file system instead of an +.Tn MS-DOS +file system. +.It Ar path +Specifies the kernel file. +In +.Tn MS-DOS +mode (default) a normal +.Tn MS-DOS +filename (with or without drive specification) is accepted. +In UFS mode (after +.Fl u +or after a +.Ic mode ufs +command), a path in a +.Nx +file system is expected. +By default, the file is looked up in partition +.Sq a +of the first hard disk. +Another device or partition can be specified +by prepending a block device name in terms of +.Nx , +followed by a colon (see +.Xr x86/boot 8 +and examples). +.It Fl 1234abcdmqsvxz +Flags passed to the kernel, see +.Xr x86/boot 8 . +.El +.Pp +See +.Xr x86/boot 8 +for commands accepted after the +.Fl c +flag or in interactive mode. +.Pp +.Nm +is also installed in the +.Xr release 7 +hierarchy, under +.Pa installation/misc/dosboot.com . +.Sh FILES +.Pa /usr/mdec/dosboot.com +.Sh EXAMPLES +To boot a +.Nx +kernel located on +.Tn MS-DOS +drive D, one would issue: +.Bd -literal -offset indent +dosboot D:\eNODOS\eNETBSD +.Ed +.Pp +To boot from a +.Nx +floppy into single user mode, type e.g.: +.Bd -literal -offset indent +dosboot -u fd0a:netbsd -s +.Ed +.Sh SEE ALSO +.Xr release 7 , +.Xr x86/boot 8 +.Sh HISTORY +The +.Nx Ns Tn /x86 +.Nm +command first appeared in +.Nx 1.3 . +.Sh BUGS +.Nm +assumes that the processor is in real mode at startup. +It does not work well in the presence of +.Tn MS-DOS +extenders and memory managers. +.Pp +.Nm +does not run directly under +.Tn Windows 95 . +.Pp +In UFS mode, files can only be loaded from devices known to the BIOS. +The device names do not necessarily comply with the names later +used by the booted +.Nx +kernel. +.Pp +In +.Tn MS-DOS +mode, no useful boot device specification is passed to +.Nx . +It is necessary to have the root device hardwired into the kernel +configuration or to enter it manually. diff --git a/static/netbsd/man8/download-vulnerability-list.8 b/static/netbsd/man8/download-vulnerability-list.8 new file mode 100644 index 00000000..cbe9f423 --- /dev/null +++ b/static/netbsd/man8/download-vulnerability-list.8 @@ -0,0 +1,54 @@ +.\" $NetBSD: download-vulnerability-list.8,v 1.3 2021/04/10 19:49:59 nia Exp $ +.\" +.\" Copyright (c) 2010 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Thomas Klausner. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd March 18, 2010 +.Dt DOWNLOAD-VULNERABILITY-LIST 8 +.Os +.Sh NAME +.Nm download-vulnerability-list +.Nd download vulnerability list used for checking installed packages +.Sh SYNOPSIS +.Nm +.Op Fl hs +.Op Fl c Ar config_file +.Sh DESCRIPTION +.Nm +is deprecated. +Please use the +.Cm fetch-pkg-vulnerabilities +command of +.Xr pkg_admin 1 +instead. +.Pp +The +.Nm +script is installed for backwards compatibility only and will +eventually be removed. +.Sh SEE ALSO +.Xr pkg_admin 1 diff --git a/static/netbsd/man8/drtest.8 b/static/netbsd/man8/drtest.8 new file mode 100644 index 00000000..e67ddaa9 --- /dev/null +++ b/static/netbsd/man8/drtest.8 @@ -0,0 +1,112 @@ +.\" $NetBSD: drtest.8,v 1.16 2017/07/03 21:31:00 wiz Exp $ +.\" +.\" Copyright (c) 1983, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)drtest.8 8.1 (Berkeley) 6/5/93 +.\" +.Dd February 17, 2017 +.Dt DRTEST 8 vax +.Os +.Sh NAME +.Nm drtest +.Nd stand-alone disk test program +.Sh DESCRIPTION +.Nm +is a stand-alone program used to read a disk +track by track. +It was primarily intended as a test program +for new stand-alone drivers, but has shown +useful in other contexts as well, such as +verifying disks and running speed +tests. For example, when a disk has been formatted +(by +.Xr vax/format 8 ) , +you can check that +hard errors has been taken care of by running +.Nm . +No hard errors should be found, but in many cases +quite a few soft +.Tn ECC +errors will be reported. +.Pp +While +.Nm +is running, the cylinder number is printed on +the console for every 10th cylinder read. +.Sh EXAMPLES +A sample run of +.Nm +is shown below. +In this example (using a 750), +.Nm +is loaded from the root file system; +usually it +will be loaded from the machine's +console storage device. Boldface means user input. +As usual, ``#'' and ``@'' may be used to edit input. +.Pp +.Bd -unfilled -offset indent -compact +.Li \&>>> Ns Sy B/3 +.Li \&%% +.Li \&loading hk(0,0)boot +.Li \&Boot +.Li \&: Sy \&hk(0,0)drtest +.Li Test program for stand-alone up and hp driver +.Pp +.Li Debugging level (1=bse, 2=ecc, 3=bse+ecc)? +.Li Enter disk name [type(adapter,unit),\ e.g.\ hp(1,3)]? Sy hp(0,0) +.Li Device data: #cylinders=1024, #tracks=16, #sectors=32 +.Li Testing hp(0,0), chunk size is 16384 bytes. +.Em (chunk\ size\ is\ the\ number\ of\ bytes read per disk access) +.Li Start ...Make sure hp(0,0) is online +.Li \ ... +.Em (errors are reported as they occur) +.Li \ ... +.Em (...program restarts to allow checking other disks) +.Em (...to abort halt machine with \&^P) +.Ed +.Sh DIAGNOSTICS +The diagnostics are intended to be self explanatory. Note, however, that +the device number +in the diagnostic messages is identified as +.Em typeX +instead of +.Em type(a,u) +where +.Ar X +\&= a*8+u, e.g., hp(1,3) becomes hp11. +.Sh SEE ALSO +.Xr bad144 8 , +.Xr vax/format 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.2 . +.Sh AUTHORS +.An Helge Skrivervik diff --git a/static/netbsd/man8/drvctl.8 b/static/netbsd/man8/drvctl.8 new file mode 100644 index 00000000..536c27ce --- /dev/null +++ b/static/netbsd/man8/drvctl.8 @@ -0,0 +1,190 @@ +.\" $NetBSD: drvctl.8,v 1.20 2019/08/07 19:08:10 wiz Exp $ +.\" +.\" Copyright (c) 2004 +.\" Matthias Drochner. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd August 6, 2019 +.Dt DRVCTL 8 +.Os +.Sh NAME +.Nm drvctl +.Nd tool to rescan busses and detach devices on user request +.Sh SYNOPSIS +.Nm +.Fl r +.Op Fl a Ar attribute +.Ar busdevice +.Op locator ... +.Nm +.Fl d +.Ar device +.Nm +.Op Fl nt +.Fl l +.Op Ar device +.Nm +.Op Fl n +.Fl p +.Ar device +.Op Ar property ... +.Nm +.Fl Q +.Ar device +.Nm +.Fl R +.Ar device +.Nm +.Fl S +.Ar device +.Sh DESCRIPTION +The +.Nm +program works with the +.Xr drvctl 4 +pseudo-driver to allow the rescan of busses and to detach +drivers from devices. +.Pp +The following options are available: +.Bl -tag -width 123456 +.It Fl a +Give the interface attribute where children are to be +attached to (and which defines the interpretation of +the locator information). +This will only be needed in rare cases where the bus +has multiple attributes. +If there are multiple attributes, and one is not specified, +.Nm +will return an Invalid argument. +In such cases, the +.Fl p +option can be used to determine the available interface +attributes. +.It Fl d +Detach the device driver from the device given by the +.Ar device +argument. +.It Fl l +List the children of the device specified by the +.Ar device +argument. +If +.Ar device +is not specified, list roots of the device tree instead. +Output comes in two columns. +The first column is +.Ar device , +or +.Dq root +if +.Ar device +is not specified. +The second column is the child. +.It Fl n +Suppress first column in +.Fl l +output. +Suppress non-XML headers in +.Fl p +output. +.It Fl p +Get properties for the device specified by the +.Ar device +argument. +If +.Ar property +is specified, the value of that property is printed, otherwise +the properties are displayed as an XML property list. +The property can be given as a path of dictionary keys and numeric +array indexes separated by slashes. +.It Fl Q +Resume the ancestors of +.Ar device , +.Ar device +itself, and all of its descendants. +.It Fl R +Resume both the ancestors of +.Ar device +and +.Ar device +itself. +.It Fl r +Rescan the bus given by the +.Ar busdevice +argument. +The scan range can be restricted by an optional +.Ar locator +list. +.It Fl S +Suspend both the descendants of +.Ar device +and +.Ar device +itself. +.It Fl t +Print a tree of devices in +.Fl l +output. +.El +.Sh FILES +.Pa /dev/drvctl +.Sh EXAMPLES +To scan for IDE/SATA/eSATA disks on +.Pa atabus1 , +which need to use the +.Qq ata_hl +attribute: +.Bd -literal -offset indent +# drvctl -r -a ata_hl atabus1 +.Ed +.Pp +To scan for devices on a USB hub +.Pa uhub3 , +that have not been discovered by normal methods (or were detached +with the +.Fl d +option for +.Nm ) , +need to use the +.Qq usbifif +or +.Qq usbdevif +attributes, try one or both of these: +.Bd -literal -offset indent +# drvctl -r -a usbifif uhub3 +# drvctl -r -a usbdevif uhub3 +.Ed +.Sh SEE ALSO +.Xr proplib 3 , +.Xr drvctl 4 , +.Xr autoconf 9 +.Sh HISTORY +A +.Nm +utility appeard in +.Nx 4.0 . +.Sh BUGS +Currently, there is no good way to get information about locator +lengths and default values (which is present at kernel configuration +time) out of a running kernel. +Thus the locator handling is less intelligent than it could be. diff --git a/static/netbsd/man8/dump.8 b/static/netbsd/man8/dump.8 new file mode 100644 index 00000000..40b24857 --- /dev/null +++ b/static/netbsd/man8/dump.8 @@ -0,0 +1,608 @@ +.\" $NetBSD: dump.8,v 1.72 2019/08/19 18:12:50 perseant Exp $ +.\" +.\" Copyright (c) 1980, 1991, 1993 +.\" Regents of the University of California. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)dump.8 8.3 (Berkeley) 5/1/95 +.\" +.Dd March 25, 2019 +.Dt DUMP 8 +.Os +.Sh NAME +.Nm dump , +.Nm rdump +.Nd file system backup +.Sh SYNOPSIS +.Nm +.Op Fl 0123456789aceFinStuX +.Op Fl B Ar records +.Op Fl b Ar blocksize +.Op Fl D Ar dumpdates-file +.Op Fl d Ar density +.Op Fl f Ar file +.Op Fl h Ar level +.Op Fl k Ar read-blocksize +.Op Fl L Ar label +.Op Fl l Ar timeout +.Op Fl r Ar cachesize +.Op Fl s Ar feet +.Op Fl T Ar date +.Op Fl U Ar dumpdev +.Op Fl x Ar snap-backup +.Ar files-to-dump +.Nm +.Op Fl W Li \&| Fl w +.Pp +.in -\n[indent-synopsis]u +.Pf ( Bx 4.3 +option syntax is implemented for backward compatibility, but +not documented here.) +.Sh DESCRIPTION +.Nm +examines files on a file system and determines which files need to +be backed up. +These files are copied to the given disk, tape or other storage +medium for safe keeping (see the +.Fl f +option below for doing remote backups). +A dump that is larger than the output medium is broken into +multiple volumes. +On most media the size is determined by writing until an +end-of-media indication is returned. +This can be enforced by using the +.Fl a +option. +.Pp +On media that cannot reliably return an end-of-media indication +(such as some cartridge tape drives) each volume is of a fixed size; +the actual size is determined by the tape size and density and/or +block count options below. +By default, the same output file name is used for each volume +after prompting the operator to change media. +.Pp +.Ar files-to-dump +is either a single file system, +or a list of files and directories on a single file system to be backed +up as a subset of the file system. +In the former case, +.Ar files-to-dump +may be the device of a file system, +the path to a currently mounted file system, +the path to an unmounted file system listed in +.Pa /etc/fstab , +or, if +.Fl F +is given, a file system image. +In the latter case, certain restrictions are placed on the backup: +.Fl u +is ignored, the only dump level that is supported is +.Fl 0 , +and all of the files must reside on the same file system. +.Pp +Any files with the superuser +.Qq log +flag +.Pq Dv SF_LOG +set will be skipped. +These files are assumed to be +.Xr wapbl 4 +journal files and will not be backed up. +.Pp +The following options are supported by +.Nm : +.Bl -tag -width Ds +.It Fl 0\-9 +Dump levels. +A level 0, full backup, guarantees the entire file system is copied +(but see also the +.Fl h +option below). +A level number above 0, incremental backup, +tells dump to copy all files new or modified since the +last dump of a lower level (but see also the +.Fl i +option below). +The default level is 9. +.It Fl a +.Dq auto-size . +Bypass all tape length considerations, and enforce writing +until an end-of-media indication is returned. +This fits best for most modern tape drives. +Use of this option is particularly recommended when appending to an +existing tape, or using a tape drive with hardware compression (where +you can never be sure about the compression ratio). +.It Fl B Ar records +The number of kilobytes per volume, rounded +down to a multiple of the blocksize. +This option overrides the calculation of tape size +based on length and density. +.It Fl b Ar blocksize +The number of kilobytes per dump record. +.It Fl c +Modify the calculation of the default density and tape size to be more +appropriate for cartridge tapes. +.It Fl D Ar dumpdates-file +Use the given file as a record of dump dates instead of +.Pa /etc/dumpdates . +.It Fl d Ar density +Set tape density to +.Ar density . +The default is 1600 Bits Per Inch (BPI). +.It Fl e +Eject tape automatically if a tape change is required. +.It Fl F +Indicates that +.Ar files-to-dump +is a file system image. +.It Fl f Ar file +Write the backup to +.Ar file ; +.Ar file +may be a special device file like +.Pa /dev/rst0 +(a tape drive), +.Pa /dev/rsd1c +(a disk drive), +an ordinary file, or +.Ql Fl +(the standard output). +Multiple file names may be given as a single argument separated by commas. +Each file will be used for one dump volume in the order listed; +if the dump requires more volumes than the number of names given, +the last file name will be used for all remaining volumes after prompting +for media changes. +If the name of the file is of the form +.Qq host:file , +or +.Qq user@host:file , +.Nm +writes to the named file on the remote host using +.Xr rmt 8 . +Note that methods more secure than +.Xr rsh 1 +.Pq such as Xr ssh 1 +can be used to invoke +.Xr rmt 8 +on the remote host, via the environment variable +.Ev RCMD_CMD . +See +.Xr rcmd 3 +for more details. +.It Fl h Ar level +Honor the user +.Qq nodump +flag +.Pq Dv UF_NODUMP +only for dumps at or above the given +.Ar level . +The default honor level is 1, +so that incremental backups omit such files +but full backups retain them. +.It Fl i +The dump is treated as level 9 but takes into account a previous +level 9, if one exists. +This makes it possible to perform a +.Dq true incremental +dump. +.It Fl k Ar read-blocksize +The size in kilobytes of the read buffers, rounded up to a multiple of the +file system block size. +Default is the value of the +.Xr sysctl 7 +kern.maxphys. +.It Fl L Ar label +The user-supplied text string +.Ar label +is placed into the dump header, where tools like +.Xr restore 8 +and +.Xr file 1 +can access it. +Note that this label is limited to be at most LBLSIZE +(currently 16) characters, which must include the terminating +.Ql \e0 . +.It Fl l Ar timeout +If a tape change is required, eject the tape and wait for the drive to +be ready again. +This is to be used with tape changers which automatically load +the next tape when the tape is ejected. +If after the timeout (in seconds) the drive is not ready +.Nm +falls back to the default behavior, +and prompts the operator for the next tape. +.It Fl n +Whenever +.Nm +requires operator attention, +notify all operators in the group +.Qq operator +using +.Xr wall 1 . +.It Fl r Ar cachesize +Use that many buffers for read cache operations. +A value of zero disables the read cache altogether, higher values +improve read performance by reading larger data blocks from the +disk and maintaining them in an LRU cache. +See the +.Fl k +option for the size of the buffers. +Maximum is 512, the size of the cache is +limited to 15% of the avail RAM by default. +.It Fl S +Display an estimate of the backup size and the number of tapes +required, and exit without actually performing the dump. +.It Fl s Ar feet +Attempt to calculate the amount of tape needed +at a particular density. +If this amount is exceeded, +.Nm +prompts for a new tape. +It is recommended to be a bit conservative on this option. +The default tape length is 2300 feet. +.It Fl T Ar date +Use the specified date as the starting time for the dump +instead of the time determined from looking in +.Pa /etc/dumpdates . +The format of +.Ar date +is the same as that of +.Xr ctime 3 . +This option is useful for automated dump scripts that wish to +dump over a specific period of time. +The +.Fl T +option and the +.Fl u +option are mutually exclusive. +.It Fl t +All informational log messages printed by +.Nm +will have the time prepended to them. +Also, the completion time interval estimations +will have the estimated time at which the dump +will complete printed at the end of the line. +.It Fl u +Update the file +.Pa /etc/dumpdates +after a successful dump. +The format of +.Pa /etc/dumpdates +is readable by people, consisting of one +free format record per line: +file system name, +increment level +and +.Xr ctime 3 +format dump date. +There may be only one entry per file system at each level. +The file +.Pa /etc/dumpdates +may be edited to change any of the fields, +if necessary. +If the +.Fl T +option is used or if a list of files or subdirectories is being dumped +(as opposed to an entire file system), then +.Fl u +is ignored. +.It Fl U Ar dumpdev +Same as +.Fl u +but specifies the device in +.Pa /etc/dumpdates +as +.Ar dumpdev . +This option can be used with subdir dumps and with the +.Fl T +option. +.It Fl W +.Nm +tells the operator what file systems need to be dumped. +This information is gleaned from the files +.Pa /etc/dumpdates +and +.Pa /etc/fstab . +The +.Fl W +option causes +.Nm +to print out, for each file system in +.Pa /etc/dumpdates +the most recent dump date and level, +and highlights those file systems that should be dumped. +If the +.Fl W +option is set, all other options are ignored, and +.Nm +exits immediately. +.It Fl w +Like +.Fl W , +but prints only those file systems which need to be dumped. +.It Fl X +Similar to +.Fl x +but uses a file system internal snapshot on the file system to be dumped. +.It Fl x Ar snap-backup +Use a snapshot with +.Ar snap-backup +as backup for this dump. +See +.Xr fss 4 +for more details. +.El +.Pp +If +.Nm +honors the +.Qq nodump +flag +.Pq Dv UF_NODUMP , +files with the +.Qq nodump +flag will not be backed up. +If a directory has the +.Qq nodump +flag, this directory and any file or directory under it will not be backed up. +.Pp +.Nm +requires operator intervention on these conditions: +end of tape, +end of dump, +tape write error, +tape open error or +disk read error (if there are more than a threshold of 32). +In addition to alerting all operators implied by the +.Fl n +option, +.Nm +interacts with the operator on +.Nm Ns 's +control terminal at times when +.Nm +can no longer proceed, +or if something is grossly wrong. +All questions +.Nm +poses +.Em must +be answered by typing +.Qq yes +or +.Qq no , +appropriately. +.Pp +Since making a dump involves a lot of time and effort for full dumps, +.Nm +checkpoints itself at the start of each tape volume. +If writing that volume fails for some reason, +.Nm +will, +with operator permission, +restart itself from the checkpoint +after the old tape has been rewound and removed, +and a new tape has been mounted. +.Pp +.Nm +tells the operator what is going on at periodic intervals, +including usually low estimates of the number of blocks to write, +the number of tapes it will take, the time to completion, and +the time to the tape change. +The output is verbose, +so that others know that the terminal +controlling +.Nm +is busy, +and will be for some time. +.Pp +In the event of a catastrophic disk event, the time required +to restore all the necessary backup tapes or files to disk +can be kept to a minimum by staggering the incremental dumps. +An efficient method of staggering incremental dumps +to minimize the number of tapes follows: +.Bl -bullet -offset indent +.It +Always start with a level 0 backup, for example: +.Bd -literal -offset indent +/sbin/dump -0u -f /dev/nrst1 /usr/src +.Ed +.Pp +This should be done at set intervals, say once a month or once every two months, +and on a set of fresh tapes that is saved forever. +.It +After a level 0, dumps of active file +systems are taken on a daily basis, +using a modified Tower of Hanoi algorithm, +with this sequence of dump levels: +.Bd -literal -offset indent +3 2 5 4 7 6 9 8 9 9 ... +.Ed +.Pp +For the daily dumps, it should be possible to use a fixed number of tapes +for each day, used on a weekly basis. +Each week, a level 1 dump is taken, and +the daily Hanoi sequence repeats beginning with 3. +For weekly dumps, another fixed set of tapes per dumped file system is +used, also on a cyclical basis. +.El +.Pp +After several months or so, the daily and weekly tapes should get +rotated out of the dump cycle and fresh tapes brought in. +.Pp +If +.Nm +receives a +.Dv SIGINFO +signal +(see the +.Qq status +argument of +.Xr stty 1 ) +whilst a backup is in progress, statistics on the amount completed, +current transfer rate, and estimated finished time, will be written +to the standard error output. +.Pp +The historic alternate name +.Nm rdump +was once required when dumping to a remote host. +This functionality is now built into +.Nm +itself. +.Sh ENVIRONMENT +If the following environment variables exist, they are used by +.Nm . +.Bl -tag -width Fl +.It Ev TAPE +If no -f option was specified, +.Nm +will use the device specified via +.Ev TAPE +as the dump device. +.Ev TAPE +may be of the form +.Qq tapename , +.Qq host:tapename , +or +.Qq user@host:tapename . +.It Ev RCMD_CMD +.Nm +will use +.Ev RCMD_CMD +rather than +.Xr rsh 1 +to invoke +.Xr rmt 8 +on the remote machine. +.It Ev TIMEFORMAT +can be used to control the format of the timestamps produced by the +.Fl t +option. +.Ev TIMEFORMAT +is a string containing embedded formatting commands for +.Xr strftime 3 . +The total formatted string is limited to about 80 characters, if this +limit is exceeded then +.Qo +ERROR: TIMEFORMAT too long, reverting to default +.Qc +will be printed and the time format will revert to the default one. +If +.Ev TIMEFORMAT +is not set then the format string defaults to +.Qo +%T %Z +.Qc +.El +.Sh FILES +.Bl -tag -width /etc/dumpdates -compact +.It Pa /dev/nrst0 +default tape unit to use. +Taken from +.Dv _PATH_DEFTAPE +in +.Pa /usr/include/paths.h . +.It Pa /dev/rst* +raw SCSI tape interface +.It Pa /etc/dumpdates +dump date records +.It Pa /etc/fstab +dump table: file systems and frequency +.It Pa /etc/group +to find group +.Em operator +.El +.Sh DIAGNOSTICS +Many, and verbose. +.Pp +.Nm +exits with zero status on success. +Startup errors are indicated with an exit code of 1; +abnormal termination is indicated with an exit code of 3. +.Sh SEE ALSO +.Xr chflags 1 , +.Xr rcmd 1 , +.Xr stty 1 , +.Xr wall 1 , +.Xr fts 3 , +.Xr rcmd 3 , +.Xr fss 4 , +.Xr st 4 , +.Xr fstab 5 , +.Xr environ 7 , +.Xr restore 8 , +.Xr rmt 8 +.Sh HISTORY +A +.Nm +command appeared in +.At v4 . +.Pp +The +.Fl i +flag was inspired by the +.Fl x +flag from Sun's Solstice Backup utility. +.Sh BUGS +At least the following caveats can be mentioned. +.Bl -bullet +.It +Fewer than 32 read errors on the file system are ignored. +.It +Each reel requires a new process, so parent processes for +reels already written just hang around until the entire tape +is written. +.It +.Nm +with the +.Fl W +or +.Fl w +options does not report file systems that have never been recorded +in +.Pa /etc/dumpdates , +even if listed in +.Pa /etc/fstab . +.It +When dumping a list of files or subdirectories, access privileges are +required to scan the directory (as this is done via the +.Xr fts 3 +routines rather than directly accessing the file system). +.It +It would be nice if +.Nm +knew about the dump sequence, +kept track of the tapes scribbled on, +told the operator which tape to mount when, +and provided more assistance +for the operator running +.Xr restore 8 . +.It +Snapshot support is +.Em experimental . +Be sure you have a backup before you use it. +.El diff --git a/static/netbsd/man8/dump_lfs.8 b/static/netbsd/man8/dump_lfs.8 new file mode 100644 index 00000000..b7ebf909 --- /dev/null +++ b/static/netbsd/man8/dump_lfs.8 @@ -0,0 +1,566 @@ +.\" $NetBSD: dump_lfs.8,v 1.19 2019/03/25 07:03:58 wiz Exp $ +.\" +.\" Copyright (c) 1980, 1991, 1993 +.\" Regents of the University of California. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)dump.8 8.3 (Berkeley) 5/1/95 +.\" +.Dd March 25, 2019 +.Dt DUMP_LFS 8 +.Os +.Sh NAME +.Nm dump_lfs , +.Nm rdump_lfs +.Nd file system backup +.Sh SYNOPSIS +.Nm +.Op Fl 0123456789aceFnStuX +.Op Fl B Ar records +.Op Fl b Ar blocksize +.Op Fl d Ar density +.Op Fl f Ar file +.Op Fl h Ar level +.Op Fl k Ar read-blocksize +.Op Fl L Ar label +.Op Fl l Ar timeout +.Op Fl r Ar cachesize +.Op Fl s Ar feet +.Op Fl T Ar date +.Op Fl U Ar dumpdev +.Op Fl x Ar snap-backup +.Ar files-to-dump +.Nm +.Op Fl W Li \&| Fl w +.Pp +.in -\n[indent-synopsis]u +(The +.Bx 4.3 +option syntax is implemented for backward compatibility, but +is not documented here). +.Sh DESCRIPTION +.Nm +examines files on a file system and determines which files need to +be backed up. +These files are copied to the given disk, tape or other storage +medium for safe keeping (see the +.Fl f +option below for doing remote backups). +A dump that is larger than the output medium is broken into +multiple volumes. +On most media the size is determined by writing until an +end-of-media indication is returned. +This can be enforced by using the +.Fl a +option. +.Pp +On media that cannot reliably return an end-of-media indication +(such as some cartridge tape drives) each volume is of a fixed size; +the actual size is determined by the tape size and density and/or +block count options below. +By default, the same output file name is used for each volume +after prompting the operator to change media. +.Pp +.Ar files-to-dump +is either a single file system, +or a list of files and directories on a single file system to be backed +up as a subset of the file system. +In the former case, +.Ar files-to-dump +may be the device of a file system, +the path to a currently mounted file system, +the path to an unmounted file system listed in +.Pa /etc/fstab , +or, if +.Fl F +is given, a file system image. +In the latter case, certain restrictions are placed on the backup: +.Fl u +is ignored, the only dump level that is supported is +.Fl 0 , +and all of the files must reside on the same file system. +.Pp +The following options are supported by +.Nm : +.Bl -tag -width Ds +.It Fl 0\-9 +Dump levels. +A level 0, full backup, guarantees the entire file system is copied +(but see also the +.Fl h +option below). +A level number above 0, incremental backup, +tells dump to copy all files new or modified since the +last dump of a lower level. +The default level is 9. +.It Fl a +.Dq auto-size . +Bypass all tape length considerations, and enforce writing +until an end-of-media indication is returned. +This fits best for most modern tape drives. +Use of this option is particularly recommended when appending to an +existing tape, or using a tape drive with hardware compression (where +you can never be sure about the compression ratio). +.It Fl B Ar records +The number of kilobytes per volume, rounded +down to a multiple of the blocksize. +This option overrides the calculation of tape size +based on length and density. +.It Fl b Ar blocksize +The number of kilobytes per dump record. +.It Fl c +Modify the calculation of the default density and tape size to be more +appropriate for cartridge tapes. +.It Fl d Ar density +Set tape density to +.Ar density . +The default is 1600 Bits Per Inch (BPI). +.It Fl e +Eject tape automatically if a tape change is required. +.It Fl F +Indicates that +.Ar files-to-dump +is a file system image. +.It Fl f Ar file +Write the backup to +.Ar file ; +.Ar file +may be a special device file like +.Pa /dev/rst0 +(a tape drive), +.Pa /dev/rsd1c +(a disk drive), +an ordinary file, or +.Ql Fl +(the standard output). +Multiple file names may be given as a single argument separated by commas. +Each file will be used for one dump volume in the order listed; +if the dump requires more volumes than the number of names given, +the last file name will used for all remaining volumes after prompting +for media changes. +If the name of the file is of the form +.Qq host:file , +or +.Qq user@host:file , +.Nm +writes to the named file on the remote host using +.Xr rmt 8 . +Note that methods more secure than +.Xr rsh 1 +.Pq such as Xr ssh 1 +can be used to invoke +.Xr rmt 8 +on the remote host, via the environment variable +.Ev RCMD_CMD . +See +.Xr rcmd 3 +for more details. +.It Fl h Ar level +Honor the user +.Qq nodump +flag +.Pq Dv UF_NODUMP +only for dumps at or above the given +.Ar level . +The default honor level is 1, +so that incremental backups omit such files +but full backups retain them. +.It Fl k Ar read-blocksize +The size in kilobyte of the read buffers, rounded up to a multiple of the +file system block size. +Default is 32k. +.It Fl l Ar timeout +If a tape change is required, eject the tape and wait for the drive to +be ready again. +This is to be used with tape changers which automatically load +the next tape when the tape is ejected. +If after the timeout (in seconds) the drive is not ready +.Nm +falls back to the default behavior, +and prompts the operator for the next tape. +.It Fl L Ar label +The user-supplied text string +.Ar label +is placed into the dump header, where tools like +.Xr restore 8 +and +.Xr file 1 +can access it. +Note that this label is limited to be at most +.Dv LBLSIZE +(currently 16) characters, which must include the terminating +.Ql \e0 . +.It Fl n +Whenever +.Nm +requires operator attention, +notify all operators in the group +.Qq operator +using +.Xr wall 1 . +.It Fl r Ar cachesize +Use that many buffers for read cache operations. +A value of zero disables the read cache altogether, higher values +improve read performance by reading larger data blocks from the +disk and maintaining them in an LRU cache. +See the +.Fl k +option for the size of the buffers. +Maximum is 512, the size of the cache is +limited to 15% of the avail RAM by default. +.It Fl s Ar feet +Attempt to calculate the amount of tape needed +at a particular density. +If this amount is exceeded, +.Nm +prompts for a new tape. +It is recommended to be a bit conservative on this option. +The default tape length is 2300 feet. +.It Fl S +Display an estimate of the backup size and the number of tapes +required, and exit without actually performing the dump. +.It Fl t +All informational log messages printed by +.Nm +will have the time prepended to them. +Also, the completion time interval estimations +will have the estimated time at which the dump +will complete printed at the end of the line. +.It Fl T Ar date +Use the specified date as the starting time for the dump +instead of the time determined from looking in +.Pa /etc/dumpdates . +The format of date is the same as that of +.Xr ctime 3 . +This option is useful for automated dump scripts that wish to +dump over a specific period of time. +The +.Fl T +option is mutually exclusive from the +.Fl u +option. +.It Fl u +Update the file +.Pa /etc/dumpdates +after a successful dump. +The format of +.Pa /etc/dumpdates +is readable by people, consisting of one +free format record per line: +file system name, +increment level +and +.Xr ctime 3 +format dump date. +There may be only one entry per file system at each level. +The file +.Pa /etc/dumpdates +may be edited to change any of the fields, +if necessary. +If the +.Fl T +option is used or if a list of files or subdirectories is being dumped +(as opposed to an entire file system), then +.Fl u +is ignored. +.It Fl U Ar dumpdev +Same as +.Fl u +but specifies the device in +.Pa /etc/dumpdates +as +.Ar dumpdev . +This option can be used with subdir dumps and with the +.Fl T +option. +.It Fl X +Prevent the log from wrapping until the dump completes, guaranteeing +a consistent backup. +Processes that write to the file system will continue as usual +until the entire log is full, after which they will block +until the dump is complete. +This functionality is analogous to what +.Xr fss 4 +provides for other file systems. +The +.Fl x +flag is provided for compatibility with +.Xr dump 8 ; +it functions exactly as the +.Fl X +flag does (its argument is ignored). +.It Fl W +.Nm +tells the operator what file systems need to be dumped. +This information is gleaned from the files +.Pa /etc/dumpdates +and +.Pa /etc/fstab . +The +.Fl W +option causes +.Nm +to print out, for each file system in +.Pa /etc/dumpdates +the most recent dump date and level, +and highlights those file systems that should be dumped. +If the +.Fl W +option is set, all other options are ignored, and +.Nm +exits immediately. +.It Fl w +Is like W, but prints only those file systems which need to be dumped. +.El +.Pp +If +.Nm +honors the +.Qq nodump +flag +.Pq Dv UF_NODUMP , +files with the +.Qq nodump +flag will not be backed up. +If a directory has the +.Qq nodump +flag, this directory and any file or directory under it will not be backed up. +.Pp +.Nm +requires operator intervention on these conditions: +end of tape, +end of dump, +tape write error, +tape open error or +disk read error (if there are more than a threshold of 32). +In addition to alerting all operators implied by the +.Fl n +option, +.Nm +interacts with the operator on +.Nm Ns 's +control terminal at times when +.Nm +can no longer proceed, +or if something is grossly wrong. +All questions +.Nm +poses +.Em must +be answered by typing +.Qq yes +or +.Qq no , +appropriately. +.Pp +Since making a dump involves a lot of time and effort for full dumps, +.Nm +checkpoints itself at the start of each tape volume. +If writing that volume fails for some reason, +.Nm +will, +with operator permission, +restart itself from the checkpoint +after the old tape has been rewound and removed, +and a new tape has been mounted. +.Pp +.Nm +tells the operator what is going on at periodic intervals, +including usually low estimates of the number of blocks to write, +the number of tapes it will take, the time to completion, and +the time to the tape change. +The output is verbose, +so that others know that the terminal +controlling +.Nm +is busy, +and will be for some time. +.Pp +In the event of a catastrophic disk event, the time required +to restore all the necessary backup tapes or files to disk +can be kept to a minimum by staggering the incremental dumps. +An efficient method of staggering incremental dumps +to minimize the number of tapes follows: +.Bl -bullet -offset indent +.It +Always start with a level 0 backup, for example: +.Bd -literal -offset indent +/sbin/dump -0u -f /dev/nrst1 /usr/src +.Ed +.Pp +This should be done at set intervals, say once a month or once every two months, +and on a set of fresh tapes that is saved forever. +.It +After a level 0, dumps of active file +systems are taken on a daily basis, +using a modified Tower of Hanoi algorithm, +with this sequence of dump levels: +.Bd -literal -offset indent +3 2 5 4 7 6 9 8 9 9 ... +.Ed +.Pp +For the daily dumps, it should be possible to use a fixed number of tapes +for each day, used on a weekly basis. +Each week, a level 1 dump is taken, and +the daily Hanoi sequence repeats beginning with 3. +For weekly dumps, another fixed set of tapes per dumped file system is +used, also on a cyclical basis. +.El +.Pp +After several months or so, the daily and weekly tapes should get +rotated out of the dump cycle and fresh tapes brought in. +.Pp +If +.Nm +receives a +.Dv SIGINFO +signal +(see the +.Qq status +argument of +.Xr stty 1 ) +whilst a backup is in progress, statistics on the amount completed, +current transfer rate, and estimated finished time, will be written +to the standard error output. +.Sh ENVIRONMENT +If the following environment variables exist, they are used by +.Nm . +.Bl -tag -width Fl +.It Ev TAPE +If no -f option was specified, +.Nm +will use the device specified via +.Ev TAPE +as the dump device. +.Ev TAPE +may be of the form +.Qq tapename , +.Qq host:tapename , +or +.Qq user@host:tapename . +.It Ev RCMD_CMD +.Nm +will use +.Ev RCMD_CMD +rather than +.Xr rsh 1 +to invoke +.Xr rmt 8 +on the remote machine. +.It Ev TIMEFORMAT +can be used to control the format of the timestamps produced by the +.Fl t +option. +.Ev TIMEFORMAT +is a string containing embedded formatting commands for +.Xr strftime 3 . +The total formatted string is limited to about 80 characters, if this +limit is exceeded then +.Qo +ERROR: TIMEFORMAT too long, reverting to default +.Qc +will be printed and the time format will revert to the default one. +If +.Ev TIMEFORMAT +is not set then the format string defaults to +.Qo +%T %Z +.Qc +.El +.Sh FILES +.Bl -tag -width /etc/dumpdates -compact +.It Pa /dev/nrst0 +default tape unit to use. +Taken from +.Dv _PATH_DEFTAPE +in +.Pa /usr/include/paths.h . +.It Pa /dev/rst* +raw SCSI tape interface +.It Pa /etc/dumpdates +dump date records +.It Pa /etc/fstab +dump table: file systems and frequency +.It Pa /etc/group +to find group +.Em operator +.El +.Sh DIAGNOSTICS +Many, and verbose. +.Pp +.Nm +exits with zero status on success. +Startup errors are indicated with an exit code of 1; +abnormal termination is indicated with an exit code of 3. +.Sh SEE ALSO +.Xr chflags 1 , +.Xr rcmd 1 , +.Xr stty 1 , +.Xr wall 1 , +.Xr fts 3 , +.Xr rcmd 3 , +.Xr st 4 , +.Xr fstab 5 , +.Xr environ 7 , +.Xr restore 8 , +.Xr rmt 8 +.Sh HISTORY +A +.Nm +command appeared in +.Nx 1.5 . +.Sh BUGS +Fewer than 32 read errors on the file system are ignored. +.Pp +Each reel requires a new process, so parent processes for +reels already written just hang around until the entire tape +is written. +.Pp +.Nm +with the +.Fl W +or +.Fl w +options does not report file systems that have never been recorded +in +.Pa /etc/dumpdates , +even if listed in +.Pa /etc/fstab . +.Pp +When dumping a list of files or subdirectories, access privileges are +required to scan the directory (as this is done via the +.Xr fts 3 +routines rather than directly accessing the file system). +.Pp +It would be nice if +.Nm +knew about the dump sequence, +kept track of the tapes scribbled on, +told the operator which tape to mount when, +and provided more assistance +for the operator running +.Xr restore 8 . diff --git a/static/netbsd/man8/dumpfs.8 b/static/netbsd/man8/dumpfs.8 new file mode 100644 index 00000000..4062d4f4 --- /dev/null +++ b/static/netbsd/man8/dumpfs.8 @@ -0,0 +1,116 @@ +.\" $NetBSD: dumpfs.8,v 1.21 2022/12/19 18:51:42 chs Exp $ +.\" +.\" Copyright (c) 1983, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)dumpfs.8 8.1 (Berkeley) 6/5/93 +.\" +.Dd February 27, 2010 +.Dt DUMPFS 8 +.Os +.Sh NAME +.Nm dumpfs +.Nd dump file system information +.Sh SYNOPSIS +.Nm +.Op Fl acFijmsv +.Ar filesys No \&| Ar device +.Op Ar ... +.Sh DESCRIPTION +.Nm +prints out detailed information about the specified filesystems. +.Pp +Options: +.Bl -tag -width Ds +.It Fl a +Print details from each alternate superblock. +.It Fl c +Print details of each cylinder group. +.It Fl F +Dump a file system image from a file, not a special device. +.It Fl i +Print details of each allocated inode. +.It Fl j +Print details of the WAPBL journal. +.It Fl m +Print details of the cylinder group summary. +.It Fl s +Print details of the superblock. +.It Fl v +Be even more verbose. +.El +.Pp +If none of +.Fl a , +.Fl c , +.Fl i , +.Fl j , +.Fl m , +or +.Fl s +are given, then +.Nm +defaults to +.Fl cmsv . +.Pp +.Nm +is useful mostly for finding out certain file system +information such as the file system block size, minimum +free space percentage, and (for FFSv1) the file system level that +can be upgraded with the +.Fl c +option of +.Xr fsck_ffs 8 . +All of this information is output by +.Nm +.Fl s . +.Sh SEE ALSO +.Xr disktab 5 , +.Xr fs 5 , +.Xr disklabel 8 , +.Xr fsck 8 , +.Xr fsck_ffs 8 , +.Xr newfs 8 , +.Xr tunefs 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.2 . +The +.Fl a , +.Fl c , +.Fl i , +.Fl m , +and +.Fl s +options, and the inode dump were added for +.Nx 2.0 . +The +.Fl j , +option was added for +.Nx 6.0 . diff --git a/static/netbsd/man8/dumplfs.8 b/static/netbsd/man8/dumplfs.8 new file mode 100644 index 00000000..e7dadb08 --- /dev/null +++ b/static/netbsd/man8/dumplfs.8 @@ -0,0 +1,87 @@ +.\" $NetBSD: dumplfs.8,v 1.11 2003/08/07 11:25:20 agc Exp $ +.\" +.\" Copyright (c) 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)dumplfs.8 8.1 (Berkeley) 6/18/93 +.\" +.Dd June 13, 2000 +.Dt DUMPLFS 8 +.Os +.Sh NAME +.Nm dumplfs +.Nd dump file system information +.Sh SYNOPSIS +.Nm dumplfs +.Op Fl adiS +.Op Fl b Ar blkno +.Op Fl I Ar blkno +.Op Fl s Ar segno +.Ar filesys No \&| Ar device +.Sh DESCRIPTION +.Nm +prints out the file system layout information for the +LFS file system or special device specified. +The listing is very long and detailed. +This command is useful mostly for finding out certain file system +information such as the file system block size. +.Pp +The following flags are interpreted by +.Nm dumplfs . +.Bl -tag -width indent +.It Fl a +Dump the contents of all superblocks, not just the first. Superblocks +appear in the dumplfs output with the segment containing them. +.It Fl b +Use the block specified immediately after the flag as the super block for the +filesystem. +.It Fl d +Check partial segment data checksums and report mismatches. This makes +.Nm +operate much more slowly. +.It Fl I +Use the block specified immediately after the flag as the inode block +containing the index file inode. +.It Fl i +Dump information about the inode free list. +.It Fl S +Dump information about the segment table. +.It Fl s +Add the segment number immediately following the flag to a list of segments to +dump. This flag may be specified more than once to dump more than one segment. +The default is to dump all segments. +.El +.Sh SEE ALSO +.Xr disktab 5 , +.Xr fs 5 , +.Xr disklabel 8 , +.Xr newfs_lfs 8 +.Sh HISTORY +The +.Nm dumplfs +command appeared in +.Bx 4.4 . diff --git a/static/netbsd/man8/eapol_test.8 b/static/netbsd/man8/eapol_test.8 new file mode 100644 index 00000000..725a8678 --- /dev/null +++ b/static/netbsd/man8/eapol_test.8 @@ -0,0 +1,124 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng . +.TH "EAPOL_TEST" "8" "07 August 2019" "" "" + +.SH NAME +eapol_test \- EAP peer and RADIUS client testing +.SH SYNOPSIS + +\fBeapol_test\fR [ \fB-nWS\fR ] [ \fB-c\fIconfig file\fB\fR ] [ \fB-a\fIserver IP address\fB\fR ] [ \fB-A\fIclient IP address\fB\fR ] [ \fB-p\fIUDP port\fB\fR ] [ \fB-s\fIshared secret\fB\fR ] [ \fB-r\fIre-authentications\fB\fR ] [ \fB-t\fItimeout\fB\fR ] [ \fB-C\fIConnect-Info\fB\fR ] [ \fB-M\fIMAC address\fB\fR ] [ \fB-o\fIfile\fB\fR ] [ \fB-N\fIattr spec\fB\fR ] + + +\fBeapol_test scard\fR + + +\fBeapol_test sim\fR [ \fBPIN\fR ] [ \fBnum triplets\fR ] + +.SH "OVERVIEW" +.PP +eapol_test is a program that links together the same EAP +peer implementation that wpa_supplicant is using and the RADIUS +authentication client code from hostapd. In addition, it has +minimal glue code to combine these two components in similar +ways to IEEE 802.1X/EAPOL Authenticator state machines. In other +words, it integrates IEEE 802.1X Authenticator (normally, an +access point) and IEEE 802.1X Supplicant (normally, a wireless +client) together to generate a single program that can be used to +test EAP methods without having to setup an access point and a +wireless client. +.PP +The main uses for eapol_test are in interoperability testing +of EAP methods against RADIUS servers and in development testing +for new EAP methods. It can be easily used to automate EAP testing +for interoperability and regression since the program can be run +from shell scripts without require additional test components apart +from a RADIUS server. For example, the automated EAP tests described +in eap_testing.txt are implemented with eapol_test. Similarly, +eapol_test could be used to implement an automated regression +test suite for a RADIUS authentication server. +.PP +As an example: +.sp +.RS + +.nf +eapol_test -ctest.conf -a127.0.0.1 -p1812 -ssecret -r1 +.fi +.RE +.PP +tries to complete EAP authentication based on the network +configuration from test.conf against the RADIUS server running +on the local host. A re-authentication is triggered to test fast +re-authentication. The configuration file uses the same format for +network blocks as wpa_supplicant. +.SH "COMMAND ARGUMENTS" +.TP +\fB-c configuration file path\fR +A configuration to use. The configuration should +use the same format for network blocks as wpa_supplicant. +.TP +\fB-a AS address\fR +IP address of the authentication server. The +default is '127.0.0.1'. +.TP +\fB-A client address\fR +IP address of the client. The default is to +select an address automatically. +.TP +\fB-p AS port\fR +UDP port of the authentication server. The +default is '1812'. +.TP +\fB-s AS secret\fR +Shared secret with the authentication server. +The default is 'radius'. +.TP +\fB-r count\fR +Number of reauthentications. +.TP +\fB-t timeout\fR +Timeout in seconds. The default is 30. +.TP +\fB-C info\fR +RADIUS Connect-Info. The default is +\&'CONNECT 11Mbps 802.11b'. +.TP +\fB-M mac address\fR +Client MAC address (Calling-Station-Id). The +default is '02:00:00:00:00:01'. +.TP +\fB-o file\fR +Location to write out server certificate. +.TP +\fB-N attr spec\fR +Send arbitrary attribute specific by +attr_id:syntax:value, or attr_id alone. attr_id should be the numeric +ID of the attribute, and syntax should be one of 's' (string), +\&'d' (integer), or 'x' (octet string). The value is the attribute value +to send. When attr_id is given alone, NULL is used as the attribute +value. Multiple attributes can be specified by using the option +several times. +.TP +\fB-n\fR +Indicates that no MPPE keys are expected. +.TP +\fB-W\fR +Wait for a control interface monitor before starting. +.TP +\fB-S\fR +Save configuration after authentication. +.SH "SEE ALSO" +.PP +\fBwpa_supplicant\fR(8) +.SH "LEGAL" +.PP +wpa_supplicant is copyright (c) 2003-2022, +Jouni Malinen and +contributors. +All Rights Reserved. +.PP +This program is licensed under the BSD license (the one with +advertisement clause removed). diff --git a/static/netbsd/man8/edquota.8 b/static/netbsd/man8/edquota.8 new file mode 100644 index 00000000..465f62a2 --- /dev/null +++ b/static/netbsd/man8/edquota.8 @@ -0,0 +1,200 @@ +.\" Copyright (c) 1983, 1990, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" This code is derived from software contributed to Berkeley by +.\" Robert Elz at The University of Melbourne. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)edquota.8 8.2 (Berkeley) 4/27/95 +.\" $NetBSD: edquota.8,v 1.17 2022/04/08 10:17:55 andvar Exp $ +.\" +.Dd January 29, 2012 +.Dt EDQUOTA 8 +.Os +.Sh NAME +.Nm edquota +.Nd edit user quotas +.Sh SYNOPSIS +.Nm +.Op Fl Hu +.Op Fl f Ar file-system +.Op Fl p Ar proto-username +.Ar -d | +.Ar username ... +.Nm +.Op Fl H +.Fl g +.Op Fl f Ar file-system +.Op Fl p Ar proto-groupname +.Ar -d | +.Ar groupname ... +.Nm +.Op Fl Hu +.Op Fl f Ar file-system +.Op Fl h Ar block#/inode# +.Op Fl s Ar block#/inode# +.Op Fl t Ar block grace time/inode grace time +.Ar -d | +.Ar username ... +.Nm +.Op Fl H +.Fl g +.Op Fl f Ar file-system +.Op Fl h Ar block#/inode# +.Op Fl s Ar block#/inode# +.Op Fl t Ar block grace time/inode grace time +.Ar -d | +.Ar groupname ... +.Nm +.Op Fl Hu +.Fl c +.Op Fl f Ar file-system +.Ar username ... +.Nm +.Op Fl H +.Fl g +.Fl c +.Op Fl f Ar file-system +.Ar groupname ... +.Sh DESCRIPTION +.Nm +is a quota editor. +By default, or if the +.Fl u +flag is specified, +one or more users may be specified on the command line. +Unless +.Fl h , +.Fl s , +or +.Fl t +are used, a temporary file is created for each user with an ASCII +representation of the current disk quotas and grace time for that user. +By default, quota for all quota-enabled file systems are edited; the +.Fl f +option can be used to restrict it to a single file system. +An editor is invoked on the ASCII file. +The editor invoked is +.Xr vi 1 +unless the environment variable +.Ev EDITOR +specifies otherwise. +.Pp +The quotas may then be modified, new quotas added, etc. +Setting a quota to \- or unlimited indicates that no quota should be imposed. +Setting a quota to zero indicates that no allocation is permitted. +Setting a soft limit to zero with a unlimited hard limit +indicates that allocations should be permitted on only a temporary basis. +The current usage information in the file is for informational purposes; +only the hard and soft limits, and grace time can be changed. +.Pp +Users are permitted to exceed their soft limits +for a grace period that may be specified per user (or per-file system +for quota version 1). +Once the grace period has expired, +the soft limit is enforced as a hard limit. +The default grace period is one week. +.Pp +By default, disk quotas are in KB, grace time in seconds. +Disk and inodes quota can be entered with a +.Xr humanize_number 9 +suffix (K for kilo, M for mega, G for giga, T for tera). +Time can be entered with Y (year), W (week), D (day), H (hour) and M (minute) +suffixes. +Suffixes can be mixed (see +.Sx EXAMPLES +below). +If the +.Fl H +option if used, current quota, disk usage and time are displayed in +a human-readable format. +.Pp +On leaving the editor, +.Nm +reads the temporary file and modifies the on-disk quotas +to reflect the changes made. +.Pp +If the +.Fl p +flag is specified, +.Nm +will duplicate the quotas of the prototypical user +specified for each user specified. +.Pp +The +.Fl h , +.Fl s , +and +.Fl t +flags can be used to change quota limits (hard, soft and grace time, +respectively) without user interaction, for usage in e.g. batch scripts. +The arguments are the new block and inode number limit or grace time, +separated by a slash. +Units suffix may be used, as in the editor above. +.Pp +If the +.Fl g +flag is specified, +.Nm +is invoked to edit the quotas of +one or more groups specified on the command line. +.Pp +With quota version 2, there is a per-file system user or group +default quota to be copied to a user or group quota on the first +allocation. +The +.Fl d +flag adds the default quota to the list of users or groups to edit. +.Pp +For quota version 1, there is no default block/inode quota, and no +per-user/group grace time. +To edit the file system-wide grace time, use +.Fl d . +.Pp +On quota2-enabled file systems, the +.Fl c +flag cause edquota to clear quota entries for the specified users or groups. +If disk or inode usages is not 0, limits are reverted to the default quota. +If disk and inode usages are 0, the existing quota entries are freed. +.Pp +Only the super-user may edit quotas. +.Sh EXAMPLES +Edit quotas for group games on all quota-enabled file systems: +.Dl edquota -g +Set 4MB hard block limit, 2MB soft block limit, 2048 inode hard limit, +1024 inode soft limit, 2 weeks and 3 days (or 17 days) block and inode grace +time for the default quotas on file system +.Pa /home : +.Dl edquota -h 4M/2k -s 2M/1k -t 2W3D/2W3D -f /home -u -d +.Sh SEE ALSO +.Xr quota 1 , +.Xr humanize_number 3 , +.Xr libquota 3 , +.Xr fstab 5 , +.Xr quotacheck 8 , +.Xr quotaon 8 , +.Xr quotarestore 8 , +.Xr repquota 8 diff --git a/static/netbsd/man8/eeprom.8 b/static/netbsd/man8/eeprom.8 new file mode 100644 index 00000000..a4ed025c --- /dev/null +++ b/static/netbsd/man8/eeprom.8 @@ -0,0 +1,357 @@ +.\" $NetBSD: eeprom.8,v 1.17 2017/07/03 21:35:30 wiz Exp $ +.\" +.\" Copyright (c) 1996 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Jason R. Thorpe. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 27, 2007 +.Dt EEPROM 8 +.Os +.Sh NAME +.Nm eeprom +.Nd display or modify contents of the EEPROM or openprom +.Sh SUN 3 SYNOPSIS +.Nm +.Op Fl +.Op Fl c +.Op Fl f Ar device +.Op Fl i +.Oo +.Ar field Ns Oo +.Li = Ns Ar value +.Oc ... +.Oc +.Sh SPARC, SPARC64, MACPPC and PREP SYNOPSIS +.Nm +.Op Fl +.Op Fl c +.Op Fl f Ar device +.Op Fl i +.Op Fl v +.Oo +.Ar field Ns Oo +.Li = Ns Ar value +.Oc ... +.Oc +.Sh DESCRIPTION +.Nm +provides an interface for displaying and changing the contents of the +EEPROM or openprom. +The +.Nm +tool is only installed on supported platforms. +.Pp +Without any arguments, +.Nm +will list all of the known fields and their corresponding values. +When given the name of a specific field, +.Nm +will display that value or set it if the field name is followed by +.Sq = +and a value. +Only the super-user may modify the contents of the EEPROM or openprom. +.Pp +The options are as follows: +.Bl -tag -width indent +.It Fl +Commands are taken from stdin and displayed on stdout. +.It Fl c +.Nm +will fix incorrect checksum values and exit. +This flag is quietly ignored on systems with an openprom. +.It Fl f Ar device +On systems with an EEPROM, use +.Ar device +instead of the default +.Pa /dev/eeprom . +On systems with an openprom, use +.Ar device +instead of the default +.Pa /dev/openprom . +.It Fl i +If checksum values are incorrect, +.Nm +will ignore them and continue after displaying a warning. +This flag is quietly ignored on systems with an openprom. +.El +.Pp +The following options are valid only on the SPARC and will produce an +error when used on a Sun 3: +.Bl -tag -width indent +.It Fl v +On systems with an openprom, be verbose when setting a value. +Systems with an EEPROM are always verbose. +.El +.Pp +The +.Fl v +option is also present on sparc64, macppc, and prep systems. +.Sh FIELDS AND VALUES +The following fields and values are for systems with an EEPROM: +.Bl -tag -width "watchdog_reboot " +.It hwupdate +A valid date, such as +.Dq 7/12/95 . +The strings +.Dq today +and +.Dq now +are also acceptable. +.It memsize +How much memory, in megabytes, is installed in the system. +.It memtest +How much memory, in megabytes, is to be tested upon power-up. +.It scrsize +The size of the screen. +Acceptable values are +.Dq 1024x1024 , +.Dq 1152x900 , +.Dq 1600x1280 , +and +.Dq 1440x1440 . +.It watchdog_reboot +If true, the system will reboot upon reset. +Otherwise, the system will fall into the monitor. +.It default_boot +If true, the system will use the boot device stored in +.Pa bootdev . +.It bootdev +Specifies the default boot device in the form cc(x,x,x), where +.Sq cc +is a combination of two letters such as +.Sq sd +or +.Sq le +and each +.Sq x +is a hexadecimal number between 0 and ff, less the prepending +.Sq 0x . +.It kbdtype +This value is +.Dq 0 +for all Sun keyboards. +.It console +Specifies the console type. +Valid values are +.Dq b&w , +.Dq ttya , +.Dq ttyb , +.Dq color , +and +.Dq p4opt . +.It keyclick +If true, the keys click annoyingly. +.It diagdev +This is a string very similar to that used by +.Pa bootdev . +It specifies the default boot device when the diagnostic switch is +turned on. +.It diagpath +A 40-character, NULL-terminated string specifying the kernel or standalone +program to load when the diagnostic switch is turned on. +.It columns +An 8-bit integer specifying the number of columns on the console. +.It rows +An 8-bit integer specifying the number of rows on the console. +.It ttya_use_baud +Use the baud rate stored in +.Pa ttya_baud +instead of the default 9600. +.It ttya_baud +A 16-bit integer specifying the baud rate to use on ttya. +.It ttya_no_rtsdtr +If true, disables RTS/DTR. +.It ttyb_use_baud +Similar to +.Pa ttya_use_baud , +but for ttyb. +.It ttyb_baud +Similar to +.Pa ttya_baud , +but for ttyb. +.It ttyb_no_rtsdtr +Similar to +.Pa ttya_no_rtsdtr , +but for ttyb. +.It banner +An 80-character, NULL-terminated string to use at power-up instead +of the default Sun banner. +.El +.Pp +Note that the +.Pa secure , +.Pa bad_login , +and +.Pa password +fields are not currently supported. +.Pp +Since the openprom is designed such that the field names are arbitrary, +explaining them here is dubious. +Below are field names and values that +one is likely to see on a system with an openprom. +NOTE: this list may be incomplete or incorrect due to differences +between revisions of the openprom. +.Bl -tag -width "last-hardware-update " +.It sunmon-compat? +If true, the old EEPROM-style interface will be used while in the monitor, +rather than the openprom-style interface. +.It selftest-#megs +A 32-bit integer specifying the number of megabytes of memory to +test upon power-up. +.It oem-logo +A 64bitx64bit bitmap in Sun Iconedit format. +To set the bitmap, give the pathname of the file containing the +image. +NOTE: this property is not yet supported. +.It oem-logo? +If true, enables the use of the bitmap stored in +.Pa oem-logo +rather than the default Sun logo. +.It oem-banner +A string to use at power up, rather than the default Sun banner. +.It oem-banner? +If true, enables the use of the banner stored in +.Pa oem-banner +rather than the default Sun banner. +.It ttya-mode +A string of five comma separated fields in the format +.Dq 9600,8,n,1,- . +The first field is the baud rate. +The second field is the number of data bits. +The third field is the parity; acceptable values for parity are +.Sq n +(none), +.Sq e +(even), +.Sq o +(odd), +.Sq m +(mark), and +.Sq s +(space). +The fourth field is the number of stop bits. +The fifth field is the +.Sq handshake +field; acceptable values are +.Sq - +(none), +.Sq h +(RTS/CTS), and +.Sq s +(Xon/Xoff). +.It ttya-rts-dtr-off +If true, the system will ignore RTS/DTR. +.It ttya-ignore-cd +If true, the system will ignore carrier detect. +.It ttyb-mode +Similar to +.Pa ttya-mode , +but for ttyb. +.It ttyb-rts-dtr-off +Similar to +.Pa ttya-rts-dtr-off , +but for ttyb. +.It ttyb-ignore-cd +Similar to +.Pa ttya-ignore-cd , +but for ttyb. +.It sbus-probe-list +Four digits in the format +.Dq 0123 +specifying which order to probe the sbus at power-up. +It is unlikely that this value should ever be changed. +.It screen-#columns +An 8-bit integer specifying the number of columns on the console. +.It screen-#rows +An 8-bit integer specifying the number of rows on the console. +.It auto-boot? +If true, the system will boot automatically at power-up. +.It watchdog-reboot? +If true, the system will reboot upon reset. +Otherwise, system will fall into the monitor. +.It input-device +One of the strings +.Dq keyboard , +.Dq ttya , +or +.Dq ttyb +specifying the default console input device. +.It output-device +One of the strings +.Dq screen , +.Dq ttya , +or +.Dq ttyb +specifying the default console output device. +.It keyboard-click? +If true, the keys click annoyingly. +.It sd-targets +A string in the format +.Dq 31204567 +describing the translation of physical to logical target. +.It st-targets +Similar to +.Pa sd-targets , +but for tapes. +The default translation is +.Dq 45670123 . +.It scsi-initiator-id +The SCSI ID of the on-board SCSI controller. +.It hardware-revision +A 7-character string describing a date, such as +.Dq 25May95 . +.It last-hardware-update +Similar to +.Pa hardware-revision , +describing when the CPU was last updated. +.It diag-switch? +If true, the system will boot and run in diagnostic mode. +.El +.Sh FILES +.Bl -tag -width "/dev/openprom " +.It /dev/eeprom +The EEPROM device on systems with an EEPROM. +.It /dev/openprom +The openprom device on systems with an openprom. +.It /dev/nvram +The nvram device on PReP systems. +.El +.Sh SEE ALSO +.Xr ofctl 8 +.Sh BUGS +The fields and their values are not necessarily well defined on +systems with an openprom. +Your mileage may vary. +.Pp +There are a few fields known to exist in some revisions of the EEPROM +and/or openprom that are not yet supported. +Most notable are those +relating to password protection of the EEPROM or openprom. +.Pp +Avoid gratuitously changing the contents of the EEPROM. +It has a limited number of write cycles. +.Pp +The date parser isn't very intelligent. diff --git a/static/netbsd/man8/efi.8 b/static/netbsd/man8/efi.8 new file mode 100644 index 00000000..65ec545c --- /dev/null +++ b/static/netbsd/man8/efi.8 @@ -0,0 +1,448 @@ +.\" $NetBSD: efi.8,v 1.3 2025/02/24 16:28:50 uwe Exp $ +.\" +.\" Copyright (c) 2024 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 23, 2025 +.Dt EFI 8 +.Os +.Sh NAME +.Nm efi +.Nd UEFI variable editor +.Sh SYNOPSIS +.Nm +.Op Fl CcDFfhNOqrTVvy +.Op Fl Fl brief +.Op Fl Fl debug Ns Op Li = Ns Ar num +.Op Fl @ Ar file +.Op Fl A Op Ar hexnum +.Op Fl a Op Ar hexnum +.Op Fl B Op Ar hexnum +.Op Fl b Ar hexnum +.Op Fl d Ar disk +.Op Fl G Op Ar dev +.Op Fl L Ar label +.Op Fl l Ar loader +.Op Fl n Ar hexnum +.Op Fl o Ar hexnum Ns Op Li \&, Ns Ar hexnum ... +.Op Fl p Ar num +.Op Fl R Ar regexp +.Op Fl t Ar seconds +.Op Fl w Op Ar sig +.Op Fl X Ar hexnum Ns Op Li \&, Ns Ar hexnum ... +.Op Fl x Ar hexnum Ns Op Li \&, Ns Ar hexnum ... +.\" +.Sh DESCRIPTION +.Nm +can display all UEFI variables visible at runtime. +It can also create, modify, and delete boot related variables such as +.Va Boot#### , +.Va BootOrder , +.Va BootNext , +.Va Driver#### , +.Va DriverOrder , +.Va SysPrep#### , +and +.Va SysPrepOrder . +It is designed to be API compatible with +.Nm efibootmgr +in Linux, so that +.Nm grub +can be installed from +.Nx . +Future features may be coming. +.Pp +Many +.Nm +options require a number +.Pq Ar #### +indicating which +.Dq Va Boot#### +argument to modify. +Many options take this as an argument, but it can also be set with the +.Fl b +option. +Note that the boot number is a hexadecimal in the range of 0 to 0xFFFF. +It need not have a leading +.Sq 0x +prefix and it need not be zero padded to 4 hexdigits. +By default, the boot number specifies the +.Dq Va Boot#### +variable, but the +.Fl r +and +.Fl y +options can override this so that it applies to the +.Dq Va Driver#### +and +.Dq Va SysPrep#### +variables. +.Pp +The following options are currently available: +.Bl -tag -width Fl +.\" +.It Fl Fl brief +Only show the variable name, UUID, attributes, and datasize that +appear in the +.Vt efi_var_ioc +data structure +.Po +see +.In sys/efiio.h +.Pc . +This is used when the structure of the data is not known by +.Nm . +.\" +.It Fl Fl debug Ns Op Li = Ns Ar num +Increment the debug level or set it to +.Ar num +when given. +Its value is bit-mapped: +.Pp +.Bl -item -offset indent -compact +.It +Bit(0): Show data structure. +.It +Bit(1): Show raw data. +.It +Bit(2): Show +.Vt efi_var_ioc +structure info +.Po +see +.Fl Fl brief +.Pc . +.El +.\" +.It Fl @ , Fl Fl append-binary-args +Append content of file +.Po +use +.Sq Fl +for stdin +.Pc +to the variable data. +This data is passed to the boot loader on its command line. +.\" +.It Fl A , Fl Fl inactive Op Ar #### +Set given +.Va Boot#### +variable inactive. +.\" +.It Fl a , Fl Fl active Op Ar #### +Set given +.Va Boot#### +variable active. +.\" +.It Fl B , Fl Fl delete-bootnum Op Ar #### +Delete the +.Va Boot#### +variable. +.\" +.It Fl b , Fl Fl bootnum Ar #### +Specify the boot number +.Po +i.e., the +.Ar #### +in +.Va Boot#### +.Pc +to use with other options. +.\" +.It Fl C , Fl Fl create-only +Create a new +.Va Boot#### +variable. +.\" +.It Fl c , Fl Fl create +Same as +.Fl C , +but add the bootnum to the bootorder. +.\" +.It Fl D , Fl Fl remove-dups +Remove any duplicate +.Va BootOrder +entries, retaining the first one in the list. +.\" +.It Fl d , Fl Fl disk Op Ar dev +Specify the device containing the boot loader. +The default is the device containing the current directory. +.\" +.It Fl F , Fl Fl no-reconnect +Do not force a devices reconnect after loading a driver. +.\" +.It Fl f , Fl Fl reconnect +Force a reconnect of devices after loading a driver. +This has no effect for +.Pf non- Va Driver#### +variables. +.\" +.It Fl G , Fl Fl show-gpt Op Ar dev +Show the GPT for the specified device. +The default is the device containing the current directory. +This currently assumes a widescreen for a readable display. +.\" +.It Fl L , Fl Fl label Ar LABEL +Label name displayed by the boot manager. +Defaults to +.Ql NetBSD . +.\" +.It Fl l , Fl Fl loader Ar NAME +Pathname of the boot loader relative to the specified +partition. +Defaults to +.Pa \eEFI\eNetBSD\egrub.efi . +.Em Note : +EFI partitions are usually formatted as MSDOS partitions. +Hence, the file separator is a backslash and may need to be escaped +from the shell. +.\" +.It Fl N , Fl Fl delete-bootnext +Delete the +.Va BootNext +variable. +.\" +.It Fl n , Fl Fl bootnext Ar #### +Set the +.Va BootNext +variable to +.Va Boot#### . +.\" +.It Fl O , Fl Fl delete-bootorder +Delete the +.Va BootOrder +variable. +.\" +.It Fl o , Fl Fl bootorder Ar #### Ns Op Li \&, Ns Ar #### ... +Set the +.Va BootOrder +variable. +The argument is a non-empty comma separated list of hex values. +The hex values can range from 0 to FFFF and should correspond to one +of the +.Va Boot#### +variables. +.\" +.It Fl p , Fl Fl part Ar PART +Specify the partition index on the device that contains the bootloader +binary. +Normally, this is the 'EFI' partition. +The default is partition index 1. +.\" +.It Fl q , Fl Fl quiet +Run quietly \(em no output. +.Po +.Sy XXX : +not yet +.Pc . +.\" +.It Fl r , Fl Fl driver +Operate on +.Va Driver#### +variables instead of +.Va Boot#### +variables. +.\" +.It Fl T , Fl Fl delete-timeout +Delete +.Va Timeout +variable. +.\" +.It Fl t , Fl Fl timeout Ar secs +Set the boot manager +.Va Timeout +variable, in seconds. +.\" +.It Fl V , Fl Fl version +Print version string and exit. +To keep +.Nm grub-install +happy, this is currently set to version 18. +.\" +.It Fl v , Fl Fl verbose +Increment verboseness. +This may be used multiple times. +It is also passed directly to the GPT routines used by the +.Fl G +and +.Fl w +options. +.\" +.It Fl w , Fl Fl write-signature Op Ar sig +For MBR disks: +If the MBR partition is missing a signature (i.e., is +zero), set it to a random value. +If the +.Ar sig +argument is specified, then set the MBR signature to that value +overriding any previous setting. +The signature is a four byte value and can be specified in hex, octal, +or decimal. +This takes precedence over all other options except +.Fl c . +.\" +.It Fl X , Fl Fl remove-bootorder Ar #### Ns Op Li \&, Ns Ar #### ... +Remove argument(s) from the +.Va BootOrder +variable. +.\" +.It Fl x , Fl Fl prefix-bootorder Ar #### Ns Op Li \&, Ns Ar #### ... +Prefix argument(s) to the +.Va BootOrder +variable. +.\" +.It Fl y , Fl Fl sysprep +Operate on +.Va SysPrep#### +variables instead of +.Va Boot#### +variables. +.El +.\" +.Sh IMPLEMENTATION NOTES +.Nm +requires kernel EFI runtime support and the device +.Pa /dev/efi . +Currently, +.Nm +only runs on little-endian machines, as required by the UEFI +specification. +.\" +.Pp +As of grub-install 2.12, the following +.Nm efibootmgr +options are used +.Po +see +.Pa grub-2.12/grub-core/osdep/unix/platform.c +.Pc : +.Pp +.Bl -item -offset indent -compact +.It +.Fl B +.It +.Fl L Ar efi_distributor +.It +.Fl b Ar bootnum +.It +.Fl c +.It +.Fl d Ar efidir_disk +.It +.Fl l Ar efifile_path +.It +.Fl p Ar efidir_part_idx +.It +.Fl q +.It +.Fl w +.It +.Fl Fl version +.El +.\" +.Pp +Currently, the following +.Nm efibootmgr +options are not implemented in +.Nm : +.Pp +.Bl -item -offset indent -compact +.It +.Fl E , Fl Fl edd-device +.It +.Fl e , Fl Fl edd +.It +.Fl e , Fl Fl edd30 +.It +.Fl Fl file-dev-path +.It +.Fl Fl full-dev-path +.It +.Fl g , Fl Fl gpt +.It +.Fl i , Fl Fl iface +.It +.Fl M , Fl Fl mirror-above-4G +.It +.Fl m , Fl Fl mirror-below-4G +.It +.Fl u , Fl Fl unicode , Fl Fl UCS-2 +.El +.\" +.Pp +The following options in +.Nm +are not in +.Nm efibootmgr : +.Pp +.Bl -item -offset indent -compact +.It +.Fl Fl brief +.It +.Fl Fl debug +.It +.Fl G , Fl Fl show-gpt +.It +.Fl X , Fl Fl remove-bootorder +.It +.Fl x , Fl Fl prefix-bootorder +.El +.Pp +In addition, several of the supported +.Nm efibootmgr +options now take optional arguments or comma delimited hex number +arguments for convenience. +.Sh SEE ALSO +.Xr gpt 8 +.Sh STANDARDS +.Nm +attempts to follow version 2.10 Errata A (Aug 8, 2024) of the +UEFI Specification +.Pq Lk http://uefi.org . +.\" +.Sh HISTORY +.Nm +was intended to be a +.Nx +replacement for +.Nm efibootmgr +in Linux. +The later is required by +.Nm grub-install +in the +.Nm grub +package. +As a result, the interface is the same with a few exceptions. +For +.Nm +to be used with +.Nm grub-install +it obviously needs to be renamed or linked to +.Nm efibootmgr . +.Sh BUGS +Probably way too many to list. +Currently, +.Nm +has had very limited testing. +Use it at your own risk! diff --git a/static/netbsd/man8/elftosb.8 b/static/netbsd/man8/elftosb.8 new file mode 100644 index 00000000..b38d75ab --- /dev/null +++ b/static/netbsd/man8/elftosb.8 @@ -0,0 +1,69 @@ +.\" $NetBSD: elftosb.8,v 1.4 2018/09/14 07:07:41 skrll Exp $ +.\" +.\" Copyright (c) 2012 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd November 3, 2012 +.Dt ELFTOSB 8 +.Os +.Sh NAME +.Nm elftosb +.Nd generate secure boot images for Freescale processors +.Sh SYNOPSIS +.Nm +.Oo Fl ?, Fl Fl help Oc +.Oo Fl C, Fl Fl component Ar version Oc +.Oo Fl c, Fl Fl command Ar file Oc +.Oo Fl D, Fl Fl define Ar const Oc +.Oo Fl d, Fl Fl debug Oc +.Oo Fl f, Fl Fl chip-family Ar family Oc +.Oo Fl k, Fl Fl key Ar file Oc +.Oo Fl O, Fl Fl option Ar option Oc +.Oo Fl o, Fl Fl output Ar file Oc +.Oo Fl P, Fl Fl product Ar version Oc +.Oo Fl p, Fl Fl search-path Ar path Oc +.Oo Fl q, Fl Fl quiet Oc +.Oo Fl V, Fl Fl verbose Oc +.Oo Fl v, Fl Fl version Oc +.Oo Fl z, Fl Fl zero-key Oc +.Ar files... +.Sh DESCRIPTION +The +.Nm +program is used to create a digitaly signed secure boot (sb) file. +This sb file can be booted by the first stage boot loader found in +Freescale i.MX23 and i.MX28 application processors. +One or several ELF files and optionally a key are taken as input and +processed under the control of a command file to generate the sb file. +.Sh SEE ALSO +.Xr sbkeygen 8 , +.Xr sbtool 8 +.br +Freescale Application Note AN4555 +.Sh COPYRIGHT +Copyright (c) 2004-2010 Freescale Semiconductor, Inc. +.Sh BUGS +The +.Nm +program and its command file syntax are poorly documented. diff --git a/static/netbsd/man8/emcfanctl.8 b/static/netbsd/man8/emcfanctl.8 new file mode 100644 index 00000000..b1dcc35c --- /dev/null +++ b/static/netbsd/man8/emcfanctl.8 @@ -0,0 +1,491 @@ +.\" $NetBSD: emcfanctl.8,v 1.2 2025/03/12 00:43:28 uwe Exp $ +.\" +.\" Copyright (c) 2025 Brad Spencer +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd Feburary 20, 2025 +.Dt EMCFANCTL 8 +.Os +.Sh NAME +.Nm emcfanctl +.Nd Command line utility to interact with EMC fan controllers +.Sh SYNOPSIS +. +.Nm +.Op Fl dhj +.Ar device +.Cm info +. +.Pp +.Nm +.Op Fl dhj +.Ar device +.Cm register list +. +.Nm +.Op Fl dhj +.Ar device +.Cm register read Ar start_register Op Ar end_register +. +.Nm +.Op Fl dhj +.Ar device +.Cm register write Ar register value +. +.Pp +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm status +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm drive read +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm drive write value +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm divider read +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm divider write value +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm min_expected_rpm read +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm min_expected_rpm write Li 500|1000|2000|4000 +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm edges read +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm edges write Li 3|5|7|9 +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm polarity read +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm polarity inverted +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm polarity non-inverted +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm pwm_base_frequency read +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm pwm_base_frequency write Li 26000|19531|4882|2441 +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm pwm_output_type read +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm pwm_output_type push-pull +. +.Nm +.Op Fl dhj +.Ar device +.Cm fan Ar n Cm pwm_output_type open-drain +. +.Pp +.Nm +.Op Fl dhj +.Ar device +.Cm apd read +. +.Nm +.Op Fl dhj +.Ar device +.Cm apd on +. +.Nm +.Op Fl dhj +.Ar device +.Cm apd off +. +.Pp +.Nm +.Op Fl dhj +.Ar device +.Cm smbus_timeout read +. +.Nm +.Op Fl dhj +.Ar device +.Cm smbus_timeout on +. +.Nm +.Op Fl dhj +.Ar device +.Cm smbus_timeout off +. +.Sh DESCRIPTION +The +.Nm +utility interacts with a Microchip Technology EMC-210x or EMC-230x fan controller via +.Xr emcfan 4 +driver. +.Pp +The options are as follows: +.Bl -tag -width Fl +.It Fl d +Debug mode. +.It Fl h +Display help. +.It Fl j +For the commands that produce output, output the result in JSON. +.El +.Pp +The commands are as follows: +. +.Bl -tag -width Cm +.It Cm info +Print the family, chip id and chip revision for the specific +.Ar device . +.It Cm register list +Print the valid registers for the particular chip at the specific +.Ar device . +.It Cm register read Ar start_register Op Ar end_register +Print the values present in the range of registers from +.Ar start_register +to +.Ar end_register . +If +.Ar end_register +is missing, just print one register at +.Ar start_register . +It is possible to use the text names given out by the +.Cm list +command for +.Ar start_register +or +.Ar end_register . +.It Cm register write Ar a_register value +Write +.Ar value +into the register called +.Ar a_register . +.El +. +.Pp +The EMC210X and EMC230X fan controllers have a tremendous number of +features and options and can run in number of different modes. +What follows are some short cut commands that can be used for some of +the more common things one might want to do with a particular +controller. +.Pp \" XXX: compact hack alert +.Bl -tag -width Cm -compact +.It Cm fan Ar n Cm status +Print the stall, spin up and drive status for a particular fan. +Note that the fan will be marked as stalled if the RPMs are below the +minumum expected RPM level. +.Pp +.It Cm fan Ar n Cm drive read +Print the current value of the drive level for a particular fan. +.Pp +.It Cm fan Ar n Cm drive write value +Set the drive level for a particular fan to value. +.Pp +.It Cm fan Ar n Cm divider read +Print the current value of the frequency divider for a particular fan. +.Pp +.It Cm fan Ar n Cm drive write value +Set the frequency divider for a particular fan to value. +.Pp +.It Cm fan Ar n Cm drive min_expected_rpm read +Print the current minimum expected RPM that a fan is suppose to run +at. +If the RPMs are lower than the expected value, the fan will be +marked as stalled and the RPM value in +.Xr envstat 8 +will be +.Ql N/A . +.Pp +.It Cm fan Ar n Cm drive min_expected_rpm write Li 500|1000|2000|4000 +Set the minimum expected RPM value for a fan. +.Pp +.It Cm fan Ar n Cm drive edges read +Print the number of edges that a particular fan has. +This value, along with hw.emcfan0.poles, is used in the tachometer +algorithm to determine the RPM. +.Pp +.It Cm fan Ar n Cm drive edges write Li 3|5|7|9 +Set the number of edges that the fan has. +.Pp +.It Cm fan Ar n Cm polarity read +.It Cm fan Ar n Cm polarity inverted +.It Cm fan Ar n Cm polarity non-inverted +Print or set the polarity of the drive level for the fan. +When the polarity is inverted a drive level of 0 will be maximum +drive, and when the polarity is non-inverted, a drive level of 0 is +minimum drive. +.Pp +.It Cm fan Ar n Cm drive pwm_base_frequency read +Print the number of PWM base frequency for a particular fan. +.Pp +.It Cm fan Ar n Cm drive pwm_base_frequency write Li 26000|19531|4882|2441 +Set the base PWM frequency for a particular fan. +.Pp +.It Cm fan Ar n Cm pwm_output_type read +.It Cm fan Ar n Cm pwm_output_type push-pull +.It Cm fan Ar n Cm pwm_output_type open-drain +Print or set the PWM output type for a particular fan. +.Pp +.It Cm apd read +.It Cm apd on +.It Cm apd off +Print, turn on or turn off the anti-parallel diode mode on the chip. +The EMC2103-2/4, EMC2104 and EMC2106 have the ability to connect two +temperature sensor diodes together with just two wires. +In order to be able to read both diodes, APD needs to be turned on. +.Pp +.It Cm smbus_timeout read +.It Cm smbus_timeout on +.It Cm smbus_timeout off +Print, turn on or turn off +.Tn SMBUS +timeout. +.Tn I2C +and +.Tn SMBUS +are very simular, but a difference is that +.Tn SMBUS +clients can trigger a bus timeout if operations are not performed +against the chip in a certain amount of time. +In order to be completely +.Tn I2C +compliant, the +.Tn SMBUS +timeout should be turned off. +Some of the EMC product default this to on and some default it to off. +.El +.Pp +Not all of the above options apply to all chip types and the +.Nm +command will error if the option does not apply to a particular device. +. +.Sh EXAMPLES +. +This will print the chip family and product id for a particular device: +.Bd -literal -offset indent +# emcfanctl /dev/emcfan0 info +Product Family: EMC230x +Chip name: EMC2301 +Revision: 1 +.Ed +. +.Pp +This is the same, except in JSON: +.Bd -literal -offset indent +# emcfanctl -j /dev/emcfan0 info | json_pp +{ + "chip_name" : "EMC2301", + "family_name" : "EMC230x", + "product_family" : 2, + "product_id" : 55, + "revision" : 1 +} +.Ed +.Pp +This reads a number of registers from the chip and output the result +in a JSON array: +.Bd -literal -offset indent +# emcfanctl -j /dev/emcfan0 register read 0x20 0x29 | json_pp +[ + { + "register" : 32, + "register_name" : "configuration", + "register_value" : 64 + }, + { + "register" : 36, + "register_name" : "fan_status", + "register_value" : 0 + }, + { + "register" : 37, + "register_name" : "fan_stall_status", + "register_value" : 0 + }, + { + "register" : 38, + "register_name" : "fan_spin_status", + "register_value" : 0 + }, + { + "register" : 39, + "register_name" : "drive_fail_status", + "register_value" : 0 + }, + { + "register" : 41, + "register_name" : "fan_interrupt_enable_register", + "register_value" : 0 + } +] +.Ed +.Pp +You can use names for the registers. +The following produces the same result as the previous example, except +not in JSON: +.Bd -literal -offset indent +# emcfanctl /dev/emcfan0 register read configuration drive_fail_status +configuration;32 (0x20);64 (0x40) +fan_status;36 (0x24);0 (0x00) +fan_stall_status;37 (0x25);0 (0x00) +fan_spin_status;38 (0x26);0 (0x00) +drive_fail_status;39 (0x27);0 (0x00) +.Ed +.Pp +This writes a +.Vt uint8_t +value to a particular register: +.Pp +.Dl "# emcfanctl /dev/emcfan0 register write configuration 0xc0" +.Pp +This read back the 0x20 register, also known as +.Ql configuration +as a JSON array. +Using the +.Xr jq 1 +command the value is extracted. +.Bd -literal -offset indent +# emcfanctl -j /dev/emcfan0 register read 0x20 | jq -r '.[0].register_value' +192 +.Ed +.Pp +Read the current drive level for fan #1 on a particular device: +.Bd -literal -offset indent +# emcfanctl /dev/emcfan0 fan 1 drive read +Drive:96 +.Ed +.Pp +Change the drive level for fan #1. +A number of other variables such as polarity and the PWM divider +affect what the drive level means. +.Bd -literal -offset indent +# emcfanctl /dev/emcfan0 fan 1 drive write 0x80 +# emcfanctl /dev/emcfan0 fan 1 drive read +Drive:128 +.Ed +.Pp +If the +.Xr envstat 8 +command is used to look at the RPM of a fan, it will produce something +like the following: +.Bd -literal -offset indent + Current CritMax WarnMax WarnMin CritMin Unit +[emcfan0] + FAN 1: 1159 RPM +.Ed +.Pp +This is below the minumum expected RPM that the fan is suppose to run at: +.Bd -literal -offset indent +# emcfanctl /dev/emcfan0 fan 1 min_expected_rpm read +Minumum expected rpm:500 +.Ed +.Pp +If the minimum expected RPM is changed to be higher than what the fan +is able to run at, that will simulate a stalled fan. +.Pp +.Dl "# emcfanctl /dev/emcfan0 fan 1 min_expected rpm write 4000" +.Pp +Using the +.Xr envstat 8 +command again should produce the following if the fan is not able to +run at 4000\~RPM: +.Bd -literal -offset indent + Current CritMax WarnMax WarnMin CritMin Unit +[emcfan0] + FAN 1: N/A +.Ed +.Pp +The fan will be marked as having stalled: +.Bd -literal -offset indent +# emcfanctl /dev/emcfan0 fan 1 status +Stalled: Yes +Spin up failed: No +Drive failed: No +.Ed +.Pp +The minimum expected RPM should be set to just below the lowest value +that the fan is expected to run at. +The minumum expected RPM effects the accuracy of the tachometers and +should be as high as it can be made while still producing usable RPM +values. +.Pp +.Dl "# emcfanctl /dev/emcfan0 fan 1 min_expected rpm write 500" +.Pp +Using the +.Xr envstat 8 +command again: +.Bd -literal -offset indent + Current CritMax WarnMax WarnMin CritMin Unit +[emcfan0] + FAN 1: 1176 RPM +.Ed +.Pp +The fan is not marked as having stalled: +.Bd -literal -offset indent +# emcfanctl /dev/emcfan0 fan 1 status +Stalled: No +Spin up failed: No +Drive failed: No +.Ed +.Sh SEE ALSO +.Xr emcfan 4 , +.Xr iic 4 , +.Xr envstat 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 11.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +utility was written by +.An Brad Spencer Aq Mt brad@anduin.eldar.org . diff --git a/static/netbsd/man8/envstat.8 b/static/netbsd/man8/envstat.8 new file mode 100644 index 00000000..856fdcbf --- /dev/null +++ b/static/netbsd/man8/envstat.8 @@ -0,0 +1,316 @@ +.\" $NetBSD: envstat.8,v 1.72 2025/04/01 17:07:58 uwe Exp $ +.\" +.\" Copyright (c) 2000, 2007, 2008, 2009, 2014 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Juan Romero Pardines and Bill Squier. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd November 14, 2020 +.Dt ENVSTAT 8 +.Os +.Sh NAME +.Nm envstat +.Nd utility to handle environmental sensors +.Sh SYNOPSIS +.Nm +.Op Fl DfIjklnSTtW +.Op Fl c Ar file +.Op Fl d Ar device +.Op Fl i Ar interval +.Op Fl s Ar device Ns Cm \&: Ns Ar sensor Ns Cm \&, Ns Ar ... +.Op Fl w Ar width +.Nm +.Fl x +.Op Fl d Ar device +.Op Fl s Ar device Ns Cm \&: Ns Ar sensor Ns Cm \&, Ns Ar ... +.Op Ar property ... +.Sh DESCRIPTION +.Nm +is a utility that handles various aspects of the sensors +registered with the +.Xr envsys 4 +framework. +It is capable of displaying sensor values as well as +changing parameters and setting critical limits for the sensors. +.Pp +In display mode, column widths as well as displayed sensors +are fully customizable. +Critical limits or other properties can be set via the configuration file. +If critical limits were set previously, the display mode will show +the critical limits in addition to the current values. +.Pp +The following options are available: +.Bl -tag -width Fl +.It Fl c +Accepts a file as argument to set properties for sensors in +devices registered with the framework. +See the +.Xr envsys.conf 5 +manual page for more information. +.It Fl D +Display the names of the devices that are currently registered with +the +.Xr envsys 4 +framework, one per line, along with some properties for the device +.Pq for example, its refresh timeout value . +.It Fl d Ar device +Display only the sensors for the given +.Ar device . +This is useful when there are multiple devices registered and +you want to only see results from a specific device. +.It Fl f +Display temperature values in degrees Fahrenheit. +The default is to display temperature values in degrees Celsius. +.It Fl I +This flag skips the sensors with invalid state; these are normally +shown using the +.Ql N/A +string by default. +.It Fl i Ar interval +Repeat the display every +.Ar interval +seconds. +Note that some devices do not provide fresh values on demand. +See the individual device's manual page for meaningful values for +.Ar interval . +If not specified, or specified as 0, +.Nm +produces one round of values and exits. +When the +.Fl j +flag is used to get JSON output the string +.Ql #------- +is placed between each JSON block. +.It Fl j +Output the results in JSON format. +Each output will be a correct JSON object that consists of objects, +arrays, integers, floats and strings included, as needed, for any particular +sensor. +.It Fl k +Display temperature values in Kelvin. +The default is to display temperature values in degrees Celsius. +.It Fl l +List the names of all supported sensors, one per line. +Use of this flag causes +.Nm +to ignore all other option flags. +.It Fl n +Print only the current value of a sensor and no headers. +If statistics are selected with +.Fl T +then also display max, min and average. +.It Fl r +This flag is provided for compatibility reasons and there's no need +to use it. +In the previous implementation, it was used to enable the +row mode; this mode is now the default. +.It Fl S +This flag is used to restore defaults to all devices registered with +the framework. +This will remove all properties that were set in +the configuration file to the setting that the devices use by +default. +.It Fl s Ar device Ns Cm \&: Ns Ar sensor Ns Cm \&, Ns Ar ... +Restrict the display to the named devices and sensors. +The pair +.Ar device +and +.Ar sensor +description must be supplied as a comma separated list. +Device as well as sensor descriptions are case sensitive. +Note that the order of the arguments given does not influence the order of output. +.It Fl T +Create and display max, min and average statistics for a sensor. +Must be used with an +.Fl i , +otherwise statistics cannot be collected up. +Please note that to get realistic +values a lower +.Ar interval +value should be used, but that will also increase overhead. +.It Fl t +Output a time stamp along with the rest of the sensor data. +When the +.Fl j +flag is not specified, the time stamp will be on the first line and +be in human readable format. +When the output is JSON, two objects will be included that contain the +Julian Unix time and another with the time stamp in human readable format. +.It Fl w Ar width +Use +.Ar width +as the column width for the output. +Each column is additionally separated by a single space. +The default is the length of the longest sensor name. +.It Fl W +This option has no effect. +It is retained for historical reasons. +.It Fl x +Shows the raw XML property list used by the +.Xr sysmon_envsys 9 +framework that contains details about all registered devices +and sensors. +If +.Ar property +is specified, the value of that property is printed. +The property list can be filtered with the +.Fl d +or +.Fl s +options. +If +.Fl s +is used with only a single sensor, only the properties +of this sensor are returned, not a list of sensors. +.El +.Sh UNITS +The display mode may show some values with abbreviated units; +for example: + +.Bl -column -offset indent "degC" "..." +.It Li A Ta Amperes +.It Li Ah Ta Ampere-hours +.It Li degC Ta degrees Celsius +.It Li degF Ta degrees Fahrenheit +.It Li K Ta Kelvin +.It Li Ohms Ta Ohms +.It Li RPM Ta Revolutions per minute +.It Li V Ta Volts DC +.It Li VAC Ta Volts AC +.It Li W Ta Watts +.It Li Wh Ta Watt-hours +.It Li %rH Ta relative Humidity +.It Li hPa Ta Hectopascals +.El +.Sh EXAMPLES +To list the devices that are currently registered with +.Xr envsys 4 : +.Pp +.Dl envstat -D +.Pp +To display the sensors of the device +.Ql aibs0 : +.Pp +.Dl envstat -d aibs0 +.Pp +To display the +.Ql charge +sensor of the device +.Ql acpibat0 +in one line every ten seconds: +.Pp +.Dl envstat -s acpibat0:charge -i 10 +.Pp +To set all properties specified in the configuration file: +.Pp +.Dl envstat -c /etc/envsys.conf +.Pp +To remove all properties that were set previously in the configuration +file: +.Pp +.Dl envstat -S +.Pp +To display statistics for all sensors and ignoring sensors with +invalid states every second: +.Pp +.Dl envstat -ITi1 +.Pp +To return a single temperature value: +.Pp +.Dl envstat -s vcmbox0:temperature -x /cur-value +.Pp +To return values of multiple temperature sensors from a single device +.Pp +.Bd -literal -offset indent +envstat -s \(aqthinkpad0:temperature 0,thinkpad0:temperature 1\(aq \e + -x /thinkpad0/0/cur-value /thinkpad0/1/cur-value +.Ed +.Pp +To return values of temperature sensors from multiple devices: +.Pp +.Bd -literal -offset indent +envstat -s \(aqcoretemp0:cpu0 temperature,coretemp1:cpu 2 temperature\(aq \e + -x /coretemp0/0/cur-value /coretemp1/0/cur-value +.Ed +.Pp +To output the sensor data in JSON with a timestamp: +.Pp +.Dl envstat -d owtemp0 -jt +.Sh SEE ALSO +.Xr units 1 , +.Xr proplib 3 , +.Xr acpiacad 4 , +.Xr acpibat 4 , +.Xr acpitz 4 , +.Xr admtemp 4 , +.Xr aibs 4 , +.Xr amdtemp 4 , +.Xr aps 4 , +.Xr arcmsr 4 , +.Xr battery_pmu 4 , +.Xr cac 4 , +.Xr dbcool 4 , +.Xr envsys 4 , +.Xr finsio 4 , +.Xr hythygtemp 4 , +.Xr ipmi 4 , +.Xr itesio 4 , +.Xr lm 4 , +.Xr lmtemp 4 , +.Xr mfi 4 , +.Xr nsclpcsio 4 , +.Xr owtemp 4 , +.\".Xr pic16lc 4 , +.Xr smsc 4 , +.Xr sparc/tctrl 4 , +.Xr sparc64/envctrl 4 , +.Xr thinkpad 4 , +.Xr tm121temp 4 , +.Xr ug 4 , +.Xr viaenv 4 , +.Xr x86/coretemp 4 , +.Xr envsys.conf 5 +.Sh HISTORY +.Nm +appeared in +.Nx 1.5 . +It was completely rewritten from scratch for +.Nx 5.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +utility that appeared in +.Nx 5.0 +was written by +.An Juan Romero Pardines . +The previous version was written by +.An Bill Squier . +.Sh BUGS +When displaying statistics using the +.Fl T +option, the average value is an average of the minimum, maximum, and +current sensor values. +It is not an average of all current values displayed during the session. diff --git a/static/netbsd/man8/error.8 b/static/netbsd/man8/error.8 new file mode 100644 index 00000000..aaf22ebc --- /dev/null +++ b/static/netbsd/man8/error.8 @@ -0,0 +1,138 @@ +.\" $NetBSD: error.8,v 1.3 2020/03/18 19:05:14 christos Exp $ +.\" +.TH ERROR 8 +.ad +.fi +.SH NAME +error +\- +Postfix error/retry mail delivery agent +.SH "SYNOPSIS" +.na +.nf +\fBerror\fR [generic Postfix daemon options] +.SH DESCRIPTION +.ad +.fi +The Postfix \fBerror\fR(8) delivery agent processes delivery +requests from +the queue manager. Each request specifies a queue file, a sender +address, the reason for non\-delivery (specified as the +next\-hop destination), and recipient information. +The reason may be prefixed with an RFC 3463\-compatible detail code; +if none is specified a default 4.0.0 or 5.0.0 code is used instead. +This program expects to be run from the \fBmaster\fR(8) process +manager. + +Depending on the service name in master.cf, \fBerror\fR +or \fBretry\fR, the server bounces or defers all recipients +in the delivery request using the "next\-hop" information +as the reason for non\-delivery. The \fBretry\fR service name is +supported as of Postfix 2.4. + +Delivery status reports are sent to the \fBbounce\fR(8), +\fBdefer\fR(8) or \fBtrace\fR(8) daemon as appropriate. +.SH "SECURITY" +.na +.nf +.ad +.fi +The \fBerror\fR(8) mailer is not security\-sensitive. It does not talk +to the network, and can be run chrooted at fixed low privilege. +.SH "STANDARDS" +.na +.nf +RFC 3463 (Enhanced Status Codes) +.SH DIAGNOSTICS +.ad +.fi +Problems and transactions are logged to \fBsyslogd\fR(8) +or \fBpostlogd\fR(8). + +Depending on the setting of the \fBnotify_classes\fR parameter, +the postmaster is notified of bounces and of other trouble. +.SH "CONFIGURATION PARAMETERS" +.na +.nf +.ad +.fi +Changes to \fBmain.cf\fR are picked up automatically as \fBerror\fR(8) +processes run for only a limited amount of time. Use the command +"\fBpostfix reload\fR" to speed up a change. + +The text below provides only a parameter summary. See +\fBpostconf\fR(5) for more details including examples. +.IP "\fB2bounce_notice_recipient (postmaster)\fR" +The recipient of undeliverable mail that cannot be returned to +the sender. +.IP "\fBbounce_notice_recipient (postmaster)\fR" +The recipient of postmaster notifications with the message headers +of mail that Postfix did not deliver and of SMTP conversation +transcripts of mail that Postfix did not receive. +.IP "\fBconfig_directory (see 'postconf -d' output)\fR" +The default location of the Postfix main.cf and master.cf +configuration files. +.IP "\fBdaemon_timeout (18000s)\fR" +How much time a Postfix daemon process may take to handle a +request before it is terminated by a built\-in watchdog timer. +.IP "\fBdelay_logging_resolution_limit (2)\fR" +The maximal number of digits after the decimal point when logging +sub\-second delay values. +.IP "\fBdouble_bounce_sender (double\-bounce)\fR" +The sender address of postmaster notifications that are generated +by the mail system. +.IP "\fBipc_timeout (3600s)\fR" +The time limit for sending or receiving information over an internal +communication channel. +.IP "\fBmax_idle (100s)\fR" +The maximum amount of time that an idle Postfix daemon process waits +for an incoming connection before terminating voluntarily. +.IP "\fBmax_use (100)\fR" +The maximal number of incoming connections that a Postfix daemon +process will service before terminating voluntarily. +.IP "\fBnotify_classes (resource, software)\fR" +The list of error classes that are reported to the postmaster. +.IP "\fBprocess_id (read\-only)\fR" +The process ID of a Postfix command or daemon process. +.IP "\fBprocess_name (read\-only)\fR" +The process name of a Postfix command or daemon process. +.IP "\fBqueue_directory (see 'postconf -d' output)\fR" +The location of the Postfix top\-level queue directory. +.IP "\fBsyslog_facility (mail)\fR" +The syslog facility of Postfix logging. +.IP "\fBsyslog_name (see 'postconf -d' output)\fR" +A prefix that is prepended to the process name in syslog +records, so that, for example, "smtpd" becomes "prefix/smtpd". +.PP +Available in Postfix 3.3 and later: +.IP "\fBservice_name (read\-only)\fR" +The master.cf service name of a Postfix daemon process. +.SH "SEE ALSO" +.na +.nf +qmgr(8), queue manager +bounce(8), delivery status reports +discard(8), Postfix discard delivery agent +postconf(5), configuration parameters +master(5), generic daemon options +master(8), process manager +postlogd(8), Postfix logging +syslogd(8), system logging +.SH "LICENSE" +.na +.nf +.ad +.fi +The Secure Mailer license must be distributed with this software. +.SH "AUTHOR(S)" +.na +.nf +Wietse Venema +IBM T.J. Watson Research +P.O. Box 704 +Yorktown Heights, NY 10598, USA + +Wietse Venema +Google, Inc. +111 8th Avenue +New York, NY 10011, USA diff --git a/static/netbsd/man8/etcupdate.8 b/static/netbsd/man8/etcupdate.8 new file mode 100644 index 00000000..58a5c3f0 --- /dev/null +++ b/static/netbsd/man8/etcupdate.8 @@ -0,0 +1,467 @@ +.\" $NetBSD: etcupdate.8,v 1.27 2022/01/14 22:55:10 lukem Exp $ +.\" +.\" Copyright (c) 2001-2022 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Martti Kuparinen. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd January 15, 2022 +.Dt ETCUPDATE 8 +.Os +.Sh NAME +.Nm etcupdate +.Nd update the configuration and startup files in +.Pa /etc +.Sh SYNOPSIS +.Nm +.Op Fl alv +.Op Fl d Ar destdir +.Op Fl p Ar pager +.Op Fl s Pq Ar srcdir | Ar tgzdir | Ar tgzfile +.Op Fl t Ar temproot +.Op Fl w Ar width +.Nm +.Pq Fl h | Fl \&? +.Sh DESCRIPTION +.Nm +is a tool that lets the administrator update the configuration and +startup files in +.Pa /etc +(and some other directories like +.Pa /dev , +.Pa /root +and +.Pa /var ) +without having to manually check and modify every file. +The administrator should run this script after performing an operating +system update (e.g. after running +.Pa make build +in +.Pa /usr/src +or after extracting new binary distribution files) +to update to the latest configuration and startup files. +.Pp +.Nm +compares the new configuration files against the currently installed files. +The user is given the option of installing, merging or deleting each +modified or missing file. +The user can also view the differences between the files. +By default, it shows the differences in the unified diff format. +The default format can be toggled to show the differences +in unified, context, or side by side formats or an user-defined +command may be used to view differences. +(And if +.Nm wdiff +is installed, it can also show differences on a word by word basis.) +.Pp +.Nm +also detects if the user installs certain special files and performs +corresponding tasks like remaking device nodes or rebuilding a database +from the +.Xr aliases 5 +file. +Finally, +.Nm +runs +.Xr postinstall 8 +to check the results. +.Pp +.Nm +needs a clean set of new configuration files to compare the +existing files against. +These files, called the +.Dq reference files +in this manual, may be derived from either a source or binary +distribution of +.Nx . +.Pp +If the user is updating from sources (which is the default mode), +.Nm +will first create a copy of the reference files +by running +.Pa make distribution +in +.Pa /usr/src/etc , +installing the files to a so-called +.Pa temproot . +(See usage of the +.Fl s Ar srcdir +and +.Fl t Ar temproot +options later in this manual page.) +Although this is the default mode, it is not recommended +(see the +.Dq BUGS +section). +.Pp +Instead of using sources, it is recommended that the user should extract +one or more binary distribution sets in a special location and use those +as the reference files (see usage of the +.Fl s Ar tgzdir +option later in this manual page), +or specify one or more binary distribution sets directly +(see usage of the +.Fl s Ar tgzfile +option later in this manual page). +.Pp +The following options are available: +.Bl -tag -width XXtXtemprootX +.It Fl a +.Nm +can automatically update files which have not been modified locally. +The +.Fl a +flag instructs +.Nm +to store MD5 checksums in +.Pa /var/etcupdate +and use these checksums to determine if there have been any +local modifications. +.It Fl d Ar destdir +Use +.Ar destdir +instead of +.Pa / +as the top of the file system hierarchy to be updated. +For example, +.Ar destdir Ns Pa /etc +will be used instead of +.Pa /etc . +.It Fl h +Display help to stdout, and exit. +.It Fl l +Automatically skip files with unchanged RCS IDs. +This has the effect of leaving alone files that have been altered +locally but which have not been changed in the +reference files. +Since this works using RCS IDs, files without RCS IDs will not be +skipped even if only modified locally. +This flag may be used together with the +.Fl a +flag described above. +.It Fl p Ar pager +The pager to use when displaying files. +By default this is +.Xr more 1 +but it can be changed either with this option +or by defining the +.Ev PAGER +variable. +.It Fl s Pq Ar srcdir | Ar tgzdir | Ar tgzfile +The location of the reference files, or the +.Nx +source files used to create the reference files. +This may be specified in one of three ways: +.Bl -tag -width XXsXtgzfileXX +.It Fl s Ar srcdir +The top level directory of the +.Nx +source tree. +By default this is +.Pa /usr/src +but it can be changed either with this option +or the +.Ev SRCDIR +variable. +The reference files will be created by running +.Dq "make distribution" +in the +.Ar srcdir Ns Pa /etc +directory. +Note that +.Ar srcdir +should refer to the top of the source directory tree; +earlier versions of +.Nm +expected +.Ar srcdir +to refer to the +.Pa etc +subdirectory within the source tree. +.It Fl s Ar tgzdir +A directory in which reference files have been +extracted from a binary distribution of +.Nx . +The files that are distributed in the +.Dq Pa etc.tgz +or +.Dq Pa etc.tar.xz +set file must be present. +The files that are distributed in the +.Dq Pa xetc.tgz +or +.Dq Pa xetc.tar.xz +set file are optional. +The reference files from the specified directory will be copied to the +.Pa temproot +directory. +.It Fl s Ar tgzfile +The location of a set file +(or +.Dq "tgz file" ) +such as +.Dq Pa etc.tgz , +.Dq Pa etc.tar.xz +or +.Dq Pa xetc.tgz +from a binary distribution of +.Nx . +Each set file is a compressed archive containing reference files, +which will be extracted to the +.Pa temproot +directory. +Multiple +.Fl s +options may be used to specify multiple set files. +The +.Dq Pa etc.tgz +or +.Dq Pa etc.tar.xz +set file must be specified. +The +.Dq Pa xetc.tgz +or +.Dq Pa xetc.tar.xz +set file is optional. +.El +.It Fl t Ar temproot +Specifies the location of the +.Pa temproot +directory. +This directory will be used for a temporary copy of +the reference files created by running +.Dq "make distribution" +in the source directory specified by +.Fl s Ar srcdir , +or a temporary copy of the reference files extracted from +the binary sets specified by +.Fl s Ar tgzfile , +or a temporary copy of the reference files from the directory specified by +.Fl s Ar tempdir . +By default this is +.Pa /tmp/temproot +but can be changed either with this option or the +.Ev TEMPROOT +environment variable. +.It Fl v +Makes +.Nm +verbose about its actions. +.It Fl w Ar width +Sets screen width used during interactive merge. +By default this is the number of columns +.Xr stty 1 +reports but it can be changed either with this +option or by defining the +.Ev WIDTH +variable. +This is useful for +.Xr xterm 1 +users with wider shell windows. +.It Fl \&? +Display help to stdout, and exit. +.El +.Sh ENVIRONMENT +.Bl -tag -width IGNOREFILESXX +.It Ev TEMPROOT +Sets a default value for +.Pa temproot . +See +.Fl t +above. +.It Ev SRCDIR +The location of the +.Nx +sources files. +See +.Fl s +above. +.It Ev PAGER +The pager to use when displaying files. +See +.Fl p +above. +.It Ev WIDTH +The screen width used during interactive merge. +See +.Fl w +above. +.It Ev IGNOREFILES +A list of files that +.Nm +should ignore. +Files listed in this +variable will never be considered for updating by +.Nm . +.El +.Sh FILES +The environment variables can also be defined in the following configuration +files. +The user's personal configuration file settings override the global +settings. +.Pp +/etc/etcupdate.conf +.Pp +~/.etcupdaterc +.Sh EXAMPLES +You have just upgraded your +.Nx +host from 3.0 to 4.0 and now it's time +to update the configuration files as well. +To update the configuration files from the sources (if you have the +.Pa /usr/src/etc +directory): +.Pp +.Dl etcupdate +.Pp +The default location of the source files is +.Pa /usr/src +but this may be overridden with the +.Fl s Ar srcdir +command line argument: +.Pp +.Dl etcupdate -s /some/where/src +.Pp +To update the configuration files from binary distribution sets +do something like this: +.Pp +.Dl etcupdate -s /some/where/etc.tgz -s /some/where/xetc.tgz +.Pp +or like this: +.Pp +.Dl mkdir /tmp/temproot +.Dl cd /tmp/temproot +.Dl tar -xpzf /some/where/etc.tgz +.Dl tar -xpzf /some/where/xetc.tgz +.Dl etcupdate -s /tmp/temproot +.Pp +You have modified only few files in the +.Pa /etc +directory so you would like install most of the updates without being asked. +To automatically update the unmodified configuration files: +.Pp +.Dl etcupdate -a +.Pp +To get a better idea what's going on, use the +.Fl v +flag: +.Pp +.Dl etcupdate -v +.Sh SEE ALSO +.Xr cmp 1 , +.Xr more 1 , +.Xr rcs 1 , +.Xr sdiff 1 , +.Xr stty 1 , +.Xr aliases 5 , +.Xr postinstall 8 +.Sh HISTORY +The +.Nm +command appeared in +.Nx 1.6 . +.Pp +In +.Nx 4.0 , +the +.Fl s Ar tgzfile +option was added, the +.Fl b Ar tempdir +option was converted to +.Fl s Ar tgzdir , +and the +.Fl s Ar srcdir +option was changed to refer to the top of the +source directory tree rather than to the +.Pa etc +subdirectory. +.Pp +In +.Nx 5.0 , +the ability to specify multiple colon-separated files with a single +.Fl s +option was deprecated, +and options deprecated in +.Nx 4.0 +were removed. +.Pp +In +.Nx 7.0 , +the ability to specify multiple colon-separated files with a single +.Fl s +option was removed (multiple +.Fl s +options must be used instead), +and the +.Fl d Ar destdir +option was added. +.Sh AUTHORS +The script was written by +.An Martti Kuparinen +.Aq martti@NetBSD.org +and improved by several other +.Nx +users. +.Pp +The idea for this script (including code fragments, variable names etc.) +came from the +.Fx +mergemaster (by Douglas Barton). +Unlike the +.Fx +mergemaster, this does not use CVS version tags by default to compare if +the files need to be updated. +Files are compared with +.Xr cmp 1 +as this is more reliable and the only way if the version numbers are the +same even though the files are different. +.\" when exactly are the version the same even though the file changes? +.\" .Pp +.Sh BUGS +If a source directory is specified via the +.Dq Fl s Ar srcdir +option (or if the +.Pa /usr/src +directory is used by default), then +.Nm +will run +.Dq "make distribution" +in the +.Pa etc +subdirectory of the source directory, but it will not use the same +options or environment variables that would be used during a full build +of the operating system. +For this reason, use of the +.Dq Fl s Ar srcdir +option is not recommended, and use of the +.Dq Fl s Ar tgzdir +or +.Dq Fl s Ar tgzfile +options is recommended. +.\" .Pp +.\" Because of the use of +.\" .Xr cmp 1 +.\" to compare files, rather than CVS versions, files that are locally changed +.\" from the distribution are always considered needing to be updated. diff --git a/static/netbsd/man8/example.8 b/static/netbsd/man8/example.8 new file mode 100644 index 00000000..ef99184c --- /dev/null +++ b/static/netbsd/man8/example.8 @@ -0,0 +1,11 @@ +# $NetBSD: example.8,v 1.1.1.1 2012/03/23 21:20:15 christos Exp $ +# +# block all incoming TCP connections but send back a TCP-RST for ones to +# the ident port +# +block in proto tcp from any to any flags S/SA +block return-rst in quick proto tcp from any to any port = 113 flags S/SA +# +# block all inbound UDP packets and send back an ICMP error. +# +block return-icmp in proto udp from any to any diff --git a/static/netbsd/man8/extattrctl.8 b/static/netbsd/man8/extattrctl.8 new file mode 100644 index 00000000..ea768823 --- /dev/null +++ b/static/netbsd/man8/extattrctl.8 @@ -0,0 +1,218 @@ +.\" $NetBSD: extattrctl.8,v 1.6 2025/03/10 22:19:53 christos Exp $ +.\" +.\" Copyright (c) 2000-2001 Robert N. M. Watson +.\" All rights reserved. +.\" +.\" This software was developed by Robert Watson for the TrustedBSD Project. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD: src/usr.sbin/extattrctl/extattrctl.8,v 1.24 2005/02/09 18:04:40 ru Exp $ +.\" +.\" Developed by the TrustedBSD Project. +.\" Support for file system extended attribute. +.\" +.Dd March 10, 2025 +.Dt EXTATTRCTL 8 +.Os +.Sh NAME +.Nm extattrctl +.Nd manage UFS1 extended attributes +.Sh SYNOPSIS +.Nm +.Cm start +.Ar path +.Nm +.Cm stop +.Ar path +.Nm +.Cm initattr +.Op Fl f +.Op Fl p Ar path +.Ar attrsize +.Ar attrfile +.Nm +.Cm showattr +.Ar attrfile +.Nm +.Cm enable +.Ar path +.Ar attrnamespace +.Ar attrname +.Ar attrfile +.Nm +.Cm disable +.Ar path +.Ar attrnamespace +.Ar attrname +.Sh DESCRIPTION +The +.Nm +utility +is the management utility for extended attributes over the UFS1 file system. +It allows the starting and stopping of extended attributes on a file system, +as well as initialization of attribute backing files, and enabling and +disabling of specific extended attributes on a file system. +.Pp +The first argument on the command line indicates the operation to be +performed. +Operation must be one of the following: +.Bl -tag -width indent +.It Cm start Ar path +Start extended attribute support on the file system named using +.Ar path . +The file system must be a UFS1 file system, and the +.Dv UFS_EXTATTR +kernel option must have been enabled. +If +.Pa .attribute/user +and +.Pa .attribute/system +exist at the filesystem root, extended attributes backed by files +in these directories will be automatically enabled. +Note that extended attributes can be automatically started at mount +time by using the +.Cm -o extattr +option to +.Xr mount 8 . +.It Cm stop Ar path +Stop extended attribute support on the file system named using +.Ar path . +Extended attribute support must previously have been started. +.It Cm initattr Oo Fl f Oc Oo Fl p Ar path Oc Ar attrsize attrfile +Create and initialize a file to use as an attribute backing file. +You must specify a maximum per-inode size for the attribute in bytes in +.Ar attrsize , +as well as the file where the attribute will be stored, using +.Ar attrfile . +.Pp +The +.Fl f +argument may be used to indicate that it is alright to overwrite an +existing attribute backing file; otherwise, if the target file exists, +an error will be returned. +.Pp +The +.Fl p Ar path +argument may be used to preallocate space for all attributes rather than +relying on sparse files to conserve space. +This has the advantage of guaranteeing that space will be available +for attributes when they are written, preventing low disk space conditions +from denying attribute service. +.Pp +This file should not exist before running +.Cm initattr . +.Pp +When a user attempts to set a +.Dq user +or +.Dq system +extended attribute that lacks a backing file, +the kernel will attempt to automatically create it, provided +.Pa .attribute/user +or +.Pa .attribute/system +exist and are writable by the requesting user. +.It Cm showattr Ar attrfile +Show the attribute header values in the attribute file named by +.Ar attrfile . +.It Cm enable Ar path attrnamespace attrname attrfile +Enable an attribute named +.Ar attrname +in the namespace +.Ar attrnamespace +on the file system identified using +.Ar path , +and backed by initialized attribute file +.Ar attrfile . +Available namespaces are +.Dq user +and +.Dq system . +The backing file must have been initialized using +.Cm initattr +before its first use. +Attributes must have been started on the file system prior to the +enabling of any attributes. +.It Cm disable Ar path attrnamespace attrname +Disable the attributed named +.Ar attrname +in namespace +.Ar attrnamespace +on the file system identified by +.Ar path . +Available namespaces are +.Dq user +and +.Dq system . +The file system must have attributes started on it, and the attribute +most have been enabled using +.Cm enable . +.El +.Sh EXAMPLES +.Dl extattrctl start / +.Pp +Start extended attributes on the root file system. +.Pp +.Dl extattrctl initattr 17 /.attribute/system/md5 +.Pp +Create an attribute backing file in +.Pa /.attribute/system/md5 , +and set the maximum size of each attribute to 17 bytes, with a +sparse file used for storing the attributes. +.Pp +.Dl extattrctl enable / system md5 /.attribute/system/md5 +.Pp +Enable an attribute named md5 on the root file system, backed from the file +.Pa /.attribute/system/md5 . +.Pp +.Dl extattrctl disable / system md5 +.Pp +Disable the attribute named md5 on the root file system. +.Pp +.Dl extattrctl stop / +.Pp +Stop extended attributes on the root file system. +.Sh SEE ALSO +.Xr getextattr 1 , +.Xr extattr_get_file 2 , +.Xr extattrctl 2 , +.\" .Xr ffs 7 , +.Xr extattr 9 +.Sh HISTORY +Extended attribute support was developed as part of the TrustedBSD +Project, and introduced in +.Fx 5.0 +and +.Nx 4.0 . +It was developed to support security extensions requiring additional +labels to be associated with each file or directory. +Backing file autocreation was added in +.Nx 6.0 . +.Sh AUTHORS +.An Robert N M Watson +.Sh BUGS +.Nm +works only on UFS1 file systems. +The kernel support for extended attribute backing files and this +control program should be generalized for any file system that +lacks native extended attribute support. diff --git a/static/netbsd/man8/faithd.8 b/static/netbsd/man8/faithd.8 new file mode 100644 index 00000000..f986c4c9 --- /dev/null +++ b/static/netbsd/man8/faithd.8 @@ -0,0 +1,401 @@ +.\" $NetBSD: faithd.8,v 1.29 2012/03/15 22:35:03 njoly Exp $ +.\" $KAME: faithd.8,v 1.37 2002/05/09 14:21:23 itojun Exp $ +.\" +.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the project nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd January 9, 2010 +.Dt FAITHD 8 +.Os +.Sh NAME +.Nm faithd +.Nd FAITH IPv6/v4 translator daemon +.Sh SYNOPSIS +.Nm +.Op Fl dp +.Op Fl f Ar configfile +.Ar service +.Op Ar serverpath Op Ar serverargs +.Nm +.Sh DESCRIPTION +The +.Nm +utility provides IPv6-to-IPv4 TCP relaying. +It can only be used on an IPv4/v6 dual stack router. +.Pp +When +.Nm +receives +.Tn TCPv6 +traffic, it will relay the +.Tn TCPv6 +traffic to +.Tn TCPv4 . +The destination for the relayed +.Tn TCPv4 +connection will be determined by the last 4 octets of the original +.Tn IPv6 +destination. +For example, if +.Li 2001:0db8:4819:ffff:: +is reserved for +.Nm , +and the +.Tn TCPv6 +destination address is +.Li 2001:0db8:4819:ffff::0a01:0101 , +the traffic will be relayed to IPv4 destination +.Li 10.1.1.1 . +.Pp +To use the +.Nm +translation service, +an IPv6 address prefix must be reserved for mapping IPv4 addresses into. +The kernel must be properly configured to route all the TCP connections +toward the reserved IPv6 address prefix into the +.Xr faith 4 +pseudo interface, using the +.Xr route 8 +command. +Also, +.Xr sysctl 8 +should be used to configure +.Dv net.inet6.ip6.keepfaith +to +.Dv 1 . +.Pp +The router must be configured to capture all the TCP traffic +for the reserved +.Tn IPv6 +address prefix, by using +.Xr route 8 +and +.Xr sysctl 8 +commands. +.Pp +The +.Nm +utility needs special name-to-address translation logic, so that +hostnames gets resolved into the special +.Tn IPv6 +address prefix. +For small-scale installations, use +.Xr hosts 5 ; +For large-scale installations, it is useful to have +a DNS server with special address translation support. +An implementation called +.Nm totd +is available at +.Lk http://www.dillema.net/software/totd.html . +Make sure you do not propagate translated DNS records over to normal +DNS, as it can cause severe problems. +.Ss Daemon mode +When +.Nm +is invoked as a standalone program, +.Nm +will daemonize itself. +.Nm +will listen to +.Tn TCPv6 +port +.Ar service . +If +.Tn TCPv6 +traffic to port +.Ar service +is found, it relays the connection. +.Pp +Since +.Nm +listens to TCP port +.Ar service , +it is not possible to run local TCP daemons for port +.Ar service +on the router, using +.Xr inetd 8 +or other standard mechanisms. +By specifying +.Ar serverpath +to +.Nm , +you can run local daemons on the router. +The +.Nm +utility will invoke ia local daemon at +.Ar serverpath +if the destination address is a local interface address, +and will perform translation to IPv4 TCP in other cases. +You can also specify +.Ar serverargs +for the arguments for the local daemon. +.Pp +The following options are available: +.Bl -tag -width indent +.It Fl d +Debugging information will be generated using +.Xr syslog 3 . +.It Fl f Ar configfile +Specify a configuration file for access control. +See below. +.It Fl p +Use privileged TCP port number as source port, +for IPv4 TCP connection toward final destination. +For relaying +.Xr ftp 1 +this flag is not necessary as special program code is supplied. +.El +.Pp +.Nm +will relay both normal and out-of-band TCP data. +It is capable of emulating TCP half close as well. +.Nm +includes special support for protocols used by +.Xr ftp 1 . +When translating the FTP protocol, +.Nm +translates network level addresses in +.Li PORT/LPRT/EPRT +and +.Li PASV/LPSV/EPSV +commands. +.Pp +Inactive sessions will be disconnected in 30 minutes, +to prevent stale sessions from chewing up resources. +This may be inappropriate for some services +.Pq should this be configurable? . +.Ss inetd mode +When +.Nm +is invoked via +.Xr inetd 8 , +.Nm +will handle connections passed from standard input. +If the connection endpoint is in the reserved IPv6 address prefix, +.Nm +will relay the connection. +Otherwise, +.Nm +will invoke a service-specific daemon like +.Xr telnetd 8 , +by using the command argument passed from +.Xr inetd 8 . +.Pp +.Nm +determines operation mode by the local TCP port number, +and enables special protocol handling whenever necessary/possible. +For example, if +.Nm +is invoked via +.Xr inetd 8 +on the FTP port, it will operate as an FTP relay. +.\".Pp +.\"The operation mode requires special support for +.\".Nm +.\"in +.\".Xr inetd 8 . +.Ss Access control +To prevent malicious access, +.Nm +implements a simple address-based access control. +With +.Pa /etc/faithd.conf +.Po +or +.Ar configfile +specified by +.Fl f +.Pc , +.Nm +will avoid relaying unwanted traffic. +The +.Pa faithd.conf +configuration file contains directives of the following format: +.Bl -bullet +.It +.Xo +.Ar src/slen Li deny Ar dst/dlen +.Xc +.Pp +If the source address of a query matches +.Ar src/slen , +and the translated destination address matches +.Ar dst/dlen , +deny the connection. +.It +.Xo +.Ar src/slen Li permit Ar dst/dlen +.Xc +.Pp +If the source address of a query matches +.Ar src/slen , +and the translated destination address matches +.Ar dst/dlen , +permit the connection. +.El +.Pp +The directives are evaluated in sequence, +and the first matching entry will be effective. +If there is no match +.Pq if we reach the end of the ruleset +the traffic will be denied. +.Pp +With inetd mode, +traffic may be filtered by using access control functionality in +.Xr inetd 8 . +.Sh EXIT STATUS +.Nm +exits with +.Dv EXIT_SUCCESS +.Pq 0 +on success, and +.Dv EXIT_FAILURE +.Pq 1 +on error. +.Sh EXAMPLES +Before invoking +.Nm , +the +.Xr faith 4 +interface has to be configured properly. +.Bd -literal +# sysctl -w net.inet6.ip6.accept_rtadv=0 +# sysctl -w net.inet6.ip6.forwarding=1 +# sysctl -w net.inet6.ip6.keepfaith=1 +# ifconfig faith0 create up +# route add -inet6 2001:0db8:4819:ffff:: -prefixlen 96 ::1 +# route change -inet6 2001:0db8:4819:ffff:: -prefixlen 96 -ifp faith0 +.Ed +.Ss Daemon mode samples +To translate +.Li telnet +service, and provide no local telnet service, invoke +.Nm +as follows: +.Bd -literal +# faithd telnet +.Ed +.Pp +If you would like to provide local telnet service via +.Xr telnetd 8 +on +.Pa /usr/libexec/telnetd , +use the following command line: +.Bd -literal +# faithd telnet /usr/libexec/telnetd telnetd +.Ed +.Pp +If you would like to pass extra arguments to the local daemon: +.Bd -literal +# faithd ftp /usr/libexec/ftpd ftpd -l +.Ed +.Pp +Here are some other examples. +You may need +.Fl p +if the service checks the source port range. +.Bd -literal +# faithd ssh +# faithd telnet /usr/libexec/telnetd telnetd +.Ed +.Ss inetd mode samples +Add the following lines into +.Xr inetd.conf 5 . +.\"Syntax may vary depending upon your operating system. +.Bd -literal +telnet stream faith/tcp6 nowait root faithd telnetd +ftp stream faith/tcp6 nowait root faithd ftpd -l +ssh stream faith/tcp6 nowait root faithd /usr/sbin/sshd -i +.Ed +.Pp +.Xr inetd 8 +will open listening sockets with kernel TCP relay support enabled. +Whenever a connection comes in, +.Nm +will be invoked by +.Xr inetd 8 . +If the connection endpoint is in the reserved IPv6 address prefix. +.Nm +will relay the connection. +Otherwise, +.Nm +will invoke service-specific daemon like +.Xr telnetd 8 . +.Ss Access control samples +The following illustrates a simple +.Pa faithd.conf +setting. +.Bd -literal +# permit anyone from 2001:0db8:ffff::/48 to use the translator, +# to connect to the following IPv4 destinations: +# - any location except 10.0.0.0/8 and 127.0.0.0/8. +# Permit no other connections. +# +2001:0db8:ffff::/48 deny 10.0.0.0/8 +2001:0db8:ffff::/48 deny 127.0.0.0/8 +2001:0db8:ffff::/48 permit 0.0.0.0/0 +.Ed +.Sh SEE ALSO +.Xr faith 4 , +.Xr route 8 , +.Xr sysctl 8 , +.Pa pkgsrc/net/totd +.Rs +.%A Jun-ichiro itojun Hagino +.%A Kazu Yamamoto +.%T "An IPv6-to-IPv4 transport relay translator" +.%B RFC 3142 +.%U http://www.ietf.org/rfc/rfc3142.txt +.%D June 2001 +.Re +.\" +.Sh HISTORY +The +.Nm +utility first appeared in the WIDE Hydrangea IPv6 protocol stack kit. +.\" +.Sh SECURITY CONSIDERATIONS +It is very insecure to use IP-address based authentication, for connections relayed by +.Nm , +and any other TCP relaying services. +.Pp +Administrators are advised to limit accesses to +.Nm +using +.Pa faithd.conf , +or by using IPv6 packet filters, to protect the +.Nm +service from malicious parties, and to avoid theft of service/bandwidth. +IPv6 destination addresses can be limited by +carefully configuring routing entries that point to +.Xr faith 4 , +using +.Xr route 8 . +The IPv6 source address needs to be filtered using packet filters. +The documents listed in +.Sx SEE ALSO +have more information on this topic. diff --git a/static/netbsd/man8/fanoutfs.8 b/static/netbsd/man8/fanoutfs.8 new file mode 100644 index 00000000..3021e112 --- /dev/null +++ b/static/netbsd/man8/fanoutfs.8 @@ -0,0 +1,61 @@ +.\" $NetBSD: fanoutfs.8,v 1.3 2007/09/11 23:26:13 wiz Exp $ +.\" +.\" Copyright © 2007 Alistair Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd March 26, 2007 +.Dt FANOUTFS 8 +.Os +.Sh NAME +.Nm fanoutfs +.Nd fan out file system implementation for refuse and puffs +.Sh SYNOPSIS +.Nm +.Op Fl v +.Op Fl f Ar configfile +.Ar mount_point +.Sh DESCRIPTION +The +.Nm +utility can be used to mount a number of directories under one +mount point. +This kind of file system is traditionally known as a +fanout +file system, and also as a +union +file system. +.Pp +The mandatory parameters is +the local mount +point. +.Sh SEE ALSO +.Xr puffs 3 , +.Xr refuse 3 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 5.0 . diff --git a/static/netbsd/man8/fastboot.8 b/static/netbsd/man8/fastboot.8 new file mode 100644 index 00000000..b7b40fc3 --- /dev/null +++ b/static/netbsd/man8/fastboot.8 @@ -0,0 +1,67 @@ +.\" $NetBSD: fastboot.8,v 1.13 2003/08/07 10:04:15 agc Exp $ +.\" +.\" Copyright (c) 1983, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)fastboot.8 8.1 (Berkeley) 6/5/93 +.\" +.Dd June 5, 1993 +.Dt FASTBOOT 8 +.Os +.Sh NAME +.Nm fastboot , +.Nm fasthalt +.Nd "reboot/halt the system without checking the disks" +.Sh SYNOPSIS +.Nm +.Op Ar boot-options +.Nm fasthalt +.Op Ar halt-options +.Sh DESCRIPTION +.Nm +and +.Nm fasthalt +are shell scripts which reboot or halt the system, and when next +started, the system will skip the normal the file systems checks. +This is done by creating a file +.Pa /fastboot , +then invoking the +.Xr reboot 8 +program. +The system startup script, +.Pa /etc/rc , +looks for this file and, if present, skips the normal invocation of +.Xr fsck 8 . +.Sh SEE ALSO +.Xr halt 8 , +.Xr rc 8 , +.Xr reboot 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.2 . diff --git a/static/netbsd/man8/fdisk.8 b/static/netbsd/man8/fdisk.8 new file mode 100644 index 00000000..2006211f --- /dev/null +++ b/static/netbsd/man8/fdisk.8 @@ -0,0 +1,664 @@ +.\" $NetBSD: fdisk.8,v 1.93 2025/01/03 16:16:14 rillig Exp $ +.\" +.Dd January 3, 2025 +.Dt FDISK 8 +.Os +.Sh NAME +.Nm fdisk +.Nd MS-DOS partition maintenance program +.Sh SYNOPSIS +.Nm +.Op Fl aBFfgIiSuv +.Oo +.Fl 0 | 1 | 2 | 3 | E Ar number +.Op Fl s Oo Ar id Oc Ns Oo / Ns Oo Ar start Oc Ns Oo / Ns Oo Ar size Oc Ns Oo / Ns Oo Ar bootmenu Oc Oc Oc Oc +.Oc +.Op Fl r Ar bootfile | Fl w Ar bootfile +.Op Fl A Ar ptn_alignment Ns Bq Ar /ptn_0_offset +.Op Fl b Ar cylinders/heads/sectors +.Op Fl c Ar bootcode +.Op Fl z Ar sectorsize +.Op Ar device +.Nm +.Fl l +.Sh DESCRIPTION +The +.Nm +program is used to display or update the +.Em "master boot record" +or +.Em MBR +in the first sector (sector 0) +of a disk that uses the MBR style of partitioning. +The following +.Nx +ports use this style of disk partitioning: +amd64, arc, bebox, cobalt, hpcarm, hpcmips, hpcsh, i386, macppc, +mvmeppc, netwinder, ofppc, playstation2, and prep. +.Pp +The MBR contains bootable code, a partition table, +an indication of which partition is +.Sq active , +and (optionally, depending on the boot code) a menu +for selecting a partition to be booted. +There can be at most 4 partitions defined in sector 0, +one of which can be an extended +partition which can be split into any number of sub-partitions (then called +logical partitions). +.Pp +The boot code in the MBR is usually invoked by the BIOS or firmware, +and the MBR passes control to the next stage boot code +stored in the first sector of the partition to be booted +(the +.Em "partition boot record" +or +.Em PBR ) . +.Pp +After booting, +.Nx +does not use the partitioning done by +.Nm , +instead it uses a +.Nx +disklabel saved in sector 1 of the +.Nx +partition. +See +.Xr mbrlabel 8 +for a way of using information from the MBR +to construct a +.Nx +disklabel. +.Pp +The standard MBR boot code will only boot the +.Sq active +partition. +However, +.Nx +contains additional boot programs which allow the user to +interactively select which of the partitions to boot. +The +.Sq mbr_ext +code will also boot +.Nx +from an extended partition but will not work on old systems that do not +support LBA reads, the +.Sq mbr_com0 +and +.Sq mbr_com0_9600 +will read and write from a serial port. +At the start the +.Nm +program will determine whether the disk sector 0 is valid as a boot sector. +(This is determined by checking the magic number.) +If not, +.Nm +will initialise the boot code as well as the partition table. +During this, all four partitions will be marked empty. +.Pp +The flags +.Fl a , +.Fl i +or +.Fl u +are used to indicate that the partition data is to be updated. +The +.Nm +program will enter an interactive conversational mode. +This mode is designed not to change any data unless you explicitly tell it to; +.Nm +selects defaults for its questions to guarantee that behaviour. +.Pp +If partition data is going to be updated and the disk carries GUID Partition +Tables, +.Nm +will remove both primary and backup GPT headers from the disk unless the +.Fl g +flag is specified. +See +.Xr gpt 8 +for information on how to manipulate GUID Partition Tables. +.Pp +.Nm +will calculate the correct +.Em cylinder , +.Em head , +and +.Em sector +values for any partition you edit. +If you specify +.Fl v +you will be asked whether you want to specify them yourself. +.Pp +Finally, when all the data for the first sector has been accumulated, +.Nm +will ask if you really want to write the new partition table. +Only if you reply affirmatively to this question will +.Nm +write anything to the disk. +.Pp +Available options: +.Bl -tag -width Ds +.It Fl 0 +Specify partition slot 0 to be printed or updated. +.It Fl 1 +Specify partition slot 1 to be printed or updated. +.It Fl 2 +Specify partition slot 2 to be printed or updated. +.It Fl 3 +Specify partition slot 3 to be printed or updated. +.It Fl A Ar ptn_alignment Ns Bq Ar /ptn_0_offset +Specify the alignment for all partitions and optionally the offset for the +first partition of the disk and of logical partitions. +If +.Ar ptn_alignment +is specified and +.Ar ptn_0_offset +is not specified, then the offset is set to the alignment. +If +.Fl A +is not specified, then the alignment of the first partition is inspected. +If it ends on a 2048 sector boundary, then the alignment is set to 2048, +if the start is a power of 2 less than, or equal to 2048 then the offset +is set to the start sector. +If the first partition is not defined then the alignment and offset for disks +larger than 128GB is set to 2048 (1MB). +In all other cases the alignment default to a cylinder +and the offset to a track (both using the BIOS geometry). +The 1MB alignment is the same as that used by recent windows versions. +.It Fl a +Change the active partition. +In interactive mode this question will be asked after the partitions +have been processed. +.It Fl B +On an i386 or amd64 system, interactively update the boot selector settings. +These include the default boot partition and the timeout value for the prompt. +(The boot selector permits the user to interactively select the boot +partition, and thus which operating system is run, at system boot time; see +.Xr x86/mbr 8 +for more information.) +.It Fl b Ar cylinders/heads/sectors +Specify the BIOS geometry parameters for +.Ar cylinders , +.Ar heads , +and +.Ar sectors . +It is used only in conjunction with the +.Fl u +flag. +If not specified the BIOS geometry will be obtained using sysctl (i386 and +amd64) or by solving the simultaneous equations from the existing partition +information. +If that fails then either the geometry from the disklabel or 63 sectors and +16 heads is used. +For modern disks larger than about 8GB, and where the BIOS is configured +to use LBA-Assisted translation, a setting of +.Fl b Ar 1023/255/63 +is likely to work. +.\" see http://web.inter.nl.net/hcc/J.Steunebrink/bioslim.htm#LBA +.\" for a table of C/H/S values used in LBA-Assisted translation mode +.It Fl c Ar bootcode +Specify the filename that +.Nm +should read the bootcode from. +If the name of a directory is specified, then +.Nm +will look for files with the default names in that directory. +The default is to read from +.Pa /usr/mdec/mbr , +.Pa /usr/mdec/mbr_bootsel +or +.Pa /usr/mdec/mbr_ext +depending on whether +.Ar bootmenu +was specified for any partitions +on an i386 machine, and leave the bootcode empty for other +machines. +.It Fl E Ar number +Specify logical partition +.Ar number +to be printed or updated. +If the specified logical partition does not exist on updating partition data +an additional logical partition will be created. +.It Fl F +Indicate that +.Ar device +is a regular file. +.Nm +will count the 512-byte sectors in +.Ar device +and produce a fake geometry. +If +.Ar device +is a regular file, +.Fl F +will be used implicitly. +.It Fl f +Run +.Nm +in a non-interactive mode. +In this mode, you can only change the disk parameters by using the +.Fl b +flag. +This is provided only so scripts or other programs may use +.Nm +as part of an automatic installation process. +.Pp +Using the +.Fl f +flag with +.Fl u +makes it impossible to specify the starting and ending +.Ar cylinder , +.Ar head , +and +.Ar sector +fields +.Pq only Ar start No and Ar size No can be specified by Fl s No option . +They will be automatically computed using the BIOS geometry. +.It Fl g +Preserve existing GPT headers when updating partitions. +.It Fl I +Ignore errors from overlapping partitions. +Some devices (cameras CHDK) require overlapping partitions to support +bigger than 4GB cards. +The +.Fl I +flag ignores overlapping error checks and does not fix them, allowing these +incorrect configurations to be used. +.It Fl i +Explicitly request initialisation of the master boot code +(similar to what +.Ic fdisk /mbr +does under +.Tn MS-DOS ) , +even if the magic number in the first sector is ok. +The partition table is left alone by this (but see above). +.It Fl l +Lists known +.Em sysid +values and exit. +.It Fl r Ar bootfile +Read the boot record from file +.Ar bootfile +instead of the specified disk. +The geometry information used is still that of the disk volume. +Any changes are written back to the file. +.It Fl S +When used with no other flags print a series of +.Pa /bin/sh +commands for setting variables to the partition information. +This could be used by installation scripts. +.It Fl s Oo Ar id Oc Ns Oo / Ns Oo Ar start Oc Ns Oo / Ns Oo Ar size Oc Ns Oo / Ns Oo Ar bootmenu Oc Oc Oc Oc +Specify the partition +.Ar id , +.Ar start , +.Ar size , +and +.Ar bootmenu . +If the optional arguments are not provided, they stay as before or +use the same defaults as the interactive mode, if new. +This flag requires the use of a partition selection flag +.Pq Fl 0 , 1 , 2 , 3 , No or Fl E Ar number . +.It Fl u +Update partition data, including +.Em id , start , No and Em size . +Unless +.Fl f +option +.Pq non-interactive mode +is specified, +.Nm +will display the partitions and interactively ask which one you want to edit. +.Nm +will step through each field showing the old value and asking for a new one. +The +.Em start +and +.Em size +can be specified in blocks (NN), +cylinders (NNc or NNcyl), +megabytes (NNm or NNMB), +or gigabytes (NNg or NNGB), values in megabytes and gigabytes +will be rounded to the nearest cylinder boundary. +The +.Em size +may be specified as +.Em $ +in which case the partition will extend to the end of the available free space. +.Pp +In a non-interactive mode +.Pq specified by Fl f No option , +partition data should be specified by +.Fl s +option. +A partition selection option +.Pq Fl 0 , 1 , 2 , 3 , No or Fl E Ar number +should also be specified to select a partition slot to be updated. +.Pp +.Nm +will not allow you to create partitions which overlap. +If +.Fl u +and +.Fl s +are specified in a non-interactive mode +then the details of the specified partition will be changed. +Any other partitions which overlap the requested part of the disk will be +silently deleted. +.Pp +If +.Em bootmenu +is specified for any partition +.Nm +will determine whether the installed boot code supports the bootselect code, +if it does not you will be asked whether you want to install the required +boot code. +To remove a +.Em bootmenu +label, simply press +.Aq space +followed by +.Aq return . +.It Fl v +Be more verbose, specifying +.Fl v +more than once may increase the amount of output. +.Pp +Using +.Fl v +with +.Fl u +allows the user to change more parameters than normally permitted. +.It Fl w Ar bootfile +Write the modified partition table to file +.Ar bootfile +instead of the disk. +.It Fl z Ar sectorsize +Specify a sector size other than 512, for devices that only +support larger sector sizes. +The sector size needs to be a power of two greater than 512. +.El +.Pp +When called with no arguments, it prints the partition table. +An example follows: +.Bd -literal + Disk: /dev/rwd0d + NetBSD disklabel disk geometry: + cylinders: 16383, heads: 16, sectors/track: 63 (1008 sectors/cylinder) + total sectors: 40032696 + + BIOS disk geometry: + cylinders: 1023, heads: 255, sectors/track: 63 (16065 sectors/cylinder) + total sectors: 40032696 + + Partition table: + 0: NetBSD (sysid 169) + bootmenu: net 1.5. + start 4209030, size 8289540 (4048 MB, Cyls 262-778), Active + 1: Primary DOS with 32 bit FAT (sysid 11) + bootmenu: win98 + start 63, size 4208967 (2055 MB, Cyls 0-262) + 2: NetBSD (sysid 169) + bootmenu: current + start 32515560, size 7517136 (3670 MB, Cyls 2024-2491/234/40) + 3: Ext. partition - LBA (sysid 15) + start 12498570, size 20016990 (9774 MB, Cyls 778-2024) + Extended partition table: + E0: NetBSD (sysid 169) + bootmenu: test + start 12498633, size 12305727 (6009 MB, Cyls 778-1544) + E1: Primary DOS with 32 bit FAT (sysid 11) + start 24804423, size 4096512 (2000 MB, Cyls 1544-1799) + E2: Primary DOS with 32 bit FAT (sysid 11) + start 28900998, size 3614562 (1765 MB, Cyls 1799-2024) + Bootselector enabled, infinite timeout. + First active partition: 0 +.Ed +.Pp +This example disk is divided into four partitions, the last of which is +an extended partition. +The logical partitions of the extended partition are also shown. +In this case there is no free space in either the disk or in the extended +partition. +.Pp +The various fields in each partition entry are: +.Bd -filled -offset 4n -compact +.Em ptn_number : id_name +(sysid +.Em id_number ) +.Ed +.Bd -filled -offset 8n -compact +bootmenu: +.Em bootmenu +.br +start +.Em start , +size +.Em size ( MB +MB, Cyls +.Em first Ns No - Ns Em next ) +.Op , Active +.Ed +.Bl -tag -width "bootmenu" +.It Em ptn_number +is the number of the partition. +.It Em id_name +is the name of the filesystem type or operating system that uses this partition. +.It Em id_number +is the number that identifies the partition type. +169 decimal is used for +.Nx +partitions, +15 decimal to create an extended partition +and 0 to mark a partition as unused. +Use +.Nm +.Fl l +to list the known partition types. +.It Em bootmenu +is the menu prompt output by the interactive boot code for this partition. +This line is omitted if the prompt is not defined. +.It Em start , Em size +are the start address and size of the partition in sectors. +.It Em MB +is the size of the partition in megabytes. +.It Em first , Em next +are the bounds of this partition displayed as cylinder/head/sector. +If the partition starts (or ends) on a cylinder boundary the head and +sector values are omitted. +If +.Fl v +is not specified the start of logical partitions and the first partition +on the disk are rounded down to include the mandatory red tape in the +preceding track. +.It Active +is output if this is the active partition. +.El +.Pp +If the +.Fl v +flag is specified, the beginning and end of each partition are also +displayed as follows: +.Bd -filled -offset 4n -compact +beg: cylinder +.Em cylinder , +head +.Em head , +sector +.Em sector +.br +end: cylinder +.Em cylinder , +head +.Em head , +sector +.Em sector +.Ed +.Bl -tag -width "bootmenu" +.It Em "cylinder" , Em "head" , Em "sector" +are the beginning or ending address of a partition. +.Pp +.Em Note : +these numbers are read from the bootblock, so are the values calculated +by a previous run of +.Nm . +.El +.Pp +.Nm +attempts to check whether each partition is bootable, +by checking the magic number and some other characteristics +of the first sector of each partition (the PBR). +If the partition does not appear to be bootable, +.Nm +will print a line containing +.Dq "PBR is not bootable" +followed by an error message. +If the partition is bootable, and if the +.Fl v +flag is specified, +.Nm +will print +.Dq "PBR appears to be bootable" . +If the +.Fl v +flag is specified more than once, +.Nm +will print the heading +.Dq "Information from PBR:" +followed by one or more lines of information gleaned from the PBR; +this additional information may be incorrect or misleading, +because different operating systems use different PBR formats. +Note that, even if no errors are reported, an attempt to boot +from the partition might fail. +.Nx +partitions may be made bootable using +.Xr installboot 8 . +.Sh NOTES +This program is only available (and useful) on systems with PC-platform-style +MBR partitioning. +.Pp +Traditionally the partition boundaries should be on cylinder boundaries +using the BIOS geometry, with the exception of the first partition, +which traditionally begins in the second track of the first cylinder +(cylinder 0, head 1, sector 1). +Although the BIOS geometry is typically different from the geometry +reported by the drive, neither will match the actual physical geometry +for modern disks (the actual geometry will vary across the disk). +Keeping the partition boundaries on cylinder boundaries makes partitioning +a driver easier as only relatively small numbers need be entered. +.Pp +The automatic calculation of the starting cylinder and +other parameters uses +a set of figures that represent what the BIOS thinks is the +geometry of the drive. +The default values should be correct for the system on which +.Nm +is run; however, if you move the disk to a different system, the +BIOS of that system might use a different geometry translation. +.Pp +If you run the equivalent of +.Nm +on a different operating system then the +.Ar bootmenu +strings associated with extended partitions may be lost. +.Pp +Editing an existing partition is risky, and may cause you to +lose all the data in that partition. +.Pp +You should run this program interactively once or twice to see how it works. +This is completely safe as long as you answer the last question in the negative. +You can also specify +.Fl w Ar bootfile +to write the output to a file and later specify +.Fl r Ar bootfile +to read back the updated information. +This can be done without having write access to the disk volume. +.Sh FILES +.Bl -tag -width /usr/mdec/mbrxxxxxxxx -compact +.It Pa /usr/mdec/mbr +Default location of i386 bootcode +.It Pa /usr/mdec/mbr_bootsel +Default location of i386 bootselect code +.It Pa /usr/mdec/mbr_ext +Default location of i386 bootselect for extended partitions (i.e., +.Nx +on logical partitions) +.El +.Sh EXAMPLES +Update MBR partition data of +.Pa /dev/rwd0d +in interactive mode: +.Pp +.Dl Ic fdisk -u /dev/rwd0d +.Pp +Change active MBR partition of +.Pa /dev/rwd0d +in interactive mode: +.Pp +.Dl Ic fdisk -a /dev/rwd0d +.Pp +Install MBR bootcode +.Pa /usr/mdec/mbr_bootsel +into +.Pa /dev/rwd0d : +.Pp +.Dl Ic fdisk -c /usr/mdec/mbr_bootsel /dev/rwd0d +.Pp +Set MBR partition data for slot 0 of +.Pa /dev/rwd0d +specifying values without prompt: +.Pp +.Dl Ic fdisk -f -u -0 -s 169/63/2097089 /dev/rwd0d +.Pp +Make partition slot 0 of +.Pa /dev/rwd0d +active without prompt: +.Pp +.Dl Ic fdisk -f -a -0 /dev/rwd0d +.Pp +Initialize and create MBR partition data using bootcode +.Pa destdir/usr/mdec/mbr +without prompt against 1GB disk image file +.Pa diskimg : +.Pp +.Dl Ic fdisk -f -i -b 130/255/63 -c destdir/usr/mdec/mbr -F diskimg +.Pp +Create MBR partition data for slot 0 which has an active +.Nx +partition using whole disk without prompt against 1GB disk image file +.Pa diskimg : +.Pp +.Dl Ic fdisk -f -a -u -0 -s 169/63/2097089 -F diskimg +.Sh SEE ALSO +.Xr disktab 5 , +.Xr boot 8 , +.Xr disklabel 8 , +.Xr gpt 8 , +.Xr installboot 8 , +.Xr mbrlabel 8 , +.Xr x86/mbr 8 +.Sh HISTORY +A version of +.Nm +first appeared in the Mach Operating System. +It was subsequently ported to +.Bx 386 . +.Sh AUTHORS +.An -nosplit +.Nm +for Mach Operating System was written by +.An Robert Baron Aq Mt rvb@cs.cmu.edu . +It was ported to +.Bx 386 +by +.An Julian Elischer Aq Mt julian@tfs.com . +.Sh BUGS +The word +.Sq partition +is used to mean both an MBR partition and a +.Nx +partition, sometimes in the same sentence. +.Pp +There are subtleties that the program detects that are not explained in +this manual page. diff --git a/static/netbsd/man8/fingerd.8 b/static/netbsd/man8/fingerd.8 new file mode 100644 index 00000000..f8d65364 --- /dev/null +++ b/static/netbsd/man8/fingerd.8 @@ -0,0 +1,176 @@ +.\" $NetBSD: fingerd.8,v 1.22 2016/12/24 05:40:49 abhinav Exp $ +.\" +.\" Copyright (c) 1980, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)fingerd.8 8.1 (Berkeley) 6/4/93 +.\" +.Dd September 12, 2002 +.Dt FINGERD 8 +.Os +.Sh NAME +.Nm fingerd +.Nd remote user information server +.Sh SYNOPSIS +.Nm +.Op Fl 8ghlmpSsu +.Op Fl P Ar filename +.Sh DESCRIPTION +.Nm +is a simple protocol based on RFC 1288 +that provides an interface to the +.Xr finger 1 +program at several network sites. +The program is supposed to return a friendly, +human-oriented status report on either the system at the moment +or a particular person in depth. +There is no required format and the +protocol consists mostly of specifying a single +.Dq command line . +.Pp +.Nm +is started by +.Xr inetd 8 , +which listens for +.Tn TCP +requests at port 79. +Once handed a connection, +.Nm +reads a single command line +terminated by a +.Aq Tn CRLF +which it then passes to +.Xr finger 1 . +.Nm +closes its connections as soon as the output is finished. +.Pp +If the line is null (i.e., just a +.Aq Tn CRLF +is sent) then +.Xr finger 1 +returns a +.Dq default +report that lists all people logged into +the system at that moment. +.Pp +If a user name is specified (e.g., +.Pf eric Aq Tn CRLF ) +then the +response lists more extended information for only that particular user, +whether logged in or not. +Allowable +.Dq names +in the command line include both +.Dq login names +and +.Dq user names . +If a name is ambiguous, all possible derivations are returned. +.Pp +The following options may be passed to +.Nm +as server program arguments in +.Pa /etc/inetd.conf : +.Bl -tag -width XPXfilenameX +.It Fl 8 +Enable 8-bit output. +.It Fl g +Do not show any gecos information besides the users' real names. +.It Fl h +Display the name of the remote host in short mode, +instead of the office location and office phone. +.It Fl l +Enable logging. +The name of the host originating the query, and the actual request +is reported via +.Xr syslog 3 +at LOG_NOTICE priority. +A request of the form +.Sq /W +or +.Sq /w +will return long output. +Empty requests will return all currently logged in users. +All other requests look for specific users. +See RFC 1288 for details. +.It Fl m +Prevent matching of +.Ar user +names. +.Ar User +is usually a login name; however, matching will also be done on the +users' real names, unless the +.Fl m +option is supplied. +.It Fl P Ar filename +Use an alternate program as the local information provider. +The default local program executed by +.Nm +is +.Xr finger 1 . +By specifying a customized local server, this option allows a system manager +to have more control over what information is provided to remote sites. +.It Fl p +Prevents +.Xr finger 1 +from displaying the contents of the +.Dq Pa .plan +and +.Dq Pa .project +files. +.It Fl S +Prints user information in short mode, one line per user. +This overrides the +.Dq Pa Whois switch +that may be passed in from the remote client. +.It Fl s +Disable forwarding of queries to other remote hosts. +.It Fl u +Queries without a user name are rejected. +.El +.Sh SEE ALSO +.Xr finger 1 , +.Xr inetd 8 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.3 . +.Sh BUGS +Connecting directly to the server from a +.Tn TIP +or an equally narrow-minded +.Tn TELNET Ns -protocol +user program can result +in meaningless attempts at option negotiation being sent to the +server, which will foul up the command line interpretation. +.Nm +should be taught to filter out +.Tn IAC Ns 's +and perhaps even respond +negatively +.Pq Tn IAC WON'T +to all option commands received. diff --git a/static/netbsd/man8/fixmount.8 b/static/netbsd/man8/fixmount.8 new file mode 100644 index 00000000..5a4d0efb --- /dev/null +++ b/static/netbsd/man8/fixmount.8 @@ -0,0 +1,172 @@ +.\" $NetBSD: fixmount.8,v 1.4 2018/04/21 18:34:08 christos Exp $ +.\" +.\" +.\" Copyright (c) 1997-2014 Erez Zadok +.\" Copyright (c) 1990 Jan-Simon Pendry +.\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine +.\" Copyright (c) 1990 The Regents of the University of California. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to Berkeley by +.\" Jan-Simon Pendry at Imperial College, London. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" +.\" File: am-utils/fixmount/fixmount.8 +.\" +.TH FIXMOUNT 8 "21 Apr 2018" +.SH NAME +fixmount \- fix remote mount entries +.SH SYNOPSIS +.B fixmount +[ +.B \-adervq +] +[ +.B \-h +.I name +] +.I host +\&... +.SH DESCRIPTION +.B fixmount +is a variant of +.BR showmount (8) +that can delete bogus mount entries in remote +.BR mountd (8) +daemons. +The actions specified by the options are performed for each +.I host +in turn. +.SH OPTIONS +.TP +.B \-a \-d \-e +These options work as in +.BR showmount (8) +except that only entries pertaining to the local host are printed. +.TP +.B \-r +Removes those remote mount entries on +.I host +that do not correspond to current mounts, i.e., which are left-over +from a crash or are the result of improper mount protocol. +.\" The actuality of mounts is verified using the entries in +.\" .BR /etc/mtab . +.TP +.B \-v +Verify remote mounts. Similar to +.B \-r +except that only a notification message is printed for each bogus entry +found. The remote mount table is not changed. +.TP +.B \-A +Issues a command to the remote mountd declaring that ALL of its filesystems +have been unmounted. This should be used with caution, as it removes all +remote mount entries pertaining to the local system, whether or not any +filesystems are still mounted locally. +.TP +.B \-q +Be quiet. +Suppresses error messages due to timeouts and "Program not registered", +i.e., due to remote hosts not supporting RPC or not running mountd. +.TP +.BI \-h \ name +Pretend the local hostname is +.IR name . +.\" This is useful after the local hostname has been changed and rmtab entries +.\" using the old name remain on a remote machine. +.\" Unfortunately, most mountd's won't be able to successfully handle removal +.\" of such entries, so this option is useful in combination with +.\" .B \-v +.\" only. +.\" .br +This option also saves time as comparisons of remotely recorded and local +hostnames by address are avoided. +.\" .SH FILES +.\" .TP 20 +.\" .B /etc/mtab +.\" List of current mounts. +.\" .TP +.\" .B /etc/rmtab +.\" Backup file for remote mount entries on NFS server. +.SH "SEE ALSO" +.BR showmount (8), +.\" .BR mtab (5), +.\" .BR rmtab (5), +.BR mountd (8C). +.LP +``am-utils'' +.BR info (1) +entry. +.LP +.I "Linux NFS and Automounter Administration" +by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001). +.LP +.I http://www.am-utils.org +.LP +.I "Amd \- The 4.4 BSD Automounter" +.SH BUGS +.\" No attempt is made to verify the information in +.\" .B /etc/mtab +.\" itself. +.\" .PP +.\" Since swap file mounts are not recorded in +.\" .BR /etc/mtab , +.\" a heuristic specific to SunOS is used to determine whether such a mount +.\" is actual (replacing the string "swap" with "root" and verifying the resulting +.\" path). +.\" .PP +.\" Symbolic links on the server will cause the path in the remote entry to differ +.\" from the one in +.\" .BR /etc/mtab . +.\" To catch those cases, a filesystem is also deemed mounted if its +.\" .I local +.\" mount point is identical to the remote entry. +.\" I.e., on a SunOS diskless client, +.\" .B server:/export/share/sunos.4.1.1 +.\" is actually +.\" .BR /usr/share . +.\" Since the local mount point is +.\" .B /usr/share +.\" as well this will be handled correctly. +.\" .PP +.\" There is no way to clear a stale entry in a remote mountd after the +.\" local hostname (or whatever reverse name resolution returns for it) +.\" has been changed. To take care of these cases, +.\" the remote /etc/rmtab file has to be edited and mountd restarted. +.\" .PP +The RPC timeouts for mountd calls can only be changed by recompiling. +The defaults are 2 seconds for client handle creation and 5 seconds for +RPC calls. +.SH AUTHORS +Andreas Stolcke . +.P +Erez Zadok , Computer Science Department, Stony Brook +University, Stony Brook, New York, USA. +.P +Other authors and contributors to am-utils are listed in the +.B AUTHORS +file distributed with am-utils. diff --git a/static/netbsd/man8/flashctl.8 b/static/netbsd/man8/flashctl.8 new file mode 100644 index 00000000..e2edef70 --- /dev/null +++ b/static/netbsd/man8/flashctl.8 @@ -0,0 +1,85 @@ +.\" $NetBSD: flashctl.8,v 1.2 2011/02/27 23:28:12 wiz Exp $ +.\" +.\" Copyright (c) 2011 Department of Software Engineering, +.\" University of Szeged, Hungary +.\" Copyright (c) 2011 Adam Hoka +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by the Department of Software Engineering, University of Szeged, Hungary +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd February 27, 2011 +.Dt FLASHCTL 8 +.Os +.Sh NAME +.Nm flashctl +.Nd a program to manipulate flash devices +.Sh SYNOPSIS +.Nm +.Ar device +.Ar command +.Oo +.Ar arg Oo ... +.Oc +.Oc +.Sh DESCRIPTION +.Nm +could be used to invoke low level operations specific to flash devices. +It is used by specifying a device to manipulate, +the command to perform, and any arguments the command may require. +.Sh DEVICE COMMANDS +The following commands may be used on flash devices: +.Bl -tag -width erase_offset_size +.It Cm badblocks +List the bad blocks on the device. +.It Cm erase Ar offset Ar size +Erase +.Ar size +amount of flash memory from +.Ar offset . +Size could be +.Ar all , +which means the rest of the flash after +.Ar offset +will be erased. +.It Cm identify +Identify the specified device, displaying the device's vendor, product +strings, and the device's capabilities. +.It Cm markbad Ar offset +Mark the block given by its +.Ar offset +as bad. +.El +.Sh SEE ALSO +.Xr flash 4 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 6.0 . +.Sh AUTHORS +The +.Nm +command was written by +.An Adam Hoka . diff --git a/static/netbsd/man8/flush.8 b/static/netbsd/man8/flush.8 new file mode 100644 index 00000000..d04f716e --- /dev/null +++ b/static/netbsd/man8/flush.8 @@ -0,0 +1,185 @@ +.\" $NetBSD: flush.8,v 1.3 2020/03/18 19:05:14 christos Exp $ +.\" +.TH FLUSH 8 +.ad +.fi +.SH NAME +flush +\- +Postfix fast flush server +.SH "SYNOPSIS" +.na +.nf +\fBflush\fR [generic Postfix daemon options] +.SH DESCRIPTION +.ad +.fi +The \fBflush\fR(8) server maintains a record of deferred +mail by destination. +This information is used to improve the performance of the SMTP +\fBETRN\fR request, and of its command\-line equivalent, +"\fBsendmail \-qR\fR" or "\fBpostqueue \-f\fR". +This program expects to be run from the \fBmaster\fR(8) process +manager. + +The record is implemented as a per\-destination logfile with +as contents the queue IDs of deferred mail. A logfile is +append\-only, and is truncated when delivery is requested +for the corresponding destination. A destination is the +part on the right\-hand side of the right\-most \fB@\fR in +an email address. + +Per\-destination logfiles of deferred mail are maintained only for +eligible destinations. The list of eligible destinations is +specified with the \fBfast_flush_domains\fR configuration parameter, +which defaults to \fB$relay_domains\fR. + +This server implements the following requests: +.IP "\fBadd\fI sitename queueid\fR" +Inform the \fBflush\fR(8) server that the message with the specified +queue ID is queued for the specified destination. +.IP "\fBsend_site\fI sitename\fR" +Request delivery of mail that is queued for the specified +destination. +.IP "\fBsend_file\fI queueid\fR" +Request delivery of the specified deferred message. +.IP \fBrefresh\fR +Refresh non\-empty per\-destination logfiles that were not read in +\fB$fast_flush_refresh_time\fR hours, by simulating +send requests (see above) for the corresponding destinations. +.sp +Delete empty per\-destination logfiles that were not updated in +\fB$fast_flush_purge_time\fR days. +.sp +This request completes in the background. +.IP \fBpurge\fR +Do a \fBrefresh\fR for all per\-destination logfiles. +.SH "SECURITY" +.na +.nf +.ad +.fi +The \fBflush\fR(8) server is not security\-sensitive. It does not +talk to the network, and it does not talk to local users. +The fast flush server can run chrooted at fixed low privilege. +.SH DIAGNOSTICS +.ad +.fi +Problems and transactions are logged to \fBsyslogd\fR(8) +or \fBpostlogd\fR(8). +.SH BUGS +.ad +.fi +Fast flush logfiles are truncated only after a "send" +request, not when mail is actually delivered, and therefore can +accumulate outdated or redundant data. In order to maintain sanity, +"refresh" must be executed periodically. This can +be automated with a suitable wakeup timer setting in the +\fBmaster.cf\fR configuration file. + +Upon receipt of a request to deliver mail for an eligible +destination, the \fBflush\fR(8) server requests delivery of all messages +that are listed in that destination's logfile, regardless of the +recipients of those messages. This is not an issue for mail +that is sent to a \fBrelay_domains\fR destination because +such mail typically only has recipients in one domain. +.SH "CONFIGURATION PARAMETERS" +.na +.nf +.ad +.fi +Changes to \fBmain.cf\fR are picked up automatically as \fBflush\fR(8) +processes run for only a limited amount of time. Use the command +"\fBpostfix reload\fR" to speed up a change. + +The text below provides only a parameter summary. See +\fBpostconf\fR(5) for more details including examples. +.IP "\fBconfig_directory (see 'postconf -d' output)\fR" +The default location of the Postfix main.cf and master.cf +configuration files. +.IP "\fBdaemon_timeout (18000s)\fR" +How much time a Postfix daemon process may take to handle a +request before it is terminated by a built\-in watchdog timer. +.IP "\fBfast_flush_domains ($relay_domains)\fR" +Optional list of destinations that are eligible for per\-destination +logfiles with mail that is queued to those destinations. +.IP "\fBfast_flush_refresh_time (12h)\fR" +The time after which a non\-empty but unread per\-destination "fast +flush" logfile needs to be refreshed. +.IP "\fBfast_flush_purge_time (7d)\fR" +The time after which an empty per\-destination "fast flush" logfile +is deleted. +.IP "\fBipc_timeout (3600s)\fR" +The time limit for sending or receiving information over an internal +communication channel. +.IP "\fBmax_idle (100s)\fR" +The maximum amount of time that an idle Postfix daemon process waits +for an incoming connection before terminating voluntarily. +.IP "\fBmax_use (100)\fR" +The maximal number of incoming connections that a Postfix daemon +process will service before terminating voluntarily. +.IP "\fBparent_domain_matches_subdomains (see 'postconf -d' output)\fR" +A list of Postfix features where the pattern "example.com" also +matches subdomains of example.com, +instead of requiring an explicit ".example.com" pattern. +.IP "\fBprocess_id (read\-only)\fR" +The process ID of a Postfix command or daemon process. +.IP "\fBprocess_name (read\-only)\fR" +The process name of a Postfix command or daemon process. +.IP "\fBqueue_directory (see 'postconf -d' output)\fR" +The location of the Postfix top\-level queue directory. +.IP "\fBsyslog_facility (mail)\fR" +The syslog facility of Postfix logging. +.IP "\fBsyslog_name (see 'postconf -d' output)\fR" +A prefix that is prepended to the process name in syslog +records, so that, for example, "smtpd" becomes "prefix/smtpd". +.PP +Available in Postfix 3.3 and later: +.IP "\fBservice_name (read\-only)\fR" +The master.cf service name of a Postfix daemon process. +.SH "FILES" +.na +.nf +/var/spool/postfix/flush, "fast flush" logfiles. +.SH "SEE ALSO" +.na +.nf +smtpd(8), SMTP server +qmgr(8), queue manager +postconf(5), configuration parameters +master(5), generic daemon options +master(8), process manager +postlogd(8), Postfix logging +syslogd(8), system logging +.SH "README FILES" +.na +.nf +.ad +.fi +Use "\fBpostconf readme_directory\fR" or +"\fBpostconf html_directory\fR" to locate this information. +.na +.nf +ETRN_README, Postfix ETRN howto +.SH "LICENSE" +.na +.nf +.ad +.fi +The Secure Mailer license must be distributed with this software. +.SH HISTORY +.ad +.fi +This service was introduced with Postfix version 1.0. +.SH "AUTHOR(S)" +.na +.nf +Wietse Venema +IBM T.J. Watson Research +P.O. Box 704 +Yorktown Heights, NY 10598, USA + +Wietse Venema +Google, Inc. +111 8th Avenue +New York, NY 10011, USA diff --git a/static/netbsd/man8/format.8 b/static/netbsd/man8/format.8 new file mode 100644 index 00000000..13ef53fd --- /dev/null +++ b/static/netbsd/man8/format.8 @@ -0,0 +1,63 @@ +.\" $NetBSD: format.8,v 1.8 2003/08/07 10:31:24 agc Exp $ +.\" +.\" Copyright (c) 1990, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" This code is derived from software contributed to Berkeley by +.\" the Systems Programming Group of the University of Utah Computer +.\" Science Department. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)format.8 8.2 (Berkeley) 1/12/94 +.\" +.Dd January 12, 1994 +.Dt FORMAT 8 hp300 +.Os +.Sh NAME +.Nm format +.Nd how to format disks and tapes +.Sh DESCRIPTION +Currently, there are no +.Dq native +.Nx +media formatting utilities. +Formatting of both disks and cartridge tapes must be done either +stand-alone or under +.Tn HP-UX +using the +.Em mediainit +utility distributed by +.Tn HP . +Note that +.Tn HP Ns -brand +cartridge tapes come pre-formatted, and +.Tn HP +disks are supposed to. +.Sh HISTORY +The +.Nm format +utility first appeared in +.Bx 4.4 . diff --git a/static/netbsd/man8/fsadm.8 b/static/netbsd/man8/fsadm.8 new file mode 100644 index 00000000..fa230185 --- /dev/null +++ b/static/netbsd/man8/fsadm.8 @@ -0,0 +1,63 @@ +.\" $NetBSD: fsadm.8,v 1.3 2009/12/02 00:58:03 haad Exp $ +.\" +.TH "FSADM" "8" "LVM TOOLS 2.02.56(1)-cvs (12-01-09)" "Red Hat, Inc" "\"" +.SH "NAME" +fsadm \- utility to resize or check filesystem on a device +.SH "SYNOPSIS" +.B fsdam +.RI [options]\ check\ device + +.B fsdam +.RI [options]\ resize\ device\ [new_size[BKMGTEP]] + +.SH "DESCRIPTION" +\fBfsadm\fR utility resizes or checks the filesystem on a device. +It tries to use the same API for \fBext2/ext3/ext4\fR, +\fBReiserFS\fR and \fBXFS\fR filesystem. +.SH "OPTIONS" +.TP +\fB\-h \-\-help\fR +\(em print help message +.TP +\fB\-v \-\-verbose\fR +\(em be more verbose +.TP +\fB\-e \-\-ext\-offline\fR +\(em unmount ext2/ext3/ext4 filesystem before doing resize +.TP +\fB\-f \-\-force\fR +\(em bypass some sanity checks +.TP +\fB\-n \-\-dry\-run\fR +\(em print commands without running them +.TP +\fB\-y \-\-yes\fR +\(em answer "yes" at any prompts +.TP +\fBnew_size\fR +\(em Absolute number of filesystem blocks to be in the filesystem, +or an absolute size using a suffix (in powers of 1024). +If new_size is not supplied, the whole device is used. + +.SH "EXAMPLES" +"fsadm \-e \-y resize /dev/vg/test 1000M" tries to resize the filesystem +on logical volume /dev/vg/test. If /dev/vg/test contains ext2/ext3/ext4 +filesystem it will be unmounted prior the resize. +All [y|n] questions will be answered 'y'. +.SH "ENVIRONMENT VARIABLES" +.TP +\fBTMPDIR\fP +Where the temporary directory should be created. +.TP +.BR +.SH "SEE ALSO" +.BR lvm (8), +.BR lvresize (8), +.BR lvm.conf (5), +.BR tune2fs (8), +.BR resize2fs (8), +.BR reiserfstune (8), +.BR resize_reiserfs (8), +.BR xfs_info (8), +.BR xfs_growfs (8), +.BR xfs_check (8) diff --git a/static/netbsd/man8/fsck.8 b/static/netbsd/man8/fsck.8 new file mode 100644 index 00000000..1023f31b --- /dev/null +++ b/static/netbsd/man8/fsck.8 @@ -0,0 +1,186 @@ +.\" $NetBSD: fsck.8,v 1.41 2020/04/18 22:02:11 sevan Exp $ +.\" +.\" Copyright (c) 1996 Christos Zoulas. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd April 18, 2020 +.Dt FSCK 8 +.Os +.Sh NAME +.Nm fsck +.Nd file system consistency check and interactive repair +.Sh SYNOPSIS +.Nm +.Op Fl dfnPpqvy +.Op Fl l Ar maxparallel +.Op Fl T Ar fstype:fsoptions +.Op Fl t Ar fstype +.Op Fl x Ar mountpoint +.Op special | node ... +.Sh DESCRIPTION +The +.Nm +command invokes file system-specific programs to check +the special devices listed in the +.Xr fstab 5 +file or in the command line for consistency. +.Pp +It is normally used in the script +.Pa /etc/rc +during automatic reboot. +If no file systems are specified, and +.Dq preen +mode is enabled ( +.Fl p +option) +.Nm +reads the table +.Pa /etc/fstab +to determine which file systems to check, in what order. +Only partitions in fstab that are mounted ``rw,'' ``rq'' or ``ro'' +and that have non-zero pass number are checked. +File systems with pass number 1 (normally just the root file system) +are checked one at a time. +When pass 1 completes, all remaining file systems are checked, +running one process per disk drive. +By default, file systems which are already mounted read-write are not checked. +The disk drive containing each file system is inferred from the longest prefix +of the device name that ends in a digit; the remaining characters are assumed +to be the partition designator. +.Pp +The options are as follows: +.Bl -tag -width indent +.It Fl d +Debugging mode. +Just print the commands without executing them. +.It Fl f +Force checking of file systems, even when they are marked clean (for file +systems that support this), or when they are mounted read-write. +.It Fl l Ar maxparallel +Limit the number of parallel checks to the number specified in +the following argument. +By default, the limit is the number of disks, running one process per disk. +If a smaller limit is given, the disks are checked round-robin, +one file system at a time. +.It Fl n +Causes +.Nm +to assume no as the answer to all operator questions, except "CONTINUE?". +.It Fl P +Display a progress meter for each file system check. +This option also disables parallel checking. +Note that progress meters are not supported by all file system types. +.It Fl p +Enter preen mode. +In preen mode, +.Nm +will check all file systems listed in +.Pa /etc/fstab +according to their pass number, and will make minor repairs without +human intervention. +.It Fl q +Quiet mode, do not output any messages for clean file systems. +.It Fl T Ar fstype:fsoptions +List of comma separated file system specific options for the specified +file system type, in the same format as +.Xr mount 8 . +.It Fl t Ar fstype +Invoke +.Nm +only for the comma separated list of file system types. +If the list starts with +.Dq no +then invoke +.Nm +for the file system types that are not specified in the list. +.It Fl v +Print the commands before executing them. +.It Fl x Ar mountpoint +Exclude the file system which has a +.Ar mountpoint +the same as in +.Pa /etc/fstab . +Used only in +.Dq preen +mode. +.It Fl y +Causes +.Nm +to assume yes +as the answer to all operator questions. +.El +.Sh FILES +.Bl -tag -width /etc/fstab -compact +.It Pa /etc/fstab +file system table +.El +.Sh EXIT STATUS +.Nm +exits with +.Dv 0 +on success. +Any major problems will cause +.Nm +to exit with the following non-zero +.Xr exit 3 +codes, so as to alert any invoking program or script that human +intervention is required. +.Bl -tag -width XXXX +.It Dv 1 +Usage problem. +.It Dv 2 +Unresolved errors while checking the file system. +Re-running +.Nm +on the file system(s) is required. +.It Dv 4 +The root file system was changed in the process of checking, and updating the +mount was unsuccessful. +A reboot (without sync) is required. +.It Dv 8 +The file system check has failed, and a subsequent check is required +that will require human intervention. +.It Dv 12 +.Nm +exited because of the result of a signal (usually +.Dv SIGINT +or +.Dv SIGQUIT +from the terminal). +.El +.Sh SEE ALSO +.Xr fstab 5 , +.Xr fsck_ext2fs 8 , +.Xr fsck_ffs 8 , +.Xr fsck_lfs 8 , +.Xr fsck_msdos 8 , +.Xr mount 8 +.Sh HISTORY +An +.Nm +utility appeared in +.Bx 4.0 . +It was reimplemented as a file system independent wrapper in +.Nx 1.3 . +The original file system specific utility became +.Xr fsck_ffs 8 +at this point. diff --git a/static/netbsd/man8/fsck_ext2fs.8 b/static/netbsd/man8/fsck_ext2fs.8 new file mode 100644 index 00000000..8ad33210 --- /dev/null +++ b/static/netbsd/man8/fsck_ext2fs.8 @@ -0,0 +1,261 @@ +.\" $NetBSD: fsck_ext2fs.8,v 1.21 2018/08/27 15:16:49 sevan Exp $ +.\" +.\" Copyright (c) 1980, 1989, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" Copyright (c) 1997 Manuel Bouyer. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" @(#)fsck.8 8.3 (Berkeley) 11/29/94 +.\" +.Dd August 27, 2018 +.Dt FSCK_EXT2FS 8 +.Os +.Sh NAME +.Nm fsck_ext2fs +.Nd ext2 File System consistency check and interactive repair +.Sh SYNOPSIS +.Nm +.Op Fl dfnpUy +.Op Fl b Ar block# +.Op Fl m Ar mode +.Ar filesystem ... +.Sh DESCRIPTION +.Nm +performs interactive filesystem consistency checks and repair for each of +the filesystems specified on the command line. +It is normally invoked from +.Xr fsck 8 . +.Pp +The kernel takes care that only a restricted class of innocuous filesystem +inconsistencies can happen unless hardware or software failures intervene. +These are limited to the following: +.Pp +.Bl -item -compact +.It +Unreferenced inodes +.It +Link counts in inodes too large +.It +Missing blocks in the free map +.It +Blocks in the free map also in files +.It +Counts in the super-block wrong +.El +.Pp +These are the only inconsistencies that +.Nm +in +.Dq preen +mode (with the +.Fl p +option) will correct; if it encounters other inconsistencies, it exits +with an abnormal return status. +For each corrected inconsistency one or more lines will be printed +identifying the filesystem on which the correction will take place, +and the nature of the correction. +After successfully correcting a filesystem, +.Nm +will print the number of files on that filesystem +and the number of used and free blocks. +.Pp +If sent a +.Dv QUIT +signal, +.Nm +will finish the filesystem checks, then exit with an abnormal return status. +.Pp +Without the +.Fl p +option, +.Nm +audits and interactively repairs inconsistent conditions for filesystems. +If the filesystem is inconsistent the operator is prompted for concurrence +before each correction is attempted. +It should be noted that some of the corrective actions which are not +correctable under the +.Fl p +option will result in some loss of data. +The amount and severity of data lost may be determined from the diagnostic +output. +The default action for each consistency correction +is to wait for the operator to respond +.Li yes +or +.Li no . +If the operator does not have write permission on the filesystem +.Nm +will default to a +.Fl n +action. +.Pp +The following flags are interpreted by +.Nm . +.Bl -tag -width indent +.It Fl b +Use the block specified immediately after the flag as +the super block for the filesystem. +Block 8193 is usually an alternate super block. +.It Fl d +Print debugging output. +.It Fl f +Force checking of file systems. +Normally, if a file system is cleanly unmounted, the kernel will set a +.Dq clean flag +in the file system superblock, and +.Nm +will not check the file system. +This option forces +.Nm +to check the file system, regardless of the state of the clean flag. +.It Fl m +Use the mode specified in octal immediately after the flag as the +permission bits to use when creating the +.Pa lost+found +directory rather than the default 1777. +In particular, systems that do not wish to have lost files accessible +by all users on the system should use a more restrictive +set of permissions such as 700. +.It Fl n +Assume a no response to all questions asked by +.Nm +except for +.Ql CONTINUE? , +which is assumed to be affirmative; +do not open the filesystem for writing. +.It Fl p +Specify +.Dq preen +mode, described above. +.It Fl U +Resolve numeric userids to usernames. +.It Fl y +Assume a yes response to all questions asked by +.Nm ; +this should be used with great caution as this is a free license +to continue after essentially unlimited trouble has been encountered. +.El +.Pp +Inconsistencies checked are as follows: +.Bl -enum -offset indent -compact +.It +Blocks claimed by more than one inode or the free map. +.It +Blocks claimed by an inode outside the range of the filesystem. +.It +Incorrect link counts. +.It +Size checks: +.Bl -item -offset indent -compact +.It +Directory size not a multiple of filesystem block size. +.It +Partially truncated file. +.El +.It +Bad inode format. +.It +Blocks not accounted for anywhere. +.It +Directory checks: +.Bl -item -offset indent -compact +.It +File pointing to unallocated inode. +.It +Inode number out of range. +.It +Dot or dot-dot not the first two entries of a directory +or having the wrong inode number. +.El +.It +Super Block checks: +.Bl -item -offset indent -compact +.It +More blocks for inodes than there are in the filesystem. +.It +Bad free block map format. +.It +Total free block and/or free inode count incorrect. +.El +.El +.Pp +Orphaned files and directories (allocated but unreferenced) are, +with the operator's concurrence, reconnected by +placing them in the +.Pa lost+found +directory. +The name assigned is the inode number. +If the +.Pa lost+found +directory does not exist, it is created. +If there is insufficient space its size is increased. +.Pp +Because of inconsistencies between the block device and the buffer cache, +the raw device should always be used. +.Sh DIAGNOSTICS +The diagnostics produced by +.Nm +are fully enumerated and explained in Appendix A of +.Rs +.%T "Fsck \- The UNIX File System Check Program" +.Re +.Sh SEE ALSO +.Xr fs 5 , +.Xr fstab 5 , +.Xr fsck 8 , +.Xr fsdb 8 , +.Xr newfs 8 , +.Xr reboot 8 +.Sh HISTORY +A +.Nm +utility appeared in +.Nx 1.3 . +.Sh AUTHORS +.Nm +was written by +.An Manuel Bouyer Aq Mt bouyer@NetBSD.org . diff --git a/static/netbsd/man8/fsck_ffs.8 b/static/netbsd/man8/fsck_ffs.8 new file mode 100644 index 00000000..d182e3c0 --- /dev/null +++ b/static/netbsd/man8/fsck_ffs.8 @@ -0,0 +1,408 @@ +.\" $NetBSD: fsck_ffs.8,v 1.52 2022/11/17 06:40:38 chs Exp $ +.\" +.\" Copyright (c) 1980, 1989, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)fsck.8 8.3 (Berkeley) 11/29/94 +.\" +.Dd May 4, 2018 +.Dt FSCK_FFS 8 +.Os +.Sh NAME +.Nm fsck_ffs +.Nd Fast File System consistency check and interactive repair +.Sh SYNOPSIS +.Nm +.Op Fl adFfPpqUXz +.Op Fl B Ar byteorder +.Op Fl b Ar block +.Op Fl c Ar level +.Op Fl m Ar mode +.Op Fl x Ar snap-backup +.Op Fl y | n +.Ar filesystem ... +.Sh DESCRIPTION +.Nm +performs interactive file system consistency checks and repair for each of +the file systems specified on the command line. +It is normally invoked from +.Xr fsck 8 . +.Pp +The kernel takes care that only a restricted class of innocuous file system +inconsistencies can happen unless hardware or software failures intervene. +These are limited to the following: +.Pp +.Bl -item -compact -offset indent +.It +Unreferenced inodes +.It +Link counts in inodes too large +.It +Missing blocks in the free map +.It +Blocks in the free map also in files +.It +Counts in the super-block wrong +.El +.Pp +These are the only inconsistencies that +.Nm +in +.Dq preen +mode (with the +.Fl p +option) will correct; if it encounters other inconsistencies, it exits +with an abnormal return status. +For each corrected inconsistency one or more lines will be printed +identifying the file system on which the correction will take place, +and the nature of the correction. +After successfully correcting a file system, +.Nm +will print the number of files on that file system, +the number of used and free blocks, +and the percentage of fragmentation. +.Pp +If sent a +.Dv QUIT +signal, +.Nm +will finish the file system checks, then exit with an abnormal return status. +.Pp +If +.Nm +receives a +.Dv SIGINFO +signal +(see the +.Sy status +argument for +.Xr stty 1 ) , +a line will be written to the standard error output indicating +the name of the device currently being checked, the current phase +number and phase-specific progress information. +.Pp +Without the +.Fl p +option, +.Nm +audits and interactively repairs inconsistent conditions for file systems. +If the file system is inconsistent the operator is prompted for concurrence +before each correction is attempted. +It should be noted that some of the corrective actions which are not +correctable under the +.Fl p +option will result in some loss of data. +The amount and severity of data lost may be determined from the diagnostic +output. +The default action for each consistency correction +is to wait for the operator to respond +.Li yes +or +.Li no . +If the operator does not have write permission on the file system +.Nm +will default to a +.Fl n +action. +.Pp +.Nm +has more consistency checks than +its predecessors +.Em check , dcheck , fcheck , +and +.Em icheck +combined. +.Pp +The following flags are interpreted by +.Nm . +.Bl -tag -width XBXbyteorderXX -offset indent +.It Fl a +Interpret the filesystem as an Apple UFS filesystem, even if +there is no Apple UFS volume label present. +.It Fl B Ar byteorder +Convert the file system metadata to +.Ar byteorder +byte order if needed. +Valid byte orders are +.Dq be +and +.Dq le . +If +.Nm +is interrupted while swapping the metadata byte order, the file system cannot +be recovered. +.Nm +will print a message in interactive mode if the file system is not in host +byte order. +.It Fl b Ar block +Use the block number +.Ar block +as the super block for the file system. +Block 32 is usually an alternative super block. +The +.Fl b +option of the +.Xr scan_ffs 8 +utility can also be used to find the offset of other super block backups +in a file system. +.It Fl c Ar level +Convert the FFSv1 file system to the level +.Ar level . +Note that the level of a file system can only be raised. +There are currently five levels defined: +.Bl -tag -width 3n -offset indent +.It 0 +The file system is in the old (static table) format. +.It 1 +The file system is in the new (dynamic table) format. +Such file systems are made by using the +.Fl O Ar 0 +option to +.Xr newfs 8 . +.It 2 +The file system supports 32-bit UIDs and GIDs, +short symbolic links are stored in the inode, +and directories have an added field showing the file type. +This format was introduced in +.Bx 4.4 . +.It 3 +If maxcontig is greater than one, +build the free segment maps to aid in finding contiguous sets of blocks. +If maxcontig is equal to one, delete any existing segment maps. +This was the default before +.Nx 2.0 . +.It 4 +Rearrange the super block to the same layout as FFSv2; +disable the rotational layout tables and per cylinder group +block totals. +Such file systems are made by using the +.Fl O Ar 1 +option to +.Xr newfs 8 . +.El +.Pp +Note that FFSv2 file systems always have the features of FFSv1 level 4. +.Pp +FFSv2 file systems have separate conversion options: +.Bl -tag -width 3n -offset indent +.It ea +Convert the file system to the format which supports extended attributes +(and access control lists). +After this conversion is performed, the file system will no longer be +recognized at all by releases prior to +.Nx 10.0 . +.It no-ea +Convert the file system to the format which does not support extended attributes +(or access control lists). +This will remove any existing extended attributes, and the file system +will become recognizable to releases prior to +.Nx 10.0 . +.El +.Pp +In interactive mode, +.Nm +will list the conversion to be made +and ask whether the conversion should be done. +If a negative answer is given, +no further operations are done on the file system. +In preen mode, +the conversion is listed and done if +possible without user interaction. +Conversion in preen mode is best used when all the file systems +are being converted at once. +.Pp +The output of +.Xr dumpfs 8 +can be examined to determine the format of the file system +.Dq ( format +in the second line) +and the file system level +.Dq ( fslevel +in the sixth line). +.Pp +.It Fl d +Print debugging output. +.It Fl F +Indicates that +.Ar filesystem +is a file system image, rather than a raw character device. +.Ar filesystem +will be accessed +.Sq as-is , +and no attempts will be made to read a disklabel. +.It Fl f +Force checking of file systems. +Normally, if a file system is cleanly unmounted, the kernel will set a +.Dq clean flag +in the file system super block, and +.Nm +will not check the file system. +This option forces +.Nm +to check the file system, regardless of the state of the clean flag. +.It Fl m Ar mode +Use the octal value +.Ar mode +as the permission bits to use when creating the +.Pa lost+found +directory rather than the default 1700. +In particular, systems that do not wish to have lost files accessible +by all users on the system should use a more restrictive +set of permissions such as 700. +.It Fl n +Assume a no response to all questions asked by +.Nm +except for +.Ql CONTINUE? , +which is assumed to be affirmative; +do not open the file system for writing. +.It Fl P +Display a progress meter for the file system check. +A new meter is displayed for each of the 5 file system check passes, unless +.Fl p +is specified, in which case only one meter for overall progress is displayed. +Progress meters are disabled if the +.Fl d +option is specified. +.It Fl p +Specify +.Dq preen +mode, described above. +.It Fl q +Quiet mode, do not output any messages for clean filesystems. +.It Fl U +Resolve user ids to usernames. +.It Fl X +Similar to +.Fl x +but uses a file system internal snapshot on the file system to be checked. +.It Fl x Ar snap-backup +Use a snapshot with +.Ar snap-backup +as backup to check a read-write mounted filesystem. +Must be used with +.Fl n . +See +.Xr fss 4 +for more details. +The point is to check an internally-consistent version of the +filesystem to find out if it is damaged; on failure one should unmount +the filesystem and repair it. +.It Fl y +Assume a yes response to all questions asked by +.Nm ; +this should be used with great caution as this is a free license +to continue after essentially unlimited trouble has been encountered. +.It Fl z +Clear unused directory space. +The cleared space includes deleted file names and name padding. +.El +.Pp +Inconsistencies checked are as follows: +.Bl -enum -offset indent -compact +.It +Blocks claimed by more than one inode or the free map. +.It +Blocks claimed by an inode outside the range of the file system. +.It +Incorrect link counts. +.It +Size checks: +.Bl -item -offset indent -compact +.It +Directory size not a multiple of DIRBLKSIZ. +.It +Partially truncated file. +.El +.It +Bad inode format. +.It +Blocks not accounted for anywhere. +.It +Directory checks: +.Bl -item -offset indent -compact +.It +File pointing to unallocated inode. +.It +Inode number out of range. +.It +Dot or dot-dot not the first two entries of a directory +or having the wrong inode number. +.El +.It +Super Block checks: +.Bl -item -offset indent -compact +.It +More blocks for inodes than there are in the file system. +.It +Bad free block map format. +.It +Total free block and/or free inode count incorrect. +.El +.El +.Pp +Orphaned files and directories (allocated but unreferenced) are, +with the operator's concurrence, reconnected by +placing them in the +.Pa lost+found +directory. +The name assigned is the inode number. +If the +.Pa lost+found +directory does not exist, it is created. +If there is insufficient space its size is increased. +.Pp +Because of inconsistencies between the block device and the buffer cache, +the raw device should always be used. +.Sh DIAGNOSTICS +The diagnostics produced by +.Nm +are fully enumerated and explained in Appendix A of +.Rs +.%T "Fsck \- The UNIX File System Check Program" +.Re +.Sh SEE ALSO +.Xr fss 4 , +.Xr fs 5 , +.Xr fstab 5 , +.Xr dumpfs 8 , +.Xr fsck 8 , +.Xr fsdb 8 , +.Xr newfs 8 , +.Xr reboot 8 , +.Xr scan_ffs 8 +.Sh HISTORY +A +.Nm fsck +utility appeared in +.Bx 4.0 . +It was renamed to +.Nm +in +.Nx 1.3 +with the introduction of a filesystem independent wrapper as +.Nm fsck . diff --git a/static/netbsd/man8/fsck_lfs.8 b/static/netbsd/man8/fsck_lfs.8 new file mode 100644 index 00000000..eb6e8e9e --- /dev/null +++ b/static/netbsd/man8/fsck_lfs.8 @@ -0,0 +1,242 @@ +.\" $NetBSD: fsck_lfs.8,v 1.27 2025/09/14 21:28:26 wiz Exp $ +.\" +.\" Copyright (c) 1980, 1989, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)fsck.8 8.3 (Berkeley) 11/29/94 +.\" +.Dd September 14, 2025 +.Dt FSCK_LFS 8 +.Os +.Sh NAME +.Nm fsck_lfs +.Nd Log-structured File System consistency check and interactive repair +.Sh SYNOPSIS +.Nm fsck_lfs +.Op Fl adfpqU +.Op Fl b Ar block +.Op Fl i Ar idaddr +.Op Fl m Ar mode +.Op Fl y | n +.Ar filesystem +.Ar ... +.Sh DESCRIPTION +.Nm +performs interactive file system consistency checks and repair for +each of the file systems specified on the command line. +It is normally invoked from +.Xr fsck 8 . +.Pp +The design of LFS takes care that no file system inconsistencies can +happen unless hardware or software failures intervene. +.Nm +will report and optionally correct any such inconsistencies. +.Pp +For each corrected inconsistency one or more lines will be printed +identifying the file system on which the correction will take place, +and the nature of the correction. +After successfully correcting a file system, +.Nm +will print the number of files on that file system, +the number of used and free blocks, +and the percentage of fragmentation. +.Pp +If sent a +.Dv QUIT +signal, +.Nm +will finish the file system checks, then exit with an abnormal return status. +.Pp +Without the +.Fl p +option, +.Nm +audits and interactively repairs inconsistent conditions for file systems. +If the file system is inconsistent, the operator is prompted for concurrence +before each correction is attempted. +It should be noted that some of the corrective actions will result in +some loss of data. +The amount and severity of data lost may be determined from the diagnostic +output. +The default action for each consistency correction +is to wait for the operator to respond +.Li yes +or +.Li no . +If the operator does not have write permission on the file system +.Nm +will default to a +.Fl n +action. +.Pp +The following flags are interpreted by +.Nm : +.Bl -tag -width XbXblockXX +.It Fl a +Do not report discrepancies in +.Li avail +accounting. +.It Fl b Ar block +Use +.Ar block +as the super block for the file system. +.It Fl d +Print debugging output. +.It Fl f +Force checking of file systems. +Normally, if a file system is cleanly unmounted, the kernel will +set a +.Dq clean flag +in the file system superblock, and +.Nm +will not check the file system. +This option forces +.Nm +to check the file system, regardless of the state of the clean flag. +.It Fl i Ar idaddr +Use the given disk address to locate the index file inode, rather than +looking in the superblock. +.It Fl m Ar mode +Use +.Ar mode +specified in octal as the permission bits to use when creating the +.Pa lost+found +directory rather than the default 1700. +In particular, systems that do not wish to have lost files accessible +by all users on the system should use a more restrictive +set of permissions such as 700. +.It Fl n +Assume a no response to all questions asked by +.Nm +except for +.Ql CONTINUE? , +which is assumed to be affirmative; +do not open the file system for writing. +.It Fl p +Specify +.Dq preen +mode. +Currently, in this mode +.Nm +does nothing. +.\" rolls forward from the older checkpoint, and performs no other action. +.It Fl q +Quiet mode, do not output any messages for clean file systems. +.It Fl U +Resolve user ids to user names. +.It Fl y +Assume a yes response to all questions asked by +.Nm ; +this should be used with great caution as this is a free license +to continue after essentially unlimited trouble has been encountered. +.El +.Pp +Inconsistencies checked are as follows: +.Bl -enum -offset indent -compact +.It +Blocks claimed by more than one inode. +.It +Blocks claimed by an inode outside the range of the file system. +.It +Incorrect link counts. +.It +Size checks: +.Bl -item -offset indent -compact +.It +Directory size not a multiple of DIRBLKSIZ. +.It +Partially truncated file. +.El +.It +Bad inode format. +.It +Directory checks: +.Bl -item -offset indent -compact +.It +File pointing to unallocated inode. +.It +Inode number out of range. +.It +Dot or dot-dot not the first two entries of a directory +or having the wrong inode number. +.El +.It +Super Block checks: +.Bl -item -offset indent -compact +.It +More blocks for inodes than there are in the file system. +.El +.It +Index File checks: +.Bl -item -offset indent -compact +.It +.Dq \&In use +inodes on free list, or free inodes not on free list. +.It +Segment block counts incorrect, or +.Dq clean +segments containing live data. +.El +.El +.Pp +Orphaned files and directories (allocated but unreferenced) are, +with the operator's concurrence, reconnected by +placing them in the +.Pa lost+found +directory. +The name assigned is the inode number. +If the +.Pa lost+found +directory does not exist, it is created. +If there is insufficient space its size is increased. +.Pp +Because of inconsistencies between the block device and the buffer cache, +the raw device should always be used. +.Sh DIAGNOSTICS +The diagnostics produced by +.Nm +are fully enumerated and explained in Appendix A of +.Rs +.%T "Fsck \- The UNIX File System Check Program" +.Re +.Sh SEE ALSO +.Xr fstab 5 , +.Xr fsck 8 , +.Xr newfs_lfs 8 , +.Xr reboot 8 +.Sh HISTORY +The +.Nm +program was first made available in +.Nx 1.4 . +.Sh AUTHORS +Most of the +.Nm +program was taken from +.Xr fsck_ffs 8 ; +what was not was written by +.An Konrad Schroder Aq Mt perseant@NetBSD.org . diff --git a/static/netbsd/man8/fsck_msdos.8 b/static/netbsd/man8/fsck_msdos.8 new file mode 100644 index 00000000..41bd7e12 --- /dev/null +++ b/static/netbsd/man8/fsck_msdos.8 @@ -0,0 +1,119 @@ +.\" $NetBSD: fsck_msdos.8,v 1.18 2016/09/11 04:12:08 sevan Exp $ +.\" +.\" Copyright (C) 1995 Wolfgang Solfrank +.\" Copyright (c) 1995 Martin Husemann +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" +.Dd September 11, 2016 +.Dt FSCK_MSDOS 8 +.Os +.Sh NAME +.Nm fsck_msdos +.Nd DOS/Windows (FAT) filesystem consistency checker +.Sh SYNOPSIS +.Nm +.Fl p +.Op Fl f +.Ar filesystem ... +.Nm +.Op Fl fny +.Op Fl x Ar snap-backup +.Ar filesystem ... +.Sh DESCRIPTION +The +.Nm +utility verifies and repairs +.Tn FAT +filesystems (more commonly known +as +.Tn DOS +filesystems). +.Pp +The first form of +.Nm +preens the specified filesystems. +It is normally started by +.Xr fsck 8 +run from +.Pa /etc/rc +during automatic reboot, when a FAT filesystem is detected. +When preening file systems, +.Nm +will fix common inconsistencies non-interactively. +If more serious problems are found, +.Nm +does not try to fix them, indicates that it was not +successful, and exits. +.Pp +The second form of +.Nm +checks the specified file systems and tries to repair all +detected inconsistencies, requesting confirmation before +making any changes. +.Pp +The options are as follows: +.Bl -tag -width XxXsnapXbackupXX +.It Fl f +This option is ignored by +.Nm , +and is present only for compatibility with programs that +check other file system types for consistency, such as +.Xr fsck_ffs 8 . +.It Fl n +Causes +.Nm +to assume no as the answer to all operator +questions, except +.Dq CONTINUE? . +.It Fl p +Preen the specified filesystems. +.It Fl x Ar snap-backup +Use a snapshot with +.Ar snap-backup +as backup to check a read-write mounted filesystem. +Must be used with +.Fl n . +See +.Xr fss 4 +for more details. +The point is to check an internally-consistent version of the +filesystem to find out if it is damaged; on failure one should unmount +the filesystem and repair it. +.It Fl y +Causes +.Nm +to assume yes as the answer to all operator questions. +.El +.Sh SEE ALSO +.Xr fss 4 , +.Xr fsck 8 , +.Xr fsck_ffs 8 , +.Xr mount_msdos 8 +.Sh HISTORY +A +.Nm +utility appeared in +.Nx 1.2 . +.Sh BUGS +.Nm +is still under construction. diff --git a/static/netbsd/man8/fsck_udf.8 b/static/netbsd/man8/fsck_udf.8 new file mode 100644 index 00000000..c50dd6d9 --- /dev/null +++ b/static/netbsd/man8/fsck_udf.8 @@ -0,0 +1,116 @@ +.\" $NetBSD: fsck_udf.8,v 1.2 2022/04/06 13:41:13 wiz Exp $ +.\" +.\" Copyright (C) 2022 Reinoud Zandijk +.\" Based on fsck_msdos(8) by +.\" Copyright (C) 1995 Wolfgang Solfrank +.\" Copyright (c) 1995 Martin Husemann +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" +.Dd February 6, 2022 +.Dt FSCK_UDF 8 +.Os +.Sh NAME +.Nm fsck_udf +.Nd Universal Disk Format file system consistency checker +.Sh SYNOPSIS +.Nm +.Fl p +.Op Fl fH +.Ar file system ... +.Nm +.Op Fl fHnSsy +.Ar file system ... +.Sh DESCRIPTION +The +.Nm +utility verifies and repairs +.Tn Universal Disk Format +file systems (more commonly known as +.Tn UDF +file systems). +.Pp +The first form of +.Nm +preens the specified file systems. +It is normally started by +.Xr fsck 8 +run from +.Pa /etc/rc +during automatic reboot, when an UDF file system is detected. +When preening file systems, +.Nm +will fix common inconsistencies non-interactively. +If more serious problems are found, +.Nm +does not try to fix them, indicates that it was not +successful, and exits. +.Pp +The second form of +.Nm +checks the specified file systems and tries to repair all +detected inconsistencies, requesting confirmation before +making any changes. +.Pp +The options are as follows: +.Bl -tag -width XXXoptions +.It Fl f +Force detailed checking even when file system is marked closed. +.It Fl H +Enables heuristic repair options repairing known corruptions in the wild +caused by bugs. +.It Fl n +Causes +.Nm +to assume no as the answer to all operator questions. +.It Fl p +Preen the specified file systems. +.It Fl S +Causes +.Nm +to scan for older VAT tables on recordable media. +This allows older snapshots of the file system on recordable media to +be recovered. +.It Fl s Ar session +Select session +.Ar session +to be checked on recordable media. +This allows older sessions of the file system on recordable media to +be recovered. +.It Fl y +Causes +.Nm +to assume yes as the answer to all operator questions. +.El +.Sh SEE ALSO +.Xr fsck 8 , +.Xr fsck_ffs 8 , +.Xr mount_udf 8 +.Sh HISTORY +A +.Nm +utility appeared in +.Nx 10.0 . +.Sh BUGS +.Nm +is still under construction. +Not all possible reparations are implemented. diff --git a/static/netbsd/man8/fsck_v7fs.8 b/static/netbsd/man8/fsck_v7fs.8 new file mode 100644 index 00000000..17c95843 --- /dev/null +++ b/static/netbsd/man8/fsck_v7fs.8 @@ -0,0 +1,102 @@ +.\" $NetBSD: fsck_v7fs.8,v 1.3 2016/09/11 04:19:52 sevan Exp $ +.\" +.\" Copyright (c) 2011 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by UCHIYAMA Yasushi. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 11, 2016 +.Dt FSCK_V7FS 8 +.Os +.Sh NAME +.Nm fsck_v7fs +.Nd 7th Edition(V7) filesystem consistency checker +.Sh SYNOPSIS +.Nm +.Op Fl FnPpy +.Op Fl B Ar byteorder +.Op Fl o Ar options +.Ar filesystem ... +.Sh DESCRIPTION +The +.Nm +utility verifies and repairs +.Tn Version 7 +file systems. +.Pp +The following flags are interpreted by +.Nm . +.Bl -tag -width XBXbyteorderXX -offset indent +.It Fl B Ar byteorder +Convert the file system metadata to +.Ar byteorder +byte order if needed. +Valid byte orders are +.Dq be , +.Dq le , +and +.Dq pdp . +.It Fl F +Check file system inside a regular file. +.It Fl n +Do not correct file system. +.It Fl o +Options are specified with a +.Fl o +flag followed by a comma separated string of options. +The following options are available: +.Bl -tag -width data +.It Cm data +Check data block duplication. +.It Cm free +Check free block duplication. +.El +.It Fl P +Display a progress meter for the file system check. +.It Fl p +Preen mode. +See +.Xr fsck 8 . +.It Fl y +Causes +.Nm +to assume yes as the answer to all operator questions. +.El +.Sh SEE ALSO +.Xr fsck 8 , +.Xr mount_v7fs 8 , +.Xr newfs_v7fs 8 +.Sh HISTORY +A +.Nm +utility appeared in +.Nx 6.0 . +.Sh AUTHORS +.Nm +was written by +.An UCHIYAMA Yasushi Aq Mt uch@NetBSD.org . +.Sh BUGS +.Nm +is still under construction. diff --git a/static/netbsd/man8/fsdb.8 b/static/netbsd/man8/fsdb.8 new file mode 100644 index 00000000..405edddb --- /dev/null +++ b/static/netbsd/man8/fsdb.8 @@ -0,0 +1,267 @@ +.\" $NetBSD: fsdb.8,v 1.28 2022/11/17 06:40:38 chs Exp $ +.\" +.\" Copyright (c) 1996, 2017 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by John T. Kohl. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd May 29, 2021 +.Dt FSDB 8 +.Os +.Sh NAME +.Nm fsdb +.Nd FFS debugging/editing tool +.Sh SYNOPSIS +.Nm +.Op Fl dFnN +.Fl f Ar fsname +.Sh DESCRIPTION +.Nm +opens +.Ar fsname +(usually a raw disk partition) and runs a command loop +allowing manipulation of the file system's inode data. +You are prompted to enter a command with +.Dq "fsdb (inum X)>" +where +.Va X +is the currently selected i-number. +The initial selected inode is the root of the filesystem (i-number 2). +The command processor uses the +.Xr editline 3 +library, so you can use command line editing to reduce typing if desired. +When you exit the command loop, the file system superblock is marked +dirty and any buffered blocks are written to the file system. +.Pp +The +.Fl d +option enables additional debugging output (which comes primarily from +.Xr fsck 8 Ns -derived +code). +.Pp +The +.Fl F +option indicates that +.Ar filesystem +is a file system image, rather than a raw character device. +It will be accessed +.Sq as-is , +and no attempts will be made to read a disklabel. +.Pp +The +.Fl n +option disables writing to the device, preventing any changes from being made +to the filesystem. +.Pp +The +.Fl N +option causes the superblock not to be marked dirty when +.Nm +exits. +.Sh COMMANDS +Besides the built-in +.Xr editline 3 +commands, +.Nm +supports these commands: +.Pp +.Bl -tag -width indent -compact +.It Cm help +Print out the list of accepted commands. +.Pp +.It Cm inode Ar i-number +Select inode +.Ar i-number +as the new current inode. +.Pp +.It Cm back +Revert to the previously current inode. +.Pp +.It Cm clri Ar i-number +Clear the inode +.Ar i-number . +.Pp +.It Cm lookup Ar name +.It Cm cd Ar name +Find +.Ar name +in the current directory and make its inode the current inode. +.Ar Name +may be a multi-component name or may begin with slash to indicate that +the root inode should be used to start the lookup. +If some component along the pathname is not found, +the last valid directory encountered is left as the active inode. +.br +This command is valid only if the starting inode is a directory. +.Pp +.It Cm active +.It Cm print +Print out the active inode. +.Pp +.It Cm uplink +Increment the active inode's link count. +.Pp +.It Cm downlink +Decrement the active inode's link count. +.Pp +.It Cm linkcount Ar number +Set the active inode's link count to +.Ar number . +.Pp +.It Cm ls +List the current inode's directory entries. +This command is valid only if the current inode is a directory. +.Pp +.It Cm blks +List the current inode's blocks numbers. +.Pp +.It Cm findblk Ar disk block number ... +Find the inode(s) owning the specified disk block(s) number(s). +Note that these are not absolute disk blocks numbers, but offsets from the +start of the partition. +.Pp +.It Cm saveblks Ar filename +Save the current inode's data into +.Ar filename . +.Pp +.It Cm rm Ar name +.It Cm del Ar name +Remove the entry +.Ar name +from the current directory inode. +This command is valid only if the current inode is a directory. +.Pp +.It Cm ln Ar ino Ar name +Create a link to inode +.Ar ino +under the name +.Ar name +in the current directory inode. +This command is valid only if the current inode is a directory. +.Pp +.It Cm chinum Ar dirslot Ar inum +Change the i-number in directory entry +.Ar dirslot +to +.Ar inum . +.Pp +.It Cm chname Ar dirslot Ar name +Change the name in directory entry +.Ar dirslot +to +.Ar name . +This command cannot expand a directory entry. +You can only rename an entry if the name will fit into +the existing directory slot. +.Pp +.It Cm chtype Ar type +Change the type of the current inode to +.Ar type . +.Ar type +may be one of: +.Em file , +.Em dir , +.Em socket , +or +.Em fifo . +.Pp +.It Cm chmod Ar mode +Change the mode bits of the current inode to +.Ar mode . +You cannot change the file type with this subcommand; use +.Ic chtype +to do that. +.Pp +.It Cm chflags Ar flags +Change the file flags of the current inode to +.Ar flags . +.Pp +.It Cm chown Ar uid +Change the owner of the current inode to +.Ar uid . +.Pp +.It Cm chgrp Ar gid +Change the group of the current inode to +.Ar gid . +.Pp +.It Cm chgen Ar gen +Change the generation number of the current inode to +.Ar gen . +.Pp +.It Cm mtime Ar time +.It Cm ctime Ar time +.It Cm atime Ar time +.It Cm birthtime Ar time +Change the modification, change, access time, or birthtime (respectively) on the +current inode to +.Ar time . +.Ar Time +should be in the format +.Em YYYYMMDDHHMMSS[.nsec] +where +.Em nsec +is an optional nanosecond specification. +If no nanoseconds are specified, the +.Va mtimensec , +.Va ctimensec , +.Va atimensec , +or +.Va birthtimensec +field will be set to zero. +The birthtime field is only available on ufs2 filesystems. +.Pp +.It Cm quit , Cm q , Cm exit , Aq Em EOF +Exit the program. +.El +.Sh SEE ALSO +.Xr editline 3 , +.Xr fs 5 , +.Xr clri 8 , +.Xr fsck 8 +.Sh HISTORY +.Nm +uses the source code for +.Xr fsck 8 +to implement most of the file system manipulation code. +The remainder of +.Nm +first appeared in +.Nx 1.1 . +.Sh WARNING +Use this tool with extreme caution -- you can damage an FFS file system +beyond what +.Xr fsck 8 +can repair. +.Sh BUGS +Manipulation of +.Dq short +symlinks doesn't work (in particular, don't +try changing a symlink's type). +.br +You must specify modes as numbers rather than symbolic names. +.br +There are a bunch of other things that you might want to do which +.Nm +doesn't implement. diff --git a/static/netbsd/man8/fsinfo.8 b/static/netbsd/man8/fsinfo.8 new file mode 100644 index 00000000..4f56d9ec --- /dev/null +++ b/static/netbsd/man8/fsinfo.8 @@ -0,0 +1,119 @@ +.\" $NetBSD: fsinfo.8,v 1.1.1.3 2015/01/17 16:34:17 christos Exp $ +.\" +.\" +.\" Copyright (c) 1997-2014 Erez Zadok +.\" Copyright (c) 1993 Jan-Simon Pendry. +.\" Copyright (c) 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" +.\" File: am-utils/fsinfo/fsinfo.8 +.\" +.TH FSINFO 8 "June 28, 1993" +.SH NAME +fsinfo \- coordinate site-wide filesystem information +.SH SYNOPSIS +.B fsinfo +[ +.B \-v +] [ +.B \-a +.I autodir +] [ +.B \-b +.I bootparams +] [ +.B \-d +.I dumpsets +] [ +.B \-e +.I exports +] [ +.B \-f +.I fstabs +] [ +.B \-h +.I hostname +] [ +.B \-m +.I automounts +] [ +.B \-I +.I dir +] [ +.B \-D +.I string[=string] +] [ +.B \-U +.I string[=string] +] +.I config +.I ... +.SH DESCRIPTION +The +.B fsinfo +utility takes a set of system configuration information, and generates +a coordinated set of +.I amd +, +.I mount +and +.I mountd +configuration files. +.PP +The +.B fsinfo +command is fully described in the document +.I "Amd - The 4.4BSD Automounter" +.SH "SEE ALSO" +.BR amd (8), +.BR mount (8), +.BR mountd (8). +.LP +``am-utils'' +.BR info (1) +entry. +.LP +.I "Linux NFS and Automounter Administration" +by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001). +.LP +.I http://www.am-utils.org +.LP +.I "Amd \- The 4.4 BSD Automounter" +.SH HISTORY +The +.B fsinfo +command first appeared in 4.4BSD. +.SH AUTHORS +Jan-Simon Pendry , Department of Computing, Imperial College, London, UK. +.P +Erez Zadok , Computer Science Department, Stony Brook +University, Stony Brook, New York, USA. +.P +Other authors and contributors to am-utils are listed in the +.B AUTHORS +file distributed with am-utils. diff --git a/static/netbsd/man8/fsirand.8 b/static/netbsd/man8/fsirand.8 new file mode 100644 index 00000000..bc873942 --- /dev/null +++ b/static/netbsd/man8/fsirand.8 @@ -0,0 +1,98 @@ +.\" $NetBSD: fsirand.8,v 1.11 2024/03/28 15:39:42 riastradh Exp $ +.\" +.\" Copyright (c) 1997 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Christos Zoulas. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 11, 2016 +.Dt FSIRAND 8 +.Os +.Sh NAME +.Nm fsirand +.Nd install random inode generation numbers in a filesystem +.Sh SYNOPSIS +.Nm +.Op Fl F +.Op Fl p +.Op Fl x Ar constant +.Ar special +.Sh DESCRIPTION +.Nm +writes random inode generation numbers for all the inodes on device +.Ar special . +These random numbers make the NFS filehandles less predictable, which +was once thought to increase security of exported file systems. +.Pp +.Nm +is no longer relevant because +.Xr newfs 8 +has randomized inode generation numbers on all new file systems since +.Nx 2.0 , +and in any case, exporting a file system to NFS clients allows them to +traverse the entire file system, so making filehandles less predictable +does not prevent clients from finding them anyway. +.Pp +.Nm +should be run on a clean and unmounted filesystem. +.Pp +The options are as follows: +.Bl -tag -width indent +.It Fl F +Indicates that +.Ar special +is a file system image, rather than a device name. +.Ar special +will be accessed +.Sq as-is , +without requiring that it is a raw character device and without +attempting to read a disklabel. +.It Fl p +Print the current inode generation numbers; the filesystem is not modified. +.It Fl x Ar constant +Exclusive-or the given constant with the random number used in the generation +process. +.El +.Pp +.Nm +exits zero on success, non-zero on failure. +.Pp +If +.Nm +receives a +.Dv SIGINFO +signal, statistics on the amount of work completed and estimated +completion time (in minutes:seconds) will be written to the standard +error output. +.Sh SEE ALSO +.Xr fsck_ffs 8 , +.Xr newfs 8 +.Sh HISTORY +A +.Nm +utility appeared in +.Nx 1.3 . +.Sh AUTHORS +.An Christos Zoulas Aq Mt christos@NetBSD.org . diff --git a/static/netbsd/man8/fssconfig.8 b/static/netbsd/man8/fssconfig.8 new file mode 100644 index 00000000..da8b4ee9 --- /dev/null +++ b/static/netbsd/man8/fssconfig.8 @@ -0,0 +1,176 @@ +.\" $NetBSD: fssconfig.8,v 1.12 2016/07/29 05:20:33 pgoyette Exp $ */ +.\" +.\" +.\" Copyright (c) 2003 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Juergen Hannken-Illjes. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd July 29, 2016 +.Dt FSSCONFIG 8 +.Os +.Sh NAME +.Nm fssconfig +.Nd configure file system snapshot devices +.Sh SYNOPSIS +.Nm +.Op Fl cxv +.Ar device +.Ar path +.Ar backup +.Op Ar cluster Op Ar size +.Nm +.Fl u Op Fl v +.Ar device +.Nm +.Fl l Op Fl v +.Op Ar device +.Sh DESCRIPTION +The +.Nm +command configures file system snapshot pseudo disk devices. +It will associate the file system snapshot disk +.Ar device +with a snapshot of the file system mounted on +.Ar path , +allowing +.Ar device +to be accessed as though it were a disk. +.Pp +If +.Ar backup +resides on the snapshotted file system a persistent snapshot will be created. +This snapshot is active until +.Ar backup +is unlinked. +Persistent snapshots save the file system as if it had been unmounted. +Unlinked but open files get removed from the snapshot. +The time needed to create a persistent snapshot increases with the size of the +file system and decreases with the file system block size. +This snapshot mode is only supported for FFS file systems. +.Pp +Otherwise data written through the +.Ar path +will be saved in +.Ar backup . +If +.Ar backup +is a regular file, it will be created with length +.Ar size . +Default size is the size of +.Ar path . +Data is saved to +.Ar backup +in units of +.Ar cluster +bytes. +The snapshot is an image of the underlying block device at a moment in time. +Unlinked but open files are still present on the snapshot. +The time needed to create a snapshot is independent of the size of the +file system or the file system block size. +.Pp +Options indicate an action to be performed: +.Bl -tag -width 3n +.It Fl c +Configures the device. +If successful, references to +.Ar device +will access the contents of +.Ar path +at the time the snapshot was taken. +If +.Ar backup +is a directory, a temporary file will be created in this directory. +This file will be unlinked on exit. +.It Fl l +List the snapshot devices and indicate which ones are in use. +If a specific +.Ar device +is given, then only that will be described. +.It Fl u +Unconfigures the +.Ar device . +.It Fl v +Be more verbose listing the snapshot devices. +.It Fl x +Unlink +.Ar backup +after the +.Ar device +is configured. +.El +.Pp +If no action option is given, +.Fl c +is assumed. +.Sh FILES +.Bl -tag -width /etc/disktab -compact +.It Pa /dev/rfss? +.It Pa /dev/fss? +.El +.Sh EXAMPLES +.Dl fssconfig fss0 /usr /tmp/back +.Dl mount /dev/fss0 /mnt +.Pp +Configures the snapshot device +.Pa fss0 +as a snapshot of the +.Pa /usr +file system, and makes the contents of the snapshot available via +.Pa /mnt . +Data written through +.Pa /usr +will be backed up in +.Pa /tmp/back . +.Pp +.Dl fssconfig fss1 / /dev/rsd0e 8192 +.Pp +Configures the snapshot device +.Pa fss1 +as a snapshot of the +.Pa / +file system. +Data written through +.Pa / +will be backed up in +.Pa /dev/rsd0e . +The backup will take place in units of 8192 bytes. +.Pp +.Dl fssconfig -u fss0 +.Pp +Unconfigures the +.Pa fss0 +device. +.Sh SEE ALSO +.Xr opendisk 3 , +.Xr fss 4 , +.Xr dump 8 , +.Xr mount 8 , +.Xr umount 8 +.Sh HISTORY +The +.Nm +command appeared in +.Nx 2.0 . diff --git a/static/netbsd/man8/fstyp.8 b/static/netbsd/man8/fstyp.8 new file mode 100644 index 00000000..0286c11e --- /dev/null +++ b/static/netbsd/man8/fstyp.8 @@ -0,0 +1,155 @@ +.\" $NetBSD: fstyp.8,v 1.6 2020/01/01 20:11:44 wiz Exp $ +.\" +.\" Copyright (c) 2017 The NetBSD Foundation, Inc. +.\" Copyright (c) 2016 The DragonFly Project +.\" Copyright (c) 2014 The FreeBSD Foundation +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Tomohiro Kusumi. +.\" +.\" This software was developed by Edward Tomasz Napierala under sponsorship +.\" from the FreeBSD Foundation. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd January 1, 2020 +.Dt FSTYP 8 +.Os +.Sh NAME +.Nm fstyp +.Nd determine file system type +.Sh SYNOPSIS +.Nm +.Op Fl lsu +.Ar special +.Sh DESCRIPTION +The +.Nm +utility is used to determine the file system type on a given device. +It can recognize ISO-9660, exFAT, Ext2, FAT, NTFS, UFS, HAMMER, and HAMMER2 file systems. +When the +.Fl u +flag is specified, +.Nm +also recognizes certain additional metadata formats that cannot be +handled using +.Xr mount 8 , +such as ZFS pools. +.Pp +The file system name is printed to the standard output +as, respectively: +.Bl -item -offset indent -compact +.It +cd9660 +.It +exfat +.It +ext2fs +.It +msdosfs +.It +ntfs +.It +ufs +.It +hammer +.It +hammer2 +.It +zfs +.El +.Pp +Note that a HAMMER file system consisting of more than one volume +requires a path in blkdevs format. +.Pp +Because +.Nm +is built specifically to detect file system types, it differs from +.Xr file 1 +in several ways. +The output is machine-parsable, file system labels are supported, +and it does not try to recognize any file format other than file systems. +.Pp +These options are available: +.Bl -tag -width ".Fl l" +.It Fl l +In addition to file system type, print file system label if available. +.It Fl s +Ignore file type. +By default, +.Nm +only works on regular files and disk-like device nodes. +Trying to read other file types might have unexpected consequences or hang +indefinitely. +.It Fl u +Include file systems and devices that cannot be mounted directly by +.Xr mount 8 . +.El +.Sh EXIT STATUS +The +.Nm +utility exits 0 on success, and >0 if an error occurs or the file system +type is not recognized. +.Sh SEE ALSO +.Xr file 1 , +.Xr autofs 5 , +.Xr mount 8 , +.Xr zpool 8 +.Sh HISTORY +The +.Nm +command appeared in +.Fx 10.2 . +The +.Nm +command appeared in +.Dx 4.5 . +The +.Nm +command appeared in +.Nx 9.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +utility was developed by +.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org +under sponsorship from the +.Fx +Foundation. +ZFS and GELI support was added by +.An Allan Jude Aq Mt allanjude@FreeBSD.org . +.Pp +The +.Nm +utility was ported to +.Dx +and +.Nx +by +.An Tomohiro Kusumi Aq Mt tkusumi@netbsd.org . +.Sh BUGS +geli and hammer are currently unsupported on +.Nx . diff --git a/static/netbsd/man8/ftp-proxy.8 b/static/netbsd/man8/ftp-proxy.8 new file mode 100644 index 00000000..6d9dcf5e --- /dev/null +++ b/static/netbsd/man8/ftp-proxy.8 @@ -0,0 +1,218 @@ +.\" $NetBSD: ftp-proxy.8,v 1.6 2019/09/21 19:48:15 sevan Exp $ +.\" $OpenBSD: ftp-proxy.8,v 1.10 2007/08/01 15:45:41 jmc Exp $ +.\" +.\" Copyright (c) 2004, 2005 Camiel Dobbelaar, +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd September 21, 2019 +.Dt FTP-PROXY 8 +.Os +.Sh NAME +.Nm ftp-proxy +.Nd Internet File Transfer Protocol proxy daemon +.Sh SYNOPSIS +.Nm ftp-proxy +.Bk -words +.Op Fl 6Adrv +.Op Fl a Ar address +.Op Fl b Ar address +.Op Fl D Ar level +.Op Fl i Ar netif +.Op Fl m Ar maxsessions +.Op Fl P Ar port +.Op Fl p Ar port +.Op Fl q Ar queue +.Op Fl R Ar address +.Op Fl T Ar tag +.Op Fl t Ar timeout +.Ek +.Sh DESCRIPTION +.Nm +is a proxy for the Internet File Transfer Protocol. +FTP control connections should be redirected into the proxy using the +.Xr ipnat 4 +or +.Xr pf 4 +.Ar rdr +command, after which the proxy connects to the server on behalf of +the client. +.Pp +The proxy allows data connections to pass, rewriting and redirecting +them so that the right addresses are used. +All connections from the client to the server have their source +address rewritten so they appear to come from the proxy. +Consequently, all connections from the server to the proxy have +their destination address rewritten, so they are redirected to the +client. +The proxy uses the +.Xr pf 4 +.Ar anchor +facility for this, unless the option +.Fl i +is specified, it will then use the +.Xr ipnat 4 +interface. +.Pp +Assuming the FTP control connection is from $client to $server, the +proxy connected to the server using the $proxy source address, and +$port is negotiated, then +.Nm ftp-proxy +adds the following rules to the various anchors. +(These example rules use inet, but the proxy also supports inet6.) +.Pp +In case of active mode (PORT or EPRT): +.Bd -literal -offset 2n +rdr from $server to $proxy port $port -\*[Gt] $client +pass quick inet proto tcp \e + from $server to $client port $port +.Ed +.Pp +In case of passive mode (PASV or EPSV): +.Bd -literal -offset 2n +nat from $client to $server port $port -\*[Gt] $proxy +pass in quick inet proto tcp \e + from $client to $server port $port +pass out quick inet proto tcp \e + from $proxy to $server port $port +.Ed +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl 6 +IPv6 mode. +The proxy will expect and use IPv6 addresses for all communication. +Only the extended FTP modes EPSV and EPRT are allowed with IPv6. +The proxy is in IPv4 mode by default. +.It Fl A +Only permit anonymous FTP connections. +Either user "ftp" or user "anonymous" is allowed. +.It Fl a Ar address +The proxy will use this as the source address for the control +connection to a server. +.It Fl b Ar address +Address where the proxy will listen for redirected control connections. +The default is 127.0.0.1, or ::1 in IPv6 mode. +.It Fl D Ar level +Debug level, ranging from 0 to 7. +Higher is more verbose. +The default is 5. +(These levels correspond to the +.Xr syslog 3 +levels.) +.It Fl d +Do not daemonize. +The process will stay in the foreground, logging to standard error. +.It Fl i Ar netif +Set +.Nm ftp-proxy +for use with IP-Filter. +The argument +.Ar netif +should be set to the name of the network interface where rdr is applied on. +.It Fl m Ar maxsessions +Maximum number of concurrent FTP sessions. +When the proxy reaches this limit, new connections are denied. +The default is 100 sessions. +The limit can be lowered to a minimum of 1, or raised to a maximum of 500. +.It Fl P Ar port +Fixed server port. +Only used in combination with +.Fl R . +The default is port 21. +.It Fl p Ar port +Port where the proxy will listen for redirected connections. +The default is port 8021. +.It Fl q Ar queue +Create rules with queue +.Ar queue +appended, so that data connections can be queued. +.It Fl R Ar address +Fixed server address, also known as reverse mode. +The proxy will always connect to the same server, regardless of +where the client wanted to connect to (before it was redirected). +Use this option to proxy for a server behind NAT, or to forward all +connections to another proxy. +.It Fl r +Rewrite sourceport to 20 in active mode to suit ancient clients that insist +on this RFC property. +.It Fl T Ar tag +Automatically tag packets passing through the +.Xr pf 4 +rule with the name supplied. +.It Fl t Ar timeout +Number of seconds that the control connection can be idle, before the +proxy will disconnect. +The maximum is 86400 seconds, which is also the default. +Do not set this too low, because the control connection is usually +idle when large data transfers are taking place. +.It Fl v +Set the 'log' flag on pf rules committed by +.Nm . +Use twice to set the 'log-all' flag. +The pf rules do not log by default. +.El +.Sh CONFIGURATION +To make use of the proxy using +.Xr pf 4 , +.Xr pf.conf 5 +needs the following rules. +All anchors are mandatory. +Adjust the rules as needed. +.Pp +In the NAT section: +.Bd -literal -offset 2n +nat-anchor "ftp-proxy/*" +rdr-anchor "ftp-proxy/*" +rdr pass on $int_if proto tcp from $lan to any port 21 -\*[Gt] \e + 127.0.0.1 port 8021 +.Ed +.Pp +In the rule section: +.Bd -literal -offset 2n +anchor "ftp-proxy/*" +pass out proto tcp from $proxy to any port 21 +.Ed +.Pp +To make use of the proxy using +.Xr ipnat 4 , +.Xr ipnat.conf 5 +need the following rule: +.Bd -literal -offset 2n +rdr $int_if any port 21 -\*[Gt] 127.0.0.1 port 8021 tcp +.Ed +.Sh SEE ALSO +.Xr ftp 1 , +.Xr ipnat 4 , +.Xr pf 4 , +.Xr ipnat.conf 5 , +.Xr pf.conf 5 +.Sh CAVEATS +.Xr ipnat 4 +and +.Xr pf 4 +do not allow the ruleset to be modified if the system is running at a +securelevel higher than 1. +At that level +.Nm ftp-proxy +cannot add rules to the anchors and FTP data connections may get blocked. +.Pp +Negotiated data connection ports below 1024 are not allowed. +.Pp +The negotiated IP address for active modes is ignored for security +reasons. +This makes third party file transfers impossible. +.Pp +.Nm ftp-proxy +chroots to "/var/chroot/ftp-proxy" and changes to user "_proxy" to +drop privileges. diff --git a/static/netbsd/man8/ftpd.8 b/static/netbsd/man8/ftpd.8 new file mode 100644 index 00000000..0ff7adb6 --- /dev/null +++ b/static/netbsd/man8/ftpd.8 @@ -0,0 +1,875 @@ +.\" $NetBSD: ftpd.8,v 1.87 2018/04/28 13:38:00 riastradh Exp $ +.\" +.\" Copyright (c) 1997-2008 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Luke Mewburn. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" Copyright (c) 1985, 1988, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)ftpd.8 8.2 (Berkeley) 4/19/94 +.\" +.Dd May 1, 2009 +.Dt FTPD 8 +.Os +.Sh NAME +.Nm ftpd +.Nd +Internet File Transfer Protocol server +.Sh SYNOPSIS +.Nm +.Op Fl 46DdfHlnQqrsUuWwX +.Op Fl a Ar anondir +.Op Fl C Ar user Ns Op @ Ns Ar host +.Op Fl c Ar confdir +.Op Fl e Ar emailaddr +.Op Fl h Ar hostname +.Op Fl L Ar xferlogfile +.Op Fl P Ar dataport +.Op Fl V Ar version +.Sh DESCRIPTION +.Nm +is the Internet File Transfer Protocol server process. +The server uses the +.Tn TCP +protocol and listens at the port specified in the +.Dq ftp +service specification; see +.Xr services 5 . +.Pp +Available options: +.Bl -tag -width Ds +.It Fl 4 +When +.Fl D +is specified, bind to IPv4 addresses only. +.It Fl 6 +When +.Fl D +is specified, bind to IPv6 addresses only. +.It Fl a Ar anondir +Define +.Ar anondir +as the directory to +.Xr chroot 2 +into for anonymous logins. +Default is the home directory for the ftp user. +This can also be specified with the +.Xr ftpd.conf 5 +.Sy chroot +directive. +.It Fl C Ar user Ns Op @ Ns Ar host +Check whether +.Ar user +.Po +as if connecting from +.Ar host , +if provided +.Pc +would be granted access under +the restrictions given in +.Xr ftpusers 5 , +and exit without attempting a connection. +.Nm +exits with an exit code of 0 if access would be granted, or 1 otherwise. +This can be useful for testing configurations. +.It Fl c Ar confdir +Change the root directory of the configuration files from +.Dq Pa /etc +to +.Ar confdir . +This changes the directory for the following files: +.Pa /etc/ftpchroot , +.Pa /etc/ftpusers , +.Pa /etc/ftpwelcome , +.Pa /etc/motd , +and the file specified by the +.Xr ftpd.conf 5 +.Sy limit +directive. +.It Fl D +Run as daemon. +.Nm +will listen on the default FTP port for incoming connections +and fork a child for each connection. +This is lower overhead than starting +.Nm +from +.Xr inetd 8 +and thus might be useful on busy servers to reduce load. +.It Fl d +Debugging information is written to the syslog using a facility of +.Dv LOG_FTP . +.It Fl e Ar emailaddr +Use +.Ar emailaddr +for the +.Dq "\&%E" +escape sequence (see +.Sx Display file escape sequences ) +.It Fl f +Stops the +.Fl D +flag from detaching from the tty and going into the background. +.It Fl H +Equivalent to +.Do +-h +`hostname` +.Dc . +.It Fl h Ar hostname +Explicitly set the hostname to advertise as to +.Ar hostname . +The default is the hostname associated with the IP address that +.Nm +is listening on. +This ability (with or without +.Fl h ) , +in conjunction with +.Fl c Ar confdir , +is useful when configuring +.Sq virtual +.Tn FTP +servers, each listening on separate addresses as separate names. +Refer to +.Xr inetd.conf 5 +for more information on starting services to listen on specific IP addresses. +.It Fl L Ar xferlogfile +Log +.Tn wu-ftpd +style +.Sq xferlog +entries to +.Ar xferlogfile . +.It Fl l +Each successful and failed +.Tn FTP +session is logged using syslog with a facility of +.Dv LOG_FTP . +If this option is specified more than once, the retrieve (get), store (put), +append, delete, make directory, remove directory and rename operations and +their file name arguments are also logged. +.It Fl n +Don't attempt translation of IP addresses to hostnames. +.It Fl P Ar dataport +Use +.Ar dataport +as the data port, overriding the default of using the port one less +that the port +.Nm +is listening on. +.It Fl Q +Disable the use of pid files for keeping track of the number of logged-in +users per class. +This may reduce the load on heavily loaded +.Tn FTP +servers. +.It Fl q +Enable the use of pid files for keeping track of the number of logged-in +users per class. +This is the default. +.It Fl r +Permanently drop root privileges once the user is logged in. +The use of this option may result in the server using a port other +than the (listening-port - 1) for +.Sy PORT +style commands, which is contrary to the +.Cm RFC 959 +specification, but in practice very few clients rely upon this behaviour. +See +.Sx SECURITY CONSIDERATIONS +below for more details. +.It Fl s +Require a secure authentication mechanism like Kerberos or S/Key to be used. +.It Fl U +Don't log each concurrent +.Tn FTP +session to +.Pa /var/run/utmp . +This is the default. +.It Fl u +Log each concurrent +.Tn FTP +session to +.Pa /var/run/utmp , +making them visible to commands such as +.Xr who 1 . +.It Fl V Ar version +Use +.Ar version +as the version to advertise in the login banner and in the output of +.Sy STAT +and +.Sy SYST +instead of the default version information. +If +.Ar version +is empty or +.Sq - +then don't display any version information. +.It Fl W +Don't log each +.Tn FTP +session to +.Pa /var/log/wtmp . +.It Fl w +Log each +.Tn FTP +session to +.Pa /var/log/wtmp , +making them visible to commands such as +.Xr last 1 . +This is the default. +.It Fl X +Log +.Tn wu-ftpd +style +.Sq xferlog +entries to the syslog, prefixed with +.Dq "xferlog:\ " , +using a facility of +.Dv LOG_FTP . +These syslog entries can be converted to a +.Tn wu-ftpd +style +.Pa xferlog +file suitable for input into a third-party log analysis tool with a command +similar to: +.Dl "sed -ne 's/^.*xferlog: //p' /var/log/xferlog > wuxferlog" +.El +.Pp +The file +.Pa /etc/nologin +can be used to disable +.Tn FTP +access. +If the file exists, +.Nm +displays it and exits. +If the file +.Pa /etc/ftpwelcome +exists, +.Nm +prints it before issuing the +.Dq ready +message. +If the file +.Pa /etc/motd +exists (under the chroot directory if applicable), +.Nm +prints it after a successful login. +This may be changed with the +.Xr ftpd.conf 5 +directive +.Sy motd . +.Pp +The +.Nm +server currently supports the following +.Tn FTP +requests. +The case of the requests is ignored. +.Bl -column "Request" "Description" -offset indent +.It Sy Request Ta Sy Description +.It ABOR Ta "abort previous command" +.It ACCT Ta "specify account (ignored)" +.It ALLO Ta "allocate storage (vacuously)" +.It APPE Ta "append to a file" +.It CDUP Ta "change to parent of current working directory" +.It CWD Ta "change working directory" +.It DELE Ta "delete a file" +.It EPSV Ta "prepare for server-to-server transfer" +.It EPRT Ta "specify data connection port" +.It FEAT Ta "list extra features that are not defined in" Cm "RFC 959" +.It HELP Ta "give help information" +.It LIST Ta "give list files in a directory" Pq Dq Li "ls -lA" +.It LPSV Ta "prepare for server-to-server transfer" +.It LPRT Ta "specify data connection port" +.It MLSD Ta "list contents of directory in a machine-processable form" +.It MLST Ta "show a pathname in a machine-processable form" +.It MKD Ta "make a directory" +.It MDTM Ta "show last modification time of file" +.It MODE Ta "specify data transfer" Em mode +.It NLST Ta "give name list of files in directory" +.It NOOP Ta "do nothing" +.It OPTS Ta "define persistent options for a given command" +.It PASS Ta "specify password" +.It PASV Ta "prepare for server-to-server transfer" +.It PORT Ta "specify data connection port" +.It PWD Ta "print the current working directory" +.It QUIT Ta "terminate session" +.It REST Ta "restart incomplete transfer" +.It RETR Ta "retrieve a file" +.It RMD Ta "remove a directory" +.It RNFR Ta "specify rename-from file name" +.It RNTO Ta "specify rename-to file name" +.It SITE Ta "non-standard commands (see next section)" +.It SIZE Ta "return size of file" +.It STAT Ta "return status of server" +.It STOR Ta "store a file" +.It STOU Ta "store a file with a unique name" +.It STRU Ta "specify data transfer" Em structure +.It SYST Ta "show operating system type of server system" +.It TYPE Ta "specify data transfer" Em type +.It USER Ta "specify user name" +.It XCUP Ta "change to parent of current working directory (deprecated)" +.It XCWD Ta "change working directory (deprecated)" +.It XMKD Ta "make a directory (deprecated)" +.It XPWD Ta "print the current working directory (deprecated)" +.It XRMD Ta "remove a directory (deprecated)" +.El +.Pp +The following non-standard or +.Ux +specific commands are supported by the SITE request. +.Pp +.Bl -column Request Description -offset indent +.It Sy Request Ta Sy Description +.It CHMOD Ta "change mode of a file, e.g. ``SITE CHMOD 755 filename''" +.It HELP Ta "give help information." +.It IDLE Ta "set idle-timer, e.g. ``SITE IDLE 60''" +.It RATEGET Ta "set maximum get rate throttle in bytes/second, e.g. ``SITE RATEGET 5k''" +.It RATEPUT Ta "set maximum put rate throttle in bytes/second, e.g. ``SITE RATEPUT 5k''" +.It UMASK Ta "change umask, e.g. ``SITE UMASK 002''" +.El +.Pp +The following +.Tn FTP +requests (as specified in +.Cm RFC 959 +and +.Cm RFC 2228 ) +are recognized, but are not implemented: +.Sy ACCT , +.Sy ADAT , +.Sy AUTH , +.Sy CCC , +.Sy CONF , +.Sy ENC , +.Sy MIC , +.Sy PBSZ , +.Sy PROT , +.Sy REIN , +and +.Sy SMNT . +.Pp +The +.Nm +server will abort an active file transfer only when the +.Sy ABOR +command is preceded by a Telnet "Interrupt Process" (IP) +signal and a Telnet "Synch" signal in the command Telnet stream, +as described in Internet +.Cm RFC 959 . +If a +.Sy STAT +command is received during a data transfer, preceded by a Telnet IP +and Synch, transfer status will be returned. +.Pp +.Nm +interprets file names according to the +.Dq globbing +conventions used by +.Xr csh 1 . +This allows users to use the metacharacters +.Dq Li \&*?[]{}~ . +.Ss User authentication +.Nm +authenticates users according to five rules. +.Pp +.Bl -enum -offset indent +.It +The login name must be in the password data base, +.Xr passwd 5 , +and not have a null password. +In this case a password must be provided by the client before any +file operations may be performed. +If the user has an S/Key key, the response from a successful +.Sy USER +command will include an S/Key challenge. +The client may choose to respond with a +.Sy PASS +command giving either +a standard password or an S/Key one-time password. +The server will automatically determine which type of password it +has been given and attempt to authenticate accordingly. +See +.Xr skey 1 +for more information on S/Key authentication. +S/Key is a Trademark of Bellcore. +.It +The login name must be allowed based on the information in +.Xr ftpusers 5 . +.It +The user must have a standard shell returned by +.Xr getusershell 3 . +If the user's shell field in the password database is empty, the +shell is assumed to be +.Pa /bin/sh . +As per +.Xr shells 5 , +the user's shell must be listed with full path in +.Pa /etc/shells . +.It +If directed by the file +.Xr ftpchroot 5 +the session's root directory will be changed by +.Xr chroot 2 +to the directory specified in the +.Xr ftpd.conf 5 +.Sy chroot +directive (if set), +or to the home directory of the user. +This facility may also be triggered by enabling the boolean +.Sy ftp-chroot +in +.Xr login.conf 5 . +However, the user must still supply a password. +This feature is intended as a compromise between a fully anonymous account +and a fully privileged account. +The account should also be set up as for an anonymous account. +.It +If the user name is +.Dq anonymous +or +.Dq ftp , +an +anonymous +.Tn FTP +account must be present in the password +file (user +.Dq ftp ) . +In this case the user is allowed +to log in by specifying any password (by convention an email address for +the user should be used as the password). +.Pp +The server performs a +.Xr chroot 2 +to the directory specified in the +.Xr ftpd.conf 5 +.Sy chroot +directive (if set), +the +.Fl a Ar anondir +directory (if set), +or to the home directory of the +.Dq ftp +user. +.Pp +The server then performs a +.Xr chdir 2 +to the directory specified in the +.Xr ftpd.conf 5 +.Sy homedir +directive (if set), otherwise to +.Pa / . +.Pp +If other restrictions are required (such as disabling of certain +commands and the setting of a specific umask), then appropriate +entries in +.Xr ftpd.conf 5 +are required. +.Pp +If the first character of the password supplied by an anonymous user +is +.Dq - , +then the verbose messages displayed at login and upon a +.Sy CWD +command are suppressed. +.El +.Ss Display file escape sequences +When +.Nm +displays various files back to the client (such as +.Pa /etc/ftpwelcome +and +.Pa /etc/motd ) , +various escape strings are replaced with information pertinent +to the current connection. +.Pp +The supported escape strings are: +.Bl -tag -width "Escape" -offset indent -compact +.It Sy "Escape" +.Sy Description +.It "\&%c" +Class name. +.It "\&%C" +Current working directory. +.It "\&%E" +Email address given with +.Fl e . +.It "\&%L" +Local hostname. +.It "\&%M" +Maximum number of users for this class. +Displays +.Dq unlimited +if there's no limit. +.It "\&%N" +Current number of users for this class. +.It "\&%R" +Remote hostname. +.It "\&%s" +If the result of the most recent +.Dq "\&%M" +or +.Dq "\&%N" +was not +.Dq Li 1 , +print an +.Dq s . +.It "\&%S" +If the result of the most recent +.Dq "\&%M" +or +.Dq "\&%N" +was not +.Dq Li 1 , +print an +.Dq S . +.It "\&%T" +Current time. +.It "\&%U" +User name. +.It "\&%\&%" +A +.Dq \&% +character. +.El +.Ss Setting up a restricted ftp subtree +In order that system security is not breached, it is recommended +that the +subtrees for the +.Dq ftp +and +.Dq chroot +accounts be constructed with care, following these rules +(replace +.Dq ftp +in the following directory names +with the appropriate account name for +.Sq chroot +users): +.Bl -tag -width "~ftp/incoming" -offset indent +.It Pa ~ftp +Make the home directory owned by +.Dq root +and unwritable by anyone. +.It Pa ~ftp/bin +Make this directory owned by +.Dq root +and unwritable by anyone (mode 555). +Generally any conversion commands should be installed +here (mode 111). +.It Pa ~ftp/etc +Make this directory owned by +.Dq root +and unwritable by anyone (mode 555). +The files +.Pa pwd.db +(see +.Xr passwd 5 ) +and +.Pa group +(see +.Xr group 5 ) +must be present for the +.Sy LIST +command to be able to display owner and group names instead of numbers. +The password field in +.Xr passwd 5 +is not used, and should not contain real passwords. +The file +.Pa motd , +if present, will be printed after a successful login. +These files should be mode 444. +.It Pa ~ftp/pub +This directory and the subdirectories beneath it should be owned +by the users and groups responsible for placing files in them, +and be writable only by them (mode 755 or 775). +They should +.Em not +be owned or writable by ftp or its group. +.It Pa ~ftp/incoming +This directory is where anonymous users place files they upload. +The owners should be the user +.Dq ftp +and an appropriate group. +Members of this group will be the only users with access to these +files after they have been uploaded; these should be people who +know how to deal with them appropriately. +If you wish anonymous +.Tn FTP +users to be able to see the names of the +files in this directory the permissions should be 770, otherwise +they should be 370. +.Pp +The following +.Xr ftpd.conf 5 +directives should be used: +.Dl "modify guest off" +.Dl "umask guest 0707" +.Dl "upload guest on" +.Pp +This will result in anonymous users being able to upload files to this +directory, but they will not be able to download them, delete them, or +overwrite them, due to the umask and disabling of the commands mentioned +above. +.It Pa ~ftp/tmp +This directory is used to create temporary files which contain +the error messages generated by a conversion or +.Sy LIST +command. +The owner should be the user +.Dq ftp . +The permissions should be 300. +.Pp +If you don't enable conversion commands, or don't want anonymous users +uploading files here (see +.Pa ~ftp/incoming +above), then don't create this directory. +However, error messages from conversion or +.Sy LIST +commands won't be returned to the user. +(This is the traditional behaviour.) +Note that the +.Xr ftpd.conf 5 +directive +.Sy upload +can be used to prevent users uploading here. +.El +.Pp +To set up "ftp-only" accounts that provide only +.Tn FTP , +but no valid shell +login, you can copy/link +.Pa /sbin/nologin +to +.Pa /sbin/ftplogin , +and enter +.Pa /sbin/ftplogin +to +.Pa /etc/shells +to allow logging-in via +.Tn FTP +into the accounts, which must have +.Pa /sbin/ftplogin +as login shell. +.Sh FILES +.Bl -tag -width /etc/ftpwelcome -compact +.It Pa /etc/ftpchroot +List of normal users whose root directory should be changed via +.Xr chroot 2 . +.It Pa /etc/ftpd.conf +Configure file conversions and other settings. +.It Pa /etc/ftpusers +List of unwelcome/restricted users. +.It Pa /etc/ftpwelcome +Welcome notice before login. +.It Pa /etc/motd +Welcome notice after login. +.It Pa /etc/nologin +If it exists, displayed and access is refused. +.It Pa /var/run/ftpd.pids-CLASS +State file of logged-in processes for the +.Nm +class +.Sq CLASS . +.It Pa /var/run/utmp +List of logged-in users on the system. +.It Pa /var/log/wtmp +Login history database. +.El +.Sh SEE ALSO +.Xr ftp 1 , +.Xr skey 1 , +.Xr who 1 , +.Xr getusershell 3 , +.Xr ftpchroot 5 , +.Xr ftpd.conf 5 , +.Xr ftpusers 5 , +.Xr login.conf 5 , +.Xr syslogd 8 +.Sh STANDARDS +.Nm +recognizes all commands in +.Cm RFC 959 , +follows the guidelines in +.Cm RFC 1123 , +recognizes all commands in +.Cm RFC 2228 +(although they are not supported yet), +and supports the extensions from +.Cm RFC 2389 , +.Cm RFC 2428 , +and +.Cm RFC 3659 . +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.2 . +.Pp +Various features such as the +.Xr ftpd.conf 5 +functionality, +.Cm RFC 2389 , +and +.Cm RFC 3659 +support was implemented in +.Nx 1.3 +and later releases by Luke Mewburn. +.Sh BUGS +The server must run as the super-user to create sockets with +privileged port numbers (i.e, those less than +.Dv IPPORT_RESERVED , +which is 1024). +If +.Nm +is listening on a privileged port +it maintains an effective user id of the logged in user, reverting +to the super-user only when binding addresses to privileged sockets. +The +.Fl r +option can be used to override this behaviour and force privileges to +be permanently revoked; see +.Sx SECURITY CONSIDERATIONS +below for more details. +.Pp +.Nm +may have trouble handling connections from scoped IPv6 addresses, or +IPv4 mapped addresses +.Po +IPv4 connection on +.Dv AF_INET6 +socket +.Pc . +For the latter case, running two daemons, +one for IPv4 and one for IPv6, will avoid the problem. +.Sh SECURITY CONSIDERATIONS +.Cm RFC 959 +provides no restrictions on the +.Sy PORT +command, and this can lead to security problems, as +.Nm +can be fooled into connecting to any service on any host. +With the +.Dq checkportcmd +feature of the +.Xr ftpd.conf 5 , +.Sy PORT +commands with different host addresses, or TCP ports lower than +.Dv IPPORT_RESERVED +will be rejected. +This also prevents +.Sq third-party proxy ftp +from working. +Use of this option is +.Em strongly +recommended, and enabled by default. +.Pp +By default +.Nm +uses a port that is one less than the port it is listening on to +communicate back to the client for the +.Sy EPRT , +.Sy LPRT , +and +.Sy PORT +commands, unless overridden with +.Fl P Ar dataport . +As the default port for +.Nm +(21) is a privileged port below +.Dv IPPORT_RESERVED , +.Nm +retains the ability to switch back to root privileges to bind these +ports. +In order to increase security by reducing the potential for a bug in +.Nm +providing a remote root compromise, +.Nm +will permanently drop root privileges if one of the following is true: +.Bl -enum -offset indent +.It +.Nm +is running on a port greater than +.Dv IPPORT_RESERVED +and the user has logged in as a +.Sq guest +or +.Sq chroot +user. +.It +.Nm +was invoked with +.Fl r . +.El +.Pp +Don't create +.Pa ~ftp/tmp +if you don't want anonymous users to upload files there. +That directory is only necessary if you want to display the error +messages of conversion commands to the user. +Note that if uploads are disabled with the +.Xr ftpd.conf 5 +directive +.Sy upload , +then this directory cannot be abused by the user in this way, so it +should be safe to create. +.Pp +To avoid possible denial-of-service attacks, +.Sy SIZE +requests against files larger than 10240 bytes will be denied if +the current transfer +.Sy TYPE +is +.Sq Li A +(ASCII). diff --git a/static/netbsd/man8/fusermount.8 b/static/netbsd/man8/fusermount.8 new file mode 100644 index 00000000..01ea3dfc --- /dev/null +++ b/static/netbsd/man8/fusermount.8 @@ -0,0 +1,127 @@ +.\" $NetBSD: fusermount.8,v 1.4 2007/12/02 21:22:03 wiz Exp $ */ +.\" +.\" Copyright (c) 2007 Alistair Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" +.Dd June 11, 2007 +.Dt FUSERMOUNT 8 +.Os +.Sh NAME +.Nm fusermount +.Nd manage librefuse mount items +.Sh SYNOPSIS +.Nm +.Op Fl chpVx +.Op Fl d Ar name +.Ar refuseoptions +.Nm +.Fl u +.Ar mountpoint(s) +.Sh DESCRIPTION +The +.Nm +utility acts as a frontend to the +.Xr refuse 3 +library, allowing mounting and unmounting of +refuse-based +file systems. +.Pp +There are essentially two forms of the +.Nm +command. +The first, and default option, is to mount a +refuse-based +file system. +By using the +.Fl u +argument, the file system can be unmounted. +.Pp +The arguments to +.Nm +are as follows: +.Bl -tag -width Ds +.It Fl c +Set a flag to enable kernel caching of files. +At present this option has no effect. +.It Fl d Ar name +Make the name argument appear as the file system +name in +.Xr mount 8 +and +.Xr df 1 +output. +.It Fl h +Print a usage message and exit. +.It Fl p +Check the file permissions. +At present this option has no effect. +.It Fl V +Display the +.Nm +version on stdout, and then exit successfully. +.It Fl x +Allow mortal (non-root) users to access the file system. +At present, this option has no effect. +.El +.Pp +The +.Nm +utility is included mainly for compatibility reasons, since some +file systems demand its existence. +.Sh EXIT STATUS +.Nm +returns 0 for successful operation, or +non-zero if one of the operations did not complete successfully. +.Sh EXAMPLES +The command +.Dl fusermount -d ntfs-3g unused mount.ntfs-3g ntfs.img /mnt +will mount the file +.Pa ntfs.img +on the directory +.Pa /mnt . +Please note the +.Pa unused +argument in the command, which is necessary for compatibility +with other implementations of the +.Nm +command. +.Sh SEE ALSO +.Xr df 1 , +.Xr puffs 3 , +.Xr refuse 3 , +.Xr mount 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 5.0 . +.Sh AUTHORS +The +.Nm +utility was written by +.An Alistair Crooks +.Aq agc@NetBSD.org . diff --git a/static/netbsd/man8/fwctl.8 b/static/netbsd/man8/fwctl.8 new file mode 100644 index 00000000..30af6a5e --- /dev/null +++ b/static/netbsd/man8/fwctl.8 @@ -0,0 +1,229 @@ +.\" $NetBSD: fwctl.8,v 1.17 2014/03/18 18:20:46 riastradh Exp $ +.\" +.\" Copyright (c) 2005 KIYOHARA Takashi +.\" All rights reserved. +.\" +.\" Copyright (c) 2002 Hidetoshi Shimokawa +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, +.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD: src/usr.sbin/fwcontrol/fwcontrol.8,v 1.21 2007/10/31 05:59:17 brueffer Exp $ +.\" +.Dd August 24, 2010 +.Dt FWCTL 8 +.Os +.Sh NAME +.Nm fwctl +.Nd IEEE1394 control utility +.Sh SYNOPSIS +.Nm +.Op Fl prt +.Op Fl b Ar pri_req +.Op Fl c Ar node +.Op Fl d Ar node +.Op Fl g Ar gap_count +.Op Fl l Ar file +.Op Fl M Ar mode +.Op Fl m Ar EUI64 | hostname +.Op Fl o Ar node +.Op Fl R Ar filename +.Op Fl S Ar filename +.Op Fl s Ar node +.Op Fl u Ar bus_num +.Sh DESCRIPTION +The +.Nm +utility is designed to provide a way for users to access and control +the +.Nx +IEEE1394 subsystem. +Without options, +.Nm +will output a list of devices that are/were connected to the bus. +.Pp +The following options are available: +.Bl -tag -width XmXEUI64XhostnameXX -offset indent +.It Fl b Ar pri_req +Set the +.Dv PRIORITY_BUDGET +register on all supported nodes. +.It Fl c Ar node +Show the configuration ROM on the node. +.It Fl d Ar node +Hex dump of the configuration ROM. +.It Fl f Ar node +Force specified +.Ar node +to be the root node on the next bus reset by sending a PHY config packet. +Valid values are 0 - 63. +.It Fl g Ar gap_count +Broadcast new +.Ar gap_count +by phy_config packet. +By default this value is 63 on all nodes. +Valid values are 0 - 63. +.It Fl i Ar pri_req +Set the +.Dv PRIORITY_BUDGET +register on all supported nodes. +.It Fl l Ar file +Load hex dump file of the configuration ROM and parse it. +.It Fl M Ar mode +Explicitly specify either +.Ar dv +or +.Ar mpeg +mode for the incoming stream. +Only meaningful in case of and must precede the +.Fl R +option. +If not specified, the program will try to guess. +In case of +.Dq format 0x20 +error, try to force the +.Ar mpeg +mode. +.It Fl m Ar EUI64 | hostname +Set default fwmem target. +Hostname will be converted to EUI64. +.It Fl o Ar node +Send a link-on PHY packet to the node. +.It Fl p +Dump PHY registers. +.It Fl R Ar filename +Receive DV or MPEG TS stream and dump it to a file. +Use Ctrl-C to stop receiving. +Some DV cameras seem not to send the stream if a bus manager exits. +If you cannot get the stream, try the following commands: +.Bd -literal -offset indent +sysctl hw.ieee1394if.try_bmr=0 +fwctl -r +.Ed +.Pp +The resulting file contains raw DV data excluding isochronous header +and CIP header. +It can be handled by the +.Pa pkgsrc/multimedia/libdv +package. +The resulting MPEG TS stream can be played and sent over a network using +the VideoLAN tool +.Pa ( pkgsrc/multimedia/vlc ) . +The stream can be piped directly to +.Nm vlc , +see +.Sx EXAMPLES . +.It Fl r +Initiate bus reset. +.It Fl S Ar filename +Send a DV file as isochronous stream. +.It Fl s Ar node +Write to the +.Dv RESET_START +register on the node. +.It Fl t +Show the topology map. +.It Fl u Ar bus_num +Specify the IEEE1394 bus number to be operated on. +The default is bus 0. +.El +.Sh FILES +.Bl -tag +.It Pa /dev/fw0.0 +.El +.Sh EXAMPLES +Each DV frame has a fixed size and it is easy to edit the frame order. +.Pp +.Dl "fwctl -R original.dv" +.Pp +Receive a DV stream with DV camera attached. +.Pp +.Dl "dd if=original.dv of=first.dv bs=120000 count=30" +.Pp +Get first 30 frames (NTSC). +.Pp +.Dl "dd if=original.dv of=second.dv bs=120000 skip=30 count=30" +.Pp +Get second 30 frames (NTSC). +.Pp +.Dl "cat second.dv first.dv | fwctl -S /dev/stdin" +.Pp +Swap first and second 30 frames and send them to DV recorder. +.Pp +For PAL, replace +.Dq Li bs=120000 +with +.Dq Li bs=144000 . +.Pp +.Dl "fwctl -R file.m2t" +.Pp +Receive an MPEG TS stream from a camera producing MPEG transport stream. +This has been tested with SONY HDR-FX1E camera that produces HD +MPEG-2 stream at 25 Mbps bandwidth. +.Pp +To send the stream from the camera over the network using TCP (which +surprisingly works better with vlc), you can use +.Dl "fwctl -R - | nc 192.168.10.11 9000" +with +.Pa pkgsrc/net/netcat +and to receive the stream, use +.Dl nc -l -p 9000 | vlc - +.Pp +To netcast via UDP, you need to use +.Pa pkgsrc/misc/buffer , +since vlc is not fast enough to read UDP packets from +buffers and thus it experiences dropouts when run directly. +The sending side can use +.Dl "fwctl -R - | nc 192.168.10.11 9000" +and to receive the stream, use +.Dl nc -l -u -p 9000 | buffer -s 10k -b 1000 -m 20m -p 5 | vlc - +.Pp +For more information on how to work with +.Nm vlc +see its documentation. +.Sh SEE ALSO +.Xr mplayer 1 , +.Xr vlc 1 , +.Xr fwip 4 , +.Xr fwohci 4 , +.Xr ieee1394if 4 , +.Xr sbp 4 +.Sh HISTORY +The +.Nm +command first appeared in +.Fx 5.0 , +as +.Ic fwcontrol . +It was added to +.Nx 4.0 +under its present name. +.Sh AUTHORS +.An Hidetoshi Shimokawa Aq Mt simokawa@FreeBSD.org +.An Petr Holub Aq Mt hopet@ics.muni.cz +- MPEG TS mode. +.An KIYOHARA Takashi Aq Mt kiyohara@NetBSD.org +.Sh BUGS +This utility is still under development and provided for debugging +purposes. +Especially MPEG TS reception support is very rudimental and supports only +high-bandwidth MPEG-2 streams (fn field in CIP header equals 3). diff --git a/static/netbsd/man8/getNAME.8 b/static/netbsd/man8/getNAME.8 new file mode 100644 index 00000000..79d401a3 --- /dev/null +++ b/static/netbsd/man8/getNAME.8 @@ -0,0 +1,92 @@ +.\" $NetBSD: getNAME.8,v 1.12 2008/05/29 14:51:25 mrg Exp $ +.\" +.\" Copyright (c) 1997 Matthew R. Green +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd October 31, 1997 +.Dt GETNAME 8 +.Os +.Sh NAME +.Nm getNAME +.Nd "get NAME sections from manual source for whatis/apropos data base" +.Sh SYNOPSIS +.Nm +.Op Fl itvw +.Ar path Op Ar path ... +.Sh DESCRIPTION +The +.Nm +utility looks inside manual page sources to find the name of the page. +It can be used to create a table of contents, report the style of manual, +or to create an introductory manual page. +By default, +.Nm +returns data for use in an +.Xr apropos 1 +database. +.Nm +is designed to be called from manual grovelling tools, not to be used directly. +.Pp +Historically, +.Xr makewhatis 8 +used to use +.Nm +to get manpage names, but that's no longer the case. +.Sh OPTIONS +The following options are available: +.Bl -tag -width Ds +.It Fl i +Print information useful in creating an introduction manual. +See +.Xr intro 1 , +.Xr intro 2 , +etc. for examples. +.It Fl t +Print information useful for creating a table of contents. +.It Fl v +Complain about incorrectly formatted man pages. +.It Fl w +Print information whether the manpage uses traditional man +.Pq Dq OLD , +new mandoc +.Pq Dq NEW , +or some unknown +.Pq Dq UNKNOWN +macros. +.El +.Sh SEE ALSO +.Xr man 1 , +.Xr catman 8 , +.Xr makewhatis 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Bx 2.0 . +.Sh BUGS +It would be nice if +.Nm +could deal with compressed and/or preformatted manual pages. +Looks for .S[Hh] NAME for consistency checking, but that breaks man pages +in other languages. diff --git a/static/netbsd/man8/getencstat.8 b/static/netbsd/man8/getencstat.8 new file mode 100644 index 00000000..77049caa --- /dev/null +++ b/static/netbsd/man8/getencstat.8 @@ -0,0 +1,90 @@ +.\" $NetBSD: getencstat.8,v 1.5 2009/04/11 13:24:00 wiz Exp $ +.\" $OpenBSD: $ +.\" $FreeBSD: $ +.\" +.\" Copyright (c) 2000 Matthew Jacob +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions, and the following disclaimer, +.\" without modification, immediately at the beginning of the file. +.\" 2. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" Alternatively, this software may be distributed under the terms of the +.\" the GNU Public License ("GPL"). +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR +.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" Matthew Jacob +.\" Feral Software +.\" mjacob@feral.com +.Dd February 21, 2000 +.Dt GETENCSTAT 8 +.Os +.Sh NAME +.Nm getencstat +.Nd get SCSI Environmental Services Device enclosure status +.Sh SYNOPSIS +.Nm +.Op Fl v +.Ar device +.Op Ar device ... +.Sh DESCRIPTION +.Nm +gets summary and detailed SCSI Environmental Services (or SAF-TE) device +enclosure status. +The overall status is printed out. +If the overall status +is considered okay, nothing else is printed out (unless the +.Fl v +option is used). +.Pp +A SCSI Environmental Services device enclosure may be either in the state +of being +.Sy OK , +or in one or more of the states of +.Sy INFORMATIONAL , +.Sy NON-CRITICAL , +.Sy CRITICAL , +or +.Sy UNRECOVERABLE +states. +These overall states reflect a summary of the states of each object within +such a device (such as power supplies or disk drives). +.Pp +With the +.Fl v +option, the status of all objects within the device is printed, whether +.Sy OK +or not. +Along with the status of each object is the object identifier. +.Pp +The user may then use +.Xr setencstat 8 +to try and clear overall device status, or may use +.Xr setobjstat 8 +to set specific object status. +.Sh FILES +.Bl -tag -width /dev/sesN -compact +.It Pa /dev/ses Ns Ar N +SCSI Environmental Services Devices +.El +.Sh SEE ALSO +.Xr ses 4 , +.Xr sesd 8 , +.Xr setencstat 8 , +.Xr setobjstat 8 diff --git a/static/netbsd/man8/getty.8 b/static/netbsd/man8/getty.8 new file mode 100644 index 00000000..54e289e5 --- /dev/null +++ b/static/netbsd/man8/getty.8 @@ -0,0 +1,162 @@ +.\" $NetBSD: getty.8,v 1.19 2020/02/26 15:44:57 riastradh Exp $ +.\" +.\" Copyright (c) 1980, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)getty.8 8.1 (Berkeley) 6/4/93 +.\" +.Dd May 29, 2013 +.Dt GETTY 8 +.Os +.Sh NAME +.Nm getty +.Nd set terminal modes for system access +.Sh SYNOPSIS +.Nm +.Oo +.Ar type +.Op Ar tty +.Oc +.Sh DESCRIPTION +The +.Nm +program +is called by +.Xr init 8 +to open and initialize the tty line, read a login name, and invoke +.Xr login 1 . +The devices on which to run +.Nm +are normally determined by +.Xr ttys 5 . +.Pp +The +.Nm +program can also recognize a Point to Point Protocol +.Pq Tn PPP +negotiation, and, if the +.Sy pp +attribute in +.Xr gettytab 5 +is set, invoke the program given by that string, e.g., +.Xr pppd 8 , +instead of +.Xr login 1 . +This makes it possible to use a single serial port for either a +.Qq shell +account with command line interface, or a +.Tn PPP +network link. +.Pp +The argument +.Ar tty +is the special device file in +.Pa /dev +to open for the terminal +.Po +for example, +.Qq ttyh0 +.Pc . +If there is no argument or the argument is +.Ql Fl , +the tty line is assumed to be open as file descriptor 0. +.Pp +The +.Ar type +argument can be used to make +.Nm +treat the terminal line specially. +This argument is used as an index into the +.Xr gettytab 5 +database, to determine the characteristics of the line. +If there is no argument, or there is no such table, the +.Em default +table is used. +If there is no +.Pa /etc/gettytab +a set of system defaults is used. +If indicated by the table located, +.Nm +will clear the terminal screen, +print a banner heading, +and prompt for a login name. +Usually either the banner or the login prompt will include +the system hostname. +.Pp +.Nm +uses the +.Xr ttyaction 3 +facility with an action of +.Qq getty +and user +.Qq root +to execute site-specific commands when it starts. +.Pp +Most of the default actions of +.Nm +can be circumvented, or modified, by a suitable +.Xr gettytab 5 +table. +.Pp +The +.Nm +program can be set to timeout after some interval, +which will cause dial up lines to hang up +if the login name is not entered reasonably quickly. +.Sh FILES +.Bl -tag -width /usr/libexec/getty -compact +.It Pa /etc/gettytab +.It Pa /etc/ttys +.It Pa /usr/libexec/getty +.El +.Sh DIAGNOSTICS +.Bl -diag +.It "ttyxx: No such device or address." +.It "ttyxx: No such file or address." +A terminal which is turned on in the +.Xr ttys 5 +file cannot be opened, likely because the requisite +lines are either not configured into the system, the associated device +was not attached during boot-time system configuration, +or the special file in +.Pa /dev +does not exist. +.El +.Sh SEE ALSO +.Xr login 1 , +.Xr ioctl 2 , +.Xr ttyaction 3 , +.Xr tty 4 , +.Xr gettytab 5 , +.Xr ttys 5 , +.Xr init 8 , +.Xr pppd 8 +.Sh HISTORY +A +.Nm +program appeared in +.At v6 . diff --git a/static/netbsd/man8/gpioctl.8 b/static/netbsd/man8/gpioctl.8 new file mode 100644 index 00000000..11b11602 --- /dev/null +++ b/static/netbsd/man8/gpioctl.8 @@ -0,0 +1,229 @@ +.\" $NetBSD: gpioctl.8,v 1.24 2019/10/20 17:45:08 wiz Exp $ +.\" +.\" Copyright (c) 2009, 2010, 2011, 2013 Marc Balmer +.\" Copyright (c) 2004 Alexander Yurchenko +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd October 20, 2019 +.Dt GPIOCTL 8 +.Os +.Sh NAME +.Nm gpioctl +.Nd control GPIO devices +.Sh SYNOPSIS +.Nm gpioctl +.Op Fl qs +.Ar device +.Nm gpioctl +.Op Fl q +.Ar device +.Cm attach +.Ar device +.Ar offset +.Ar mask +.Op Ar flag +.Nm gpioctl +.Op Fl qs +.Ar device +.Ar pin +.Op Ar 0 | 1 | 2 +.Nm gpioctl +.Op Fl qs +.Ar device +.Ar pin +.Op Ar on | off | toggle +.Nm gpioctl +.Op Fl q +.Ar device +.Ar pin +.Cm set +.Op Ar flags +.Op Ar name +.Nm gpioctl +.Op Fl q +.Ar device +.Ar pin +.Cm unset +.Nm gpioctl +.Op Fl q +.Ar device +.Ar list +.Sh DESCRIPTION +The +.Nm +program allows manipulation of GPIO +(General Purpose Input/Output) device pins. +Such devices can be either part of the chipset or embedded CPU, +or a separate chip. +The usual way of using GPIO +is to connect some simple devices such as LEDs and 1-wire thermal sensors +to its pins. +.Pp +Each GPIO device has an associated device file in the +.Pa /dev +directory. +.Ar device +can be specified with or without the +.Pa /dev +prefix. +For example, +.Pa /dev/gpio0 +or +.Pa gpio0 . +.Pp +GPIO pins can be either +.Dq read +or +.Dq written +with the values of logical 0 or 1. +If only a +.Ar pin +number is specified on the command line, the pin state will be read +from the GPIO controller and displayed. +To write to a pin, a value must be specified after the +.Ar pin +number. +Values can be either 0 or 1. +A value of 2 +.Dq toggles +the pin, i.e. changes its state to the opposite. +Instead of the numerical values, the word +.Ar on , +.Ar off , +or +.Ar toggle +can be used. +.Pp +Only pins that have been configured at securelevel 0, typically during system +startup, are accessible once the securelevel has been raised. +Pins can be given symbolic names for easier use. +Besides using individual pins, device drivers that use GPIO pins can be +attached to a +.Xr gpio 4 +device using the +.Nm +command. +Such drivers can be detached at runtime using the +.Xr drvctl 8 +command. +.Pp +The following configuration +.Ar flags +are supported by the GPIO framework: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It in +input direction +.It out +output direction +.It inout +bi-directional +.It od +open-drain output +.It pp +push-pull output +.It tri +tri-state (output disabled) +.It pu +internal pull-up enabled +.It pd +internal pull-down enabled +.It iin +invert input +.It iout +invert output +.It pulsate +pulsate output at a hardware-defined frequency and duty cycle +.It alt0 - alt7 +select alternate pin function 0 to 7 +.El +.Pp +Note that not all the flags may be supported by the particular GPIO controller. +.Pp +When executed with only the +.Xr gpio 4 +device name as argument, +.Nm +reads information about the GPIO device and displays it. +At securelevel 0 the number of physically available pins is displayed, +at higher securelevels the number of configured (set) pins is displayed. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl q +Operate quietly i.e. nothing is printed to stdout. +.It Fl s +Only output a single number on stdout, representing either the state of the +pin or the number of available pins if no pin number was passed as argument. +This option is useful e.g. when +.Nm +is used in shell scripts to query the state of a pin. +.El +.Sh FILES +.Bl -tag -width "/dev/gpiou" -compact +.It /dev/gpio Ns Ar u +GPIO device unit +.Ar u +file. +.El +.Sh EXAMPLES +Configure pin 20 to have push-pull output: +.Pp +.Dl # gpioctl gpio0 20 set out pp +.Pp +Write logical 1 to pin 20: +.Pp +.Dl # gpioctl gpio0 20 1 +.Pp +Attach a +.Xr onewire 4 +bus on a +.Xr gpioow 4 +device on pin 4: +.Pp +.Dl # gpioctl gpio0 attach gpioow 4 0x01 +.Pp +Detach the gpioow0 device: +.Pp +.Dl # drvctl -d gpioow0 +.Pp +Configure pin 5 as output and name it error_led: +.Pp +.Dl # gpioctl gpio0 5 set out error_led +.Pp +Toggle the error_led: +.Pp +.Dl # gpioctl gpio0 error_led 2 +.Pp +Enumerate all pins and display their symbolic names: +.Pp +.Dl # gpioctl gpio0 list +.Sh SEE ALSO +.Xr gpio 4 , +.Xr drvctl 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Ox 3.6 +and +.Nx 4.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +program was written by +.An Alexander Yurchenko Aq Mt grange@openbsd.org . +Device attachment was added by +.An Marc Balmer Aq Mt marc@msys.ch . diff --git a/static/netbsd/man8/gpt.8 b/static/netbsd/man8/gpt.8 new file mode 100644 index 00000000..963ede95 --- /dev/null +++ b/static/netbsd/man8/gpt.8 @@ -0,0 +1,1714 @@ +.\" $NetBSD: gpt.8,v 1.89 2026/02/17 01:41:56 kre Exp $ +.\" +.\" Copyright (c) 2002 Marcel Moolenaar +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD: src/sbin/gpt/gpt.8,v 1.17 2006/06/22 22:22:32 marcel Exp $ +.\" +.Dd February 9, 2026 +.Dt GPT 8 +.Os +.Sh NAME +.Nm gpt +.Nd GUID partition table maintenance utility +.Sh SYNOPSIS +.Nm +.Op Fl Hnqrv +.Op Fl m Ar mediasize +.Op Fl s Ar sectorsize +.Op Fl T Ar timestamp +.Ar command +.Op Ar command_options +.Ar device +.Nm +.Op Fl qv +.Cm set +.Fl l +.Nm +.Op Fl qv +.Cm unset +.Fl l +.Nm +.Op Fl qv +.Cm type +.Fl l +.sp 0.3v +.Nm nbgpt +.Op Fl Hnqrv +.Op Fl m Ar mediasize +.Op Fl s Ar sectorsize +.Op Fl T Ar timestamp +.Ar device +.Ar command +.Op Ar command_options +.Sh DESCRIPTION +The +.Nm gpt +utility provides the necessary functionality to manipulate GUID partition +tables +.Pq GPTs , +but see +.Sx BUGS +below for how and where functionality is missing. +The general options are described in the following paragraph. +The remaining paragraphs describe the individual commands with their options. +A +.Ar device +is either a special file +corresponding to a disk-like device or a regular file. +.\" +.\"XXX Who dreamed up this insanity? It is wrong, and +.\"XXX wouldn't be useful, or desirable, in any case. +.\"XXX It is also close to unimplementable (particularly with +.\"XXX the current ambidextrous device specification positioning. +.\" The command is applied to each +.\" .Ar device +.\" listed on the command line. +The +.Ar command +specifies the operation to be performed upon the GPT of the +.Ar device +specified. +Commands possible are listed below. +.Pp +Note that when built as a tool, and named +.Dq Cm nbgpt +or when run using any other filesystem name than +.Dq Nm +the (usually required) +.Ar device +parameter is placed between the general options and the +.Ar command +name specified, rather than at the end of the argument list. +.Ss General Options +The general options allow the user to change default settings or otherwise +change the behaviour that is applicable to all commands. +Not all commands use all default settings, so some general options may not +have an effect on all commands. +These options are given before the +.Ar command +name. +Each (or at least most) of the +.Ar command Ns s +has options of its own, specified below, which follow the +.Ar command +name. +The same option letter may be used, with different effects, +as a general and command specific option. +.Bl -tag -width XXXX +.It Fl H +Ignore existing MBR (Hybrid MBR/GPT mode). +.It Fl m Ar mediasize +Override the default media size for the device (obtained +from the kernel if possible) or defaulting to the file size for +plain files. +This size is in units of bytes, but can be scaled by adding +one of the suffixes allowed for the +.Ar size +in the +.Cm add +command below +.Po +except for +.Sq e +which is not implemented here +.Pc . +If this option is given, +and +.Fl r +is neither given nor implied, +then +.Ar device +is permitted to be an empty, +or even not yet existing, +ordinary file. +.It Fl n +Do not update the kernel's wedge information to reflect +changes made by +.Nm . +The +.Xr dkctl 8 +command can be used later +to manually update the kernel's wedge configuration for the +.Ar device +if +.Fl n +is used. +.It Fl q +Do not print error messages. +This is not implemented completely yet. +.It Fl r +Open the device for reading only. +Currently this option is primarily useful for the +.Ic show +and +.Ic header +commands (where it is the default), +but the intent is to also use it to implement dry-run behaviour. +This is implied if the device can be opened for reading, +but not for writing, +and is always applied when the +.Ar command +given does not ever require write access. +.It Fl s Ar sectorsize +Override the default sector size for the +.Ar device +.Po +obtained from the kernel if possible, or +.Dv 512 +for plain files +.Pc . +The sector size is given as a simple (unsigned) integer, +possibly scaled by a +.Sq K +suffix, indicating kilobytes (KiB), +specifying the number of bytes in each sector. +This option usually needs to be repeated with every +command applied to the affected +.Ar device . +.It Fl T Ar timestamp +Specify a timestamp to be used for uuid generation so that uuids +are not random and can be consistent for reproducible builds. +Each time a command which will create uuids is run, +e.g.: +.Nm +.Cm add , +.Nm +.Cm create , +.Nm +.Cm migrate , +or +.Nm +.Cm uuid , +with the same +.Ar device +or another device which will be used in the same system, +if +.Fl T +is to be used, +it should be given a different timestamp from that used with +any other uuid which might be used in the same system as +.Ar device . +Otherise the same uuids will be generated for multiple uses, +and not be unique. +This option should not be used other than for testing, +or making temporary filesystems for distributions, etc. +When this option is not given, +timestamps are based upon a random number supplied by the kernel. +.Pp +The +.Ar timestamp +can be a pathname, +where the timestamps are derived from the file named, +an integer value interpreted +as the number of seconds from the Epoch, +or a parsable date string for parsedate(3) (this final option is not +yet available in the tools build). +.It Fl v +Controls the verbosity level. +The level increases with every occurrence of this option. +There is no formalized definition of the different levels yet. +.El +.Ss Commands +.Pp +.Bl -tag -width indent -compact +.\" ==== add ==== +.Pp +.It Nm Ic add Oo Fl a Ar alignment Oc Oo Fl b Ar blocknr Oc \ +Oo Fl i Ar index Oc Oo Fl l Ar label Oc Oo Fl s Ar size Oc \ +Oo Fl t Ar type Oc +.Pp +The +.Ic add +command allows the user to add a new partition to an existing table. +By default, +it will create an unlabeled UFS partition +starting at the first available block of an unused disk space. +The command-specific options can be used to control this behaviour. +.Pp +The +.Fl a Ar alignment +option allows the user to specify an alignment for the start and size. +The alignment is given in bytes and may have a suffix to indicate its +magnitude, see the +.Fl s +option description just below. +.Nm +will attempt to align the partition. +.Pp +The +.Fl b Ar blocknr +option allows the user to specify the starting (beginning) sector number of +the partition. +The minimum sector number is 1, but has to fall inside an unused region of +disk space that is covered by the GPT. +When not given +.Nm +will select a suitable available empty space, if any exists. +.Pp +The +.Fl i Ar index +option allows the user to specify which (free) entry in the GPT table is to +be used for the new partition. +By default, the first free entry is selected. +.Pp +The +.Fl l Ar label +option allows the user to specify a label for the partition. +See the description of the +.Nm +.Cm label +command for more information on labels. +.Pp +The +.Fl s Ar size +option allows the user to specify the size of the partition. +If there is no suffix, or the suffix is +.Sq s +or +.Sq S +then size is in sectors, otherwise size is in bytes which must be +a multiple of the device's sector size. +Accepted suffix units (case insensitive) are +.Sq b +to denote bytes, +.Sq k +to denote kilobytes, +.Sq m +to denote megabytes, +.Sq g +to denote gigabytes, +.Sq t +to denote terabytes, +.Sq p +to denote petabytes, and +.Sq e +to denote exabytes. +The minimum size is 1 sector. +If not specified, +.Nm +will use all of the available space in the +empty area selected by the +.Fl b +option, after the selected +.Ar blocknr , +subject to alignment constraints. +.Pp +The +.Fl t Ar type +option allows the user to specify the partition type. +If this option is omitted, +a +.Nx +FFS partition type +.Pq Cm ffs +will be created. +The type can be given as a UUID, but +.Nm +accepts, amongst others: +.Bl -tag -width "windows-reserved" -compact -offset indent +.It Cm efi +EFI System +.It Cm ccd +.Nx +ccd component +.It Cm cgd +.Nx +Cryptographic Disk +.It Cm ffs +.Nx +FFSv1/FFSv2 +.It Cm lfs +.Nx +LFS +.It Cm raid +.Nx +RAIDFrame component +.It Cm swap +.Nx +swap +.It Cm zfs +.Nx +or +.Fx +ZFS +.It Cm fbsd-ufs +.Fx +UFS/UFS2 +.It Cm fbsd-swap +.Fx +swap +.It Cm apple +Apple HFS +.It Cm bios +BIOS Boot +.It Cm linux-data +Linux data +.It Cm linux-swap +Linux swap +.It Cm linux-lvm +Linux LVM +.It Cm obsd +OpenBSD data +.It Cm windows +Microsoft basic data - NTFS, FAT32 ("msdos"), FAT16, also used for UDF +.El +as aliases for the most commonly used partition types. +.br +Use: +.Do +.Nm +.Cm type Fl l +.Dc +to obtain an up to date list of the supported aliases. +.\" ==== backup ==== +.Pp +.It Nm Ic backup Oo Fl o Ar outfile Oc +The +.Ic backup +command dumps the MBR or (PMBR) and GPT partition tables to standard +output or to a file specified by the +.Ar outfile +argument in a format to be used by the +.Ic restore +command. +The format is a plist. +It should not be modified. +.\" ==== biosboot ==== +.Pp +.It Nm Ic biosboot Oo Fl A Oc Oo Fl c Ar bootcode Oc Oo Fl b Ar startsec Oc \ +Oo Fl i Ar index Oc Oo Fl L Ar label Oc +The +.Ic biosboot +command allows the user to configure the partition that contains the +primary bootstrap program, used during +.Xr boot 8 +when the system firmware (BIOS) either cannot handle EFI +booting, or is configured not to. +.Pp +The +.Fl A +options sets the PMBR partition active. +This should not normally be necessary, +but some firmware might require it. +If +.Fl A +is omitted, the active flag will be cleared from the PMBR header. +.Pp +The +.Fl c +option allows the user to specify the filename from which +.Nm +should read the bootcode. +The default is to read from +.Pa /usr/mdec/gptmbr.bin . +.Pp +The partition that should contain the primary bootstrap code, +.Pq similar to that installed via Xr installboot 8 +is selected using the +.Fl i , +.Fl L +and +.Fl b +options. +One of these three options is required. +The +.Fl i +option selects the partition given by the +.Ar index . +The +.Fl L +option selects the partition by +.Ar label . +If there are multiple partitions with the same label, +the first one found will be used. +The +.Fl b +option selects the partition starting at block +.Ar startsec . +.\" ==== create ==== +.Pp +.It Nm Ic create Oo Fl AfP Oc Oo Fl p Ar partitions Oc +The +.Ic create +command allows the user to create a new (empty) GPT. +By default, one cannot create a GPT when the device contains an MBR, +however this can be overridden with the +.Fl f +option. +If the +.Fl f +option is specified, +an existing MBR is destroyed and any partitions +described by the MBR are lost. +See the +.Cm migrate +command below for an alternative. +A PMBR header, +with one allocated partition +.Pq the GPT partition , +covering the entire +.Ar device , +is created. +.Pp +The +.Fl A +option sets the PMBR partition active. +.Pp +The +.Fl P +option tells +.Nm +to create only the primary table and not the backup table. +This option is only useful for debugging and should not be used otherwise. +.Pp +The +.Fl p +option changes the default number of partitions the GPT can +accommodate. +This is set whenever a new GPT is created, +and can only +.Pq currently +be changed by destroying the GPT and beginning again. +By default, the +.Nm +utility will create space for 128 partitions +.Pq 32 sectors if they are each 512 bytes . +The +.Ar partitions +value given will be rounded up as needed so that no free space remains +in the last allocated partition table sector. +The number of partition table entries per sector varies with the +sector size. +.Pq It is assumed that sector sizes are a power of two, and not less than 128. +.\" ==== destroy ==== +.Pp +.It Nm Ic destroy Oo Fl r Oc +The +.Ic destroy +command allows the user to destroy an existing, +possibly not empty, +GPT. +.Pp +The +.Fl r +option instructs +.Nm +to destroy the table in a way that it can be recovered. +.\" ==== header ==== +.Pp +.It Nm Ic header +The +.Ic header +command displays size information about the media +.Pq Ar device +and information from its +GPT header if it exists. +.\" ==== label ==== +.Pp +.It Nm Ic label Fl a Ao Fl f Ar file | Fl l Ar newlabel Ac +.It Nm Ic label Oo Fl b Ar blocknr Oc Oo Fl i Ar index Oc \ +Oo Fl L Ar label Oc Oo Fl s Ar sectors Oc Oo Fl t Ar type Oc \ +Ao Fl f Ar file | Fl l Ar newlabel Ac +.Pp +The +.Ic label +command allows the user to label any partitions that match the selection. +At least one of the following selection options must be specified. +.Pp +The +.Fl a +option specifies that all partitions should be labeled. +It is mutually exclusive with all other selection options. +.Pp +The +.Fl b Ar blocknr +option selects the partition that starts at the given block number. +.Pp +The +.Fl i Ar index +option selects the partition with the given partition number. +.Pp +The +.Fl L Ar label +option selects all partitions that have the given label. +This can cause multiple partitions to be relabeled. +.Pp +The +.Fl s Ar sectors +option selects all partitions that have the given size. +This can cause multiple partitions to be labeled. +.Pp +The +.Fl t Ar type +option selects all partitions that have the given type. +The type is given as a UUID or by the aliases that the +.Ic add +command accepts. +This can cause multiple partitions to be labeled. +.Pp +When more than one of the +.Fl b , +.Fl i , +.Fl L , +.Fl s +and +.Fl t +options are given, partitions much match all the given +criteria to be selected. +For this reason it is rarely useful to specify either +.Fl b +or +.Fl i +.Pq which can each only ever select one partition +with each other, or any of the other selection options, +unless the intent is something like: +.Dq Partition N provided that its X is Y +.Pq and otherwise nothing . +.Pp +A label consists of up to 36 characters (not bytes), and can contain +anything from the Unicode character set, with a 16 bit code-point, +except the NUL +.Pq Sq \e0 +character. +Uses of the label for other purposes generally restrict the useful +character set to exclude white space and newlines, +and often other unprintable characters, +and may impose a much shorter length restriction, +which would usually apply to the size of the label when encoded +in its input/output UTF-8 format. +.Pp +The +.Fl f Ar file +or +.Fl l Ar newlabel +options specify the new label to be assigned to the selected partitions. +The +.Fl f Ar file +option is used to read the new label from the specified file. +Only the first line is read from the file and the trailing newline +character is stripped. +If the file name is the dash or minus sign +.Pq Fl , +the new label is read from +the standard input. +The +.Fl l Ar newlabel +option is used to specify the new label on the command line. +With either option, +the new label supplied is assumed to be encoded in UTF-8. +Setting the label to be an empty string effectively causes +the label to be removed. +.\" ==== migrate ==== +.Pp +.It Nm Ic migrate Oo Fl Afs Oc Oo Fl p Ar partitions Oc +The +.Ic migrate +command allows the user to migrate an MBR-based disk partitioning into a +GPT-based partitioning. +By default, the MBR is not migrated when it contains partitions of an unknown +type. +This can be overridden with the +.Fl f +option. +Specifying the +.Fl f +option will cause unknown partitions to be ignored and any data in them +to be lost. +.Pp +The +.Fl A +option sets the PMBR partition active. +.Pp +The +.Fl s +option prevents migrating +.Bx +disk labels into GPT partitions by creating +the GPT equivalent of a slice. +Note that the +.Fl s +option is not applicable to +.Nx +partitions. +.Pp +The +.Fl p +option changes the default number of partitions the GPT can +accommodate, +as with the similar option to the +.Nm +.Cm create +command. +This is set whenever a new GPT is created. +By default, +the +.Nm +utility will create space for 128 partitions. +.Pp +The +.Ic migrate +command requires space at the beginning and the end of the device outside +any partitions to store the GPTs. +Space is required for the GPT header +.Pq which takes one sector +and the GPT partition table. +See the +.Fl p +option +for the size of the GPT partition table. +By default, just about all devices have a minimum of 62 sectors free at the +beginning of the device, but many do not have any free space at the end. +For the default GPT partition table size on a 512 byte sector size device, +33 sectors at the end of the device would need to be freed. +.\" ==== recover ==== +.Pp +.It Nm Ic recover +The +.Ic recover +command tries to restore the GPT partition label from the backup +near the end of the +.Ar device . +It is useful in case the primary label was deleted or overwritten, +and rarely otherwise. +.\" ==== remove ==== +.Pp +.It Nm Ic remove Fl a +.It Nm Ic remove Oo Fl b Ar blocknr Oc Oo Fl i Ar index Oc \ +Oo Fl L Ar label Oc Oo Fl s Ar sectors Oc Oo Fl t Ar type Oc +The +.Ic remove +command allows the user to remove any and all partitions that match the +selection. +It uses the same selection options as the +.Ic label +command. +See above for a description of these options. +Partitions are removed by clearing the partition type. +No other information is changed. +.\" ==== resize ==== +.Pp +.It Nm Ic resize Oo Fl i Ar index Oc Oo Fl b Ar startsec Oc Oo Fl a Ar alignment Oc \ +Oo Fl s Ar size Oc Oo Fl q Oc +The +.Ic resize +command allows the user to resize a partition. +The partition may be shrunk and if there is sufficient free space +immediately after it then it may be expanded. +The +.Fl s +option allows the new size to be specified, otherwise the partition will +be increased to the maximum available size. +If there is no suffix, or the suffix is +.Sq s +or +.Sq S +then size is in sectors, otherwise size is in bytes and must be +a multiple of the device's sector size. +Accepted suffix units are the same as those allowed for the +.Ar size +parameter to the +.Nm +.Cm add +command. +The minimum size is 1 sector. +If the +.Fl a +option is specified then the size will be adjusted to be a multiple of +.Ar alignment +if possible. +If the +.Fl q +option is specified then the utility will not print output when a +resize is not required. +.\" ==== resizedisk ==== +.Pp +.It Nm Ic resizedisk Oo Fl s Ar size Oc Oo Fl q Oc +The +.Ic resizedisk +command allows the user to resize a disk. +With GPTs, a backup copy of the label is stored at the end of the disk. +If the underlying medium changes size +.Pq or is going to change size , +then the backup label copy needs to be moved to the new end of the disk, +and the last sector available for data storage needs to be adjusted. +This command does that. +If the backup copy no longer exists due to the medium shrinking, then +a new backup copy will be created using the primary copy. +.Pp +The +.Fl s +option allows the new size to be specified, otherwise the backup copy +will automatically be placed at the current end of the disk. +If there is no suffix, or the suffix is +.Sq s +or +.Sq S +then size is in sectors, otherwise size is in bytes which must be +a multiple of the device's sector size. +Accepted suffix units are as for the +.Ar size +parameter of the +.Nm +.Cm add +command. +Using the +.Fl s +option allows you to move the backup copy prior to resizing the medium. +This is primarily useful when shrinking the medium. +If the +.Fl q +option is specified then the utility will not print output when a +resize is not required. +.\" ==== restore ==== +.Pp +.It Nm Ic restore Oo Fl F Oc Oo Fl i Ar infile Oc +The +.Ic restore +command restores a partition table that was previously saved using the +.Ic backup +command. +The partition table is read from standard input or a file specified in +the +.Ar infile +argument and is expected to be in the format of a plist. +It assumes an empty disk. +The +.Fl F +option can be used to blank the disk. +The new disk does not have to be the same size as the old disk as long as all +the partitions fit, as +.Ic restore +will automatically adjust. +However, the new disk must use the same sector size as the old disk. +.\" ==== set ==== +.Pp +.It Nm Ic set Fl l +.It Nm Ic set Oo Fl a Ar attribute Oc Ns ... Oo Fl N Oc Oo Fl i Ar index Oc \ +Oo Fl b Ar startsec Oc +The +.Ic set +command sets various partition attributes. +The +.Fl l +flag lists all available attributes. +The +.Fl a +option specifies which attributes to set and may be specified more than once, +or the attributes can be comma-separated. +The +.Fl N +option causes any existing attributes to be cleared before adding new ones. +If the +.Fl N +option is given, and no +.Fl a +options are specified, all attributes are removed. +The +.Fl i +or the +.Fl b +option specify which entry to update. +The possible attributes are +.Do biosboot Dc , +.Do bootme Dc , +.Do bootonce Dc , +.Do bootfailed Dc , +.Do noblockio Dc , and +.Do required Dc . +The +.Dq biosboot +flag is used to indicate which partition should be booted +by legacy BIOS boot code. +See the +.Cm biosboot +command for more information. +The +.Dq bootme +flag is used to indicate which partition should be booted +by the +.Nx +UEFI boot code. +If not set on any partition, the first (in terms of partition index) +FFS partition located will be used. +The other boot* attributes are for compatibility with +.Fx +and are not currently used by +.Nx . +.Po +They may be used by +.Nx +in the future. +.Pc +.\" ==== show ==== +.Pp +.It Nm Ic show Oo Fl AagHhlpuwx Oc \ +Oo Fl i Ar index Oc \ +Oo Fl b Ar startsec Oc \ +Oo Fl W Ar width Oc +The +.Ic show +command displays the current partitioning on the listed device and gives +an overall view of the disk contents. +.Pp +There are three output variants, each of which is available in +a form intended for human viewing, and another for machine parsing. +The formats for some of the data for human viewing can be varied +by several of the options. +.Pp +The +.Fl W +option allows the desired output width, for human output, to be set. +It defaults to the value of the +.Ev COLUMNS +environment variable, +if set, +otherwise the width of the output terminal device, +if available. +If the width has still not been obtained, +then it will default to 80, +unless the +.Fl w +option is given, +causing 120 columns to be used instead. +Repeating +.Fl w +in this case will generate even wider output +.Pq up to a point . +The output width is not used as much as it perhaps could be, +and in no case will cause truncation of output, +which will exceed the specified width if required. +.Pp +The first output variant provides an overall summary of +the partitioning of the specified +.Ar device . +It is produced when none of the +.Fl a , +.Fl b +or +.Fl i +options are used. +After a heading, +this format generates one line for each allocated partition, +for each gap between partitions, +and for the overhead sectors. +See the +.Sx OUTPUT FORMATS +section below for a complete description. +Each line contains the start block number, +the number of blocks, +and when a GPT user data partition is being listed, +its partition index, +and type \(en for other output lines, +their purpose. +Block numbers (start and size) are in units of the +.Ar device +sector size, +which can be viewed using the +.Nm +.Ic header +command. +.Pp +With the +.Fl g +option the GPT partition GUID will be displayed +instead of the GPT partition type. +With the +.Fl l +option the GPT partition label will be displayed +instead of the GPT partition type. +With the +.Fl u +option the GPT partition type is displayed as a UUID +instead of in a user friendly form. +The +.Fl l +and +.Fl u +options only have any effect on GPT partitions, +though +.Fl g +will also cause GPT header +.Dq partitions +to include the partition table's GUID, +and an MBR header to include its signature. +If more than one of those options are given, +.Fl l +takes precedence, +if the partition has a label, +then +.Fl g +and finally +.Fl u . +Specifying more than one of those options can allow variations +in the output depending upon what data is available. +.Pp +With the +.Fl p +option this output is produced in a parsable format, +with no header. +See +.Sx OUTPUT FORMATS +below for the details. +.Pp +With the +.Fl i +or the +.Fl b +option, +all the details of the particular GPT partition selected +will be displayed. +The format of this display remains subject to change. +When the +.Fl p +option is also given, +the format is more stable, +and always consists of a sequence of lines +each beginning with a keyword, +followed by a colon and a space, +and then the associated data value, +terminated by a newline character. +Note that only GPT user data partitions can be viewed this way, +that is partitions with an index greater than 0. +See the +.Sx OUTPUT FORMATS +section below for the details. +.Pp +With the +.Fl a +option, +all information for all partitions +.Pq also including the headers and gaps +will be printed. +When used together with +.Fl p +the output is a sequence of blocks of output as would +be generated for +.Fl p Fl i +or +.Fl p Fl b +each followed by a blank line signifying the end of that +partition's data. +Similar data blocks for gaps and header information are +included, +with the +.Cm Index +shown as 0. +In each case, +the partitions are shown in the order of increasing values +of the +.Cm Start +field. +.Pp +The format for presentation to humans of the start and size +information can be modified by the +.Fl A , +.Fl H , +.Fl h +and +.Fl x +options. +The +.Fl x +option prints start/size in hex, but is ignored if any of +the +.Fl A , +.Fl H , +.Fl h +or +.Fl p +options are also given. +The other three options +.Pq Fl AHh +give various forms of more human +digestible ways to view the start/size values, but are only +used when the +.Fl p +option is absent. +The +.Fl h +option decodes the start and size information into a +sequence of values which, +when summed, +produce the original simple numeric sector count value, +multiplied by the sector size, +that is, +the number of bytes. +Each of these values is followed by a scaling indicator, +where only non-zero multiples of the scale indicated are included. +The scaling indicators are +.Po +in order in which they would be presented, +descending order of scale magnitude +.Pc +.Cm E +2^60, +.Cm P +2^50, +.Cm T +2^40, +.Cm G +2^30, +.Cm M +2^20, +.Cm K +2^10, +and +.Cm B +2^0 (1). +.Pp +The +.Fl A +option instead uses +.Xr humanize_number 3 +to present start block numbers and sizes as a rounded +approximation to the actual value, +as measured in bytes (not sectors), +at a suitable scale. +.Pp +And least (in all respects) the +.Fl H +option causes the output from +.Fl h +.Pq which is implied with Fl H +to be scaled in decimal, +rather than binary, +units, +so +.Cm K +is 10^3 instead of 2^10, +and +.Cm G +is 10^9 instead of 2^30, +etc. +This can be combined with +.Fl A . +.Pp +The order of precedence for the main options is: +.Fl a , +.Fl b , +.Fl i , +.Fl l , +.Fl g , +.Fl u . +The +.Fl b +option will be ignored if no partition starting at +the given +.Ar startsec +is located. +.Pp +The +.Fl p +option can be combined with any of the above. +However the +.Fl A , +.Fl H +and +.Fl h +options have no effect when +.Fl b , +.Fl i , +or +.Fl p +are given, +and only a very limited effect with +.Fl a +.Po the start and size columns are not affected, +but additional information is included with the +.Dq Size: +output data for GPT user partitions +.Pc . +The +.Fl x +option is only used when none of the +.Fl A , +.Fl b , +.Fl H , +.Fl h , +.Fl i , +and +.Fl p +options are given. +.\" ==== type ==== +.Pp +.It Nm Ic type Fl l +.It Nm Ic type Fl a Fl T Ar newtype +.It Nm Ic type Oo Fl b Ar blocknr Oc Oo Fl i Ar index Oc \ +Oo Fl L Ar label Oc Oo Fl s Ar sectors Oc Oo Fl t Ar type Oc \ +Fl T Ar newtype +.Pp +The +.Ic type +command allows the user to change the type of any and all partitions +that match the selection. +It uses the same selection options as the +.Ic label +command. +See above for a description of these options. +The +.Ar newtype +specifies the UUID for the desired partition type, +or an alias, for a type known by +.Nm . +The +.Fl l +flag lists available types, +some of which are shown above with the +.Cm add +command. +.\" ==== unset ==== +.Pp +.It Nm Ic unset Fl l +.It Nm Ic unset Fl a Ar attribute Oo Fl a Ar attribute Oc Ns ... \ +Oo Fl i Ar index Oc Oo Fl b Ar startsec Oc +The +.Ic unset +command unsets various partition attributes. +The +.Fl l +flag lists all available attributes. +The +.Fl a +option specifies which attributes to unset and may be specified more than once. +Alternatively a comma separated list of attributes can be used. +The +.Fl i +or the +.Fl b +option specifies which entry to update. +The possible attributes are as indicated for the +.Nm +.Cm set +command. +.\" ==== uuid ==== +.Pp +.It Nm Ic uuid Fl a Oc Fl U Ar newuuid Oc +.It Nm Ic uuid Oo Fl b Ar blocknr Oc Oo Fl i Ar index Ar Oc \ +Oo Fl L Ar label Oc Oo Fl s Ar sectors Oc Oo Fl t Ar type Oc \ +Oo Fl U Ar newuuid Oc +.Pp +The +.Ic uuid +command allows the user to change the UUID of any and all partitions +that match the selection. +It uses the same selection options as the +.Ic label +command. +See above for a description of these options. +If +.Ar newuuid +is not specified, a random UUID value is derived from the timestamp +.Po see the +.Fl T +general option +.Pc . +If +.Fl a +is used, then all partitions are updated, +and the header UUID is changed as well. +.Pp +The primary purpose of this command is for use after cloning a disk to +prevent collisions when both disks are used in the same system. +.\" ==== end of commands ==== +.El +.Sh OUTPUT FORMATS +When the +.Fl p +option is used with the +.Nm +.Cm show +command, the output is intended to be parsable by other code, +including perhaps GUI applications, +intending to manipulate GPT partition tables, and using +.Nm +as a backend to do the actual manipulation. +.Pp +The most basic format is that used with the +.Fl i +or +.Fl b +options to the +.Cm show +command. +This provides output about a single partition. +The output is a series of lines, each beginning with a +keyword, followed by a colon +.Pq Sq \&: +and a space. +The data associated with the keyword is the whole remainder of +the line, up to (not including) the terminating newline +.Pq Sq \en +character. +The following lines may be output, fields for which no data +exists are omitted. +Additional fields beyond those listed here may also be included. +It is generally safe to ignore an unknown keyword, and its data. +.Bl -tag -width 5m -offset indent -compact +.It Index +The (1 based) index number of the partition description in the GPT table. +This can be 0 only when this format is used with the +.Nm +.Cm show +.Fl a +.Fl p +command. +.It Start +An unsigned decimal integer giving the sector number of the +first data block of the partition. +.It Size +An unsigned decimal integer giving the number of sectors in the partition. +This must be greater than zero. +.It GUID +The partition's unique identifier in standard GUID format (hexadecimal +digits used). +.It TypeID +Gives the UUID which defines the intended use of the partition. +.It Type +Gives the short alias for the +.Ic TypeID +used by +.Nm , +if one exists. +.It Long_Type +Gives a longer, more descriptive, name, if known, for the +.Ic TypeID . +.It Attributes +Lists any attributes set for the partition. +Attributes known by +.Nm +are shown first, as names, separated by a comma and space. +Any unknown attributes set are displayed last, enclosed in brackets +.Po +.Sq \&[ +and +.Sq \&] +.Pc +as a hexadecimal string, +each enclosed character representing 4 attribute bits, +where each bit set represents one of the +possible 64 attributes which is applied to the partition. +Leading +.Sq 0 +characters are omitted. +Note that the higher order 16 bits (the leftmost) have meanings +which depend upon the +.Ic TypeID . +The other 48 bits are common to all partition types. +.It Label +Gives the value of the GPT +.Dq name +field of the partition. +This is up to 36 characters, which may include any character +except NUL +.Pq Sq \e0 . +Each character may be any Unicode character representable by +a 16 bit code point (except 0). +Spaces, newlines, etc., may form part of the label. +To allow this label to always appear, and be understood, on +one output line, the label is first converted to UTF-8 encoding, +and then further encoded as if by +.Xr vis 1 +using the options VIS_CSTYLE\||\|VIS_OCTAL\||\|VIS_TAB\||\|VIS_NL. +.It Purpose +This field is used only when the +.Ic Index +is zero, +and hence only with output using the +.Fl a +option, +and indicates the reason that the disk blocks +indicated by +.Ic Start +and +.Ic Size +are listed. +If this is +.Dq Unused +then this set of blocks are not currently assigned, +and so are available to be made into one or more +partitions as required. +Other values are used to indicate various data necessary +for the GPT table itself, +or represent other, +non-GPT data, +from the +.Ar device . +.El +.Pp +When the +.Nm +.Cm show +.Fl a +.Fl p +command is used, the format is identical to that just described, +except that multiple data blocks are produced, each followed by +a blank line (including the last). +As well as the GPT partition blocks, with +.Ic Index +greater than zero, which the previous format produces, +this can also produce +.Ic "Index: 0" +entries. +These indicate blocks on the +.Ar device +which are not (currently) used by any assigned partition, +and are are either available for allocation, +or overhead used by the GPT system, +or are something unrelated to GPT partitioning +.Pq probably best viewed by some other tool . +.Pp +When +.Nm +.Cm show +.Fl p +is used without any of the +.Fl a , +.Fl b +or +.Fl i +options, a summary of the entire GPT table is produced, with much +the same data (and number of entries) as when +.Fl a +is used, but in a condensed, one line per block, format. +Each output line starts with 3 numeric fields, each followed +by a single space. +Those are the values from the +.Ic Start , +.Ic Size +and +.Ic Index +fields as described above, and as with +.Fl a +output, zero can occur as the index. +Those fields are followed by the string +.Dq GPT\ part\ \(en\ \& +for all partitions where the +.Ic Index +is not zero. +The contents of the remainder of the line depend upon +which, if any, of the +.Fl g , +.Fl l +or +.Fl u +options are given. +With none of those options, the value from the +.Ic Long_Type +field is appended. +If the +.Fl l +option is used, the +.Ic Label +field is appended, otherwise if the +.Fl g +option is used, the +.Ic GUID +field is appended, otherwise the +.Fl u +option must have been used, and the +.Ic TypeID +field is appended. +.Pp +Lines with +.Ic Index +zero are similar, except after the 0 for the index, and its +following space, the +.Ic +Purpose +field is appended. +Additional data might follow that, depending upon the particular purpose. +GPT header fields will include the +.Ic GUID +if +.Fl g +was used. +A +.Dq PMBR +field will indicate +.Dq Pq active +if the active bit is set. +MBR partition entries will show the MBR partition type, +plus +.Dq Pq active +if appropriate. +.Pp +When +.Fl p +is not used, the +.Nm +.Cm show +command produces similar output to that described above, +in a less rigorous format, +more suitable for human consumption, +and more likely alter from time to time. +In this case the +.Ic Label +when output (as a sequence of UTF-8 characters) is not further encoded, +so may have effects upon the terminal, +and might occupy multiple lines. +.Sh EXIT STATUS +The +.Nm +command exits with a failure status (1) when the header command +is used and no GPT header is found. +This can be used to check for the existence of a GPT in shell scripts. +Otherwise the exit status is 0 when no error has occurred, +and non-zero if an error prevented the command from executing correctly. +.Sh EXAMPLES +.Bd -literal +nas# gpt show wd3 + start size index contents + 0 1 PMBR + 1 3907029167 +nas# gpt create wd3 +nas# gpt show wd3 + start size index contents + 0 1 PMBR + 1 1 Pri GPT header + 2 32 Pri GPT table + 34 3907029101 + 3907029135 32 Sec GPT table + 3907029167 1 Sec GPT header +nas# gpt add -s 10486224 -t swap -i 1 wd3 +nas# gpt label -i 1 -l swap_1 wd3 +partition 1 on rwd3d labeled swap_1 +nas# gpt show wd3 + start size index contents + 0 1 PMBR + 1 1 Pri GPT header + 2 32 Pri GPT table + 34 10486224 1 GPT part - NetBSD swap + 10486258 3896542877 + 3907029135 32 Sec GPT table + 3907029167 1 Sec GPT header +nas# gpt show -l wd3 + start size index contents + 0 1 PMBR + 1 1 Pri GPT header + 2 32 Pri GPT table + 34 10486224 1 GPT part - "swap_1" + 10486258 3896542877 + 3907029135 32 Sec GPT table + 3907029167 1 Sec GPT header +nas# +.Ed +.Pp +Booting from GPT on a BIOS system: this creates a bootable partition. +.Bd -literal +xotica# gpt create wd1 +xotica# gpt add -b 1024 -l bootroot -t ffs -s 1g wd1 +/dev/rwd1: Partition 1 added: 49f48d5a-b10e-11dc-b99b-0019d1879648 1024 2097152 +xotica ~# dmesg | tail -2 +wd1: GPT GUID: 660e0630-0a3f-47c0-bc52-c88bcec79392 +dk0 at wd1: "bootroot", 2097152 blocks at 1024, type: ffs +xotica# gpt biosboot -L bootroot wd1 +xotica# newfs dk0 +xotica# installboot /dev/rdk0 /usr/mdec/bootxx_ffsv1 +xotica# mount /dev/dk0 /mnt +xotica# cp /usr/mdec/boot /mnt +.Ed +.Pp +Note that +.Ic biosboot +is not needed for UEFI systems. +.Bd -literal +example# gpt label -a -l '' device +.Ed +.Pp +will clear all the GPT labels on the device. +.Bd -literal +example# gpt label -L '' -l Unlabeled device +.Ed +.Pp +will label all unlabeled partitions as +.Dq Unlabeled . +.Pp +For experimenting, +ordinary files can be used as devices: +.Bd -literal +fantasy$ gpt -m128T -s8k create -p 8064 ./BIGGEST +fantasy$ gpt -s8k show -A ./BIGGEST + start size index contents + 0 8.0K PMBR + 8.0K 8.0K Pri GPT header + 16K 1.0M Pri GPT table + 1.0M 128T Unused + 128T 1.0M Sec GPT table + 128T 8.0K Sec GPT header +fantasy$ ls -l BIGGEST +-rw-r--r-- 1 user staff 140737488355328 Feb 8 18:31 BIGGEST +fantasy$ du -h BIGGEST +2.1M BIGGEST +.Ed +.Pp +The kernel limits the absolute apparent size of a file, +depending upon file system characteristics, +though the actual space used by +.Nm , +is not all that significant. +This allows experimenting with Christmas wishes. +.Po +A filesystem this big, can currently, in 2026, actually +be created by building a Raid Level 5 from 6 or more of +the biggest drives available, or a Raid Level 0 (or ccd) +from 5 or more of them. +So, if you are nice, rather than naughty, your wish may be +granted. +.Pc +.Pp +Some examples of different output formats from +.Nm +.Cm show +follow: +.Bd -literal +oldstyle$ gpt show -l sd0 + start size index contents + 0 1 PMBR + 1 1 Pri GPT header + 2 32 Pri GPT table + 34 2014 Unused + 2048 817152 1 GPT part - EFI + 819200 3325952 2 GPT part - Root + 4145152 49152 3 GPT part - Exchange + 4194304 2141192192 4 GPT part - Raid_C0 + 2145386496 2095104 5 GPT part - Example +Multiline +Label + 2147481600 2016 Unused + 2147483616 32 Sec GPT table + 2147483648 1 Sec GPT header + +newstyle$ gpt show -l -h sd0 + start size index contents + 0 512B PMBR + 512B 512B Pri GPT header + 1K 16K Pri GPT table + 17K 1007K Unused + 1M 399M 1 GPT part - EFI + 400M 1G 600M 2 GPT part - Root + 1G 1000M 24M 3 GPT part - Exchange + 2G 1021G 4 GPT part - Raid_C0 + 1023G 1023M 5 GPT part - Example +Multiline +Label + 1023G 1023M 1008K Unused +1023G 1023M 1008K 16K Sec GPT table + 1T 512B Sec GPT header + +friendly$ gpt show -l -A sd0 + start size index contents + 0 512B PMBR + 512B 512B Pri GPT header + 1.0K 16K Pri GPT table + 17K 1.0M Unused + 1.0M 399M 1 GPT part - EFI + 400M 1.6G 2 GPT part - Root + 2.0G 24M 3 GPT part - Exchange + 2.0G 1.0T 4 GPT part - Raid_C0 + 1.0T 1.0G 5 GPT part - Example +Multiline +Label + 1.0T 1.0M Unused + 1.0T 16K Sec GPT table + 1.0T 512B Sec GPT header + +parsable$ gpt show -l -p sd0 +0 1 0 PMBR +1 1 0 Pri GPT header +2 32 0 Pri GPT table +34 2014 0 Unused +2048 817152 1 GPT part - EFI +819200 3325952 2 GPT part - Root +4145152 49152 3 GPT part - Exchange +4194304 2141192192 4 GPT part - Raid_C0 +2145386496 2095104 5 GPT part - Example\enMultiline\enLabel +2147481600 2016 0 Unused +2147483616 32 0 Sec GPT table +2147483648 1 0 Sec GPT header + +oldstyle$ gpt show -i5 sd0 +Details for index 5: +Start: 2145386496 (1T) +Size: 2095104 (1G) +Type: ffs (49f48d5a-b10e-11dc-b99b-0019d1879648) +GUID: 63033daa-cc31-4b14-84c9-484669f3d199 +Label: Example +Multiline +Label +Attributes: None + +parsable$ gpt show -p -i 5 sd0 +Index: 5 +Start: 2145386496 +Size: 2095104 +GUID: 63033daa-cc31-4b14-84c9-484669f3d199 +TypeID: 49f48d5a-b10e-11dc-b99b-0019d1879648 +Type: ffs +Long_Type: NetBSD FFSv1/FFSv2 +Label: Example\enMultiline\enLabel +.Ed +.Sh SEE ALSO +.Xr vis 1 , +.Xr humanize_number 3 , +.Xr boot 8 , +.Xr dkctl 8 , +.Xr fdisk 8 , +.Xr installboot 8 , +.Xr mount 8 , +.Xr newfs 8 , +.Xr swapctl 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 5.0 +for ia64. +.Nm +utility first appeared in +.Nx 5.0 . +.Sh BUGS +The development of the +.Nm +utility is still work in progress. +Many necessary features are missing or partially implemented. +In practice this means that the manual page, supposed to describe these +features, is farther removed from being complete or useful. +As such, missing functionality is not even documented as missing. +However, it is believed that the currently present functionality is reliable +and stable enough that this tool can be used without bullet-proof footware if +one thinks one does not make mistakes. +.Pp +It is expected that the basic usage model will not change, but it is +possible that future versions will not be compatible in the strictest sense +of the word. +Also, options primarily intended for diagnostic or debug purposes may be +removed in future versions. +.Pp +Another possibility is that the current usage model is accompanied by +other interfaces to make the tool usable as a back-end. +This all depends on demand and thus feedback. +.Pp +The biggest bug is that the BUGS section doesn't actually +mention any actual bugs. diff --git a/static/netbsd/man8/grfconfig.8 b/static/netbsd/man8/grfconfig.8 new file mode 100644 index 00000000..23e28019 --- /dev/null +++ b/static/netbsd/man8/grfconfig.8 @@ -0,0 +1,207 @@ +.\" $NetBSD: grfconfig.8,v 1.17 2017/07/03 21:35:30 wiz Exp $ +.\" +.\" Copyright (c) 1997 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Ezra Story and Bernd Ernesti. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd October 7, 1994 +.Dt GRFCONFIG 8 amiga +.Os +.Sh NAME +.Nm grfconfig +.Nd alter grf device screen mode definitions at run time +.Sh SYNOPSIS +.Nm +.Op Fl r +.Ar device +.Op Ar file +.Sh DESCRIPTION +.Nm +is used to change or view the screen mode definition list contained +in a grf device. You may alter the console screen definition as well +as the definitions for the graphic screen. The console will automatically +reinitialize itself to the new screen mode. +.Pp +The following flags and arguments are interpreted by +.Nm : +.Bl -tag -width indent +.It Fl r +Print out a raw listing of the mode definitions instead of the +pretty list normally shown. +.It Ar device +The grf device to manipulate. This argument is required. +.It Ar file +The file which contains the mode definitions. If this argument +is not specified, +.Nm +will print out of a list of the modes currently loaded into +the grf device. +.El +.Sh MODE DEFINITION FILE +The mode definitions are taken from a file which has lines of the format: +.Pp +num clk wid hi dep hbs hss hse ht vbs vss vse vt flags +.Pp +.Bl -tag -width indent +.It Ar num +The mode number or 'c' for the console mode. +.It Ar clk +The pixel clock in Hz. +.It Ar wid +The screen mode's width. +.It Ar hi +The screen mode's height. +.It Ar dep +The bitdepth of the mode. Use 4 for a text console mode. +.It Ar hbs hss hse ht +The horizontal timing parameters for the mode in pixel values. All the +values are relative to the end of the horizontal blank (beginning of the +displayed area). +.It Ar vbs vss vse vt +The vertical timing parameters for the mode in line values. All the +values are relative to the end of vertical blank (beginning of the displayed +area). +.It Ar flags +By default every mode uses negative horizontal and vertical sync pulses, +it is non-interlaced and does not use scandoubling. +.Pp +.Bl -tag -width sync-on-green -offset indent +.It default +Use the default flags: -hsync -vsync +.It doublescan +Doublescan mode +.It interlace +Interlace mode +.It +hsync +Positive horizontal sync pulses +.It -hsync +Negative horizontal sync pulses +.It +vsync +Positive vertical sync pulses +.It -vsync +Negative vertical sync pulses +.It sync-on-green +Composite sync on green +.El +.El +.Pp +.Bd -literal + ------------------------------------------------------ + | ^ | + | vse | + | (0,0) | + | *----------------------------------- | + | | ^ ^ | | + | | vbe ! | | + | | ! | | + | | ! | | + |<-hse |<-hbe ! |<-hbs | | | + | | ! | hss->| hse->| hbe->| + | | hi | | | | + | | ! | | + | | ! | | + | |<============ wid =========+=====>| | + | | ! | | + | | ! | | + | | ! | | + | | v | | + | ------------------------------------ | + | ^ | + | vbs | + | | + ------------------------------------------------------ + ^ + vss + - ------- - + ^ + vse + - ------- - + ^ + vbe +.Ed +.Sh SEE ALSO +.Xr console 4 , +.Xr grfcl 4 , +.Xr grfcv 4 , +.Xr grfcv3d 4 , +.Xr grfet 4 , +.Xr grfrh 4 , +.Xr grfrt 4 , +.Xr grful 4 , +.Xr iteconfig 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 1.0 . +.Pp +The mode definition file changed two times. +.Pp +In +.Nx 1.0 +all horizontal values were videoclock cycle values instead of pixel values: +.Pp + num clk wid hi dep hbs hss hse hbe ht vbs vss vse vbe vt +.br + 1 31000000 640 480 8 80 86 96 102 104 480 489 492 517 520 + 2 31000000 640 480 8 80 86 96 102 104 240 244 246 258 260 + 3 31000000 640 480 8 80 86 96 102 104 960 978 984 1034 1040 +.Pp +In +.Nx 1.1 +and +.Nx 1.2 : +.Pp + num clk wid hi dep hbs hss hse hbe ht vbs vss vse vbe vt +.br + 1 31000000 640 480 8 640 688 768 816 832 480 489 492 517 520 + 2 31000000 640 480 8 640 688 768 816 832 240 244 246 258 260 + 3 31000000 640 480 8 640 688 768 816 832 960 978 984 1034 1040 +.Pp +the vertical values were used to select the interlace or doublescan mode. +All vertical values were half the width for the interlace mode and twice +the width for the doublescan mode. +.Pp +Beginning with +.Nx 1.3 : +.Pp + num clk wid hi dep hbs hss hse ht vbs vss vse vt flags +.br + 1 31000000 640 480 8 640 688 768 832 480 489 492 520 default + 2 31000000 640 480 8 640 688 768 832 480 489 492 520 interlace + 3 31000000 640 480 8 640 688 768 832 480 489 492 520 doublescan + 4 31000000 640 480 8 640 688 768 832 480 489 492 520 +hsync +vsync +.Pp +hbe and vbe are computed in the grf drivers. +.Sh BUGS +.Nm +can not set the modes for +.Pa /dev/grf1 , +.Pa /dev/grf2 +and +.Pa /dev/grf4 +and it will not work for +.Pa /dev/grf0 . diff --git a/static/netbsd/man8/group.8 b/static/netbsd/man8/group.8 new file mode 100644 index 00000000..c49c1de7 --- /dev/null +++ b/static/netbsd/man8/group.8 @@ -0,0 +1,89 @@ +.\" $NetBSD: group.8,v 1.17 2005/11/25 08:00:18 agc Exp $ */ +.\" +.\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" +.Dd November 7, 2005 +.Dt GROUP 8 +.Os +.Sh NAME +.Nm group +.Nd manage group information on the system +.Sh SYNOPSIS +.Nm +.Cm add +.Op options +.Ar group +.Nm +.Cm del +.Op options +.Ar group +.Nm +.Cm info +.Op options +.Ar group +.Nm +.Cm mod +.Op options +.Ar group +.Sh DESCRIPTION +The +.Nm +utility acts as a frontend to the +.Xr groupadd 8 , +.Xr groupmod 8 , +.Xr groupinfo 8 , +and +.Xr groupdel 8 +commands. +The utilities by default are built with +.Dv EXTENSIONS . +This allows for further functionality. +.Pp +For a full explanation of the options available, please see the relevant manual page. +.Sh EXIT STATUS +.Ex -std group +.Sh SEE ALSO +.Xr group 5 , +.Xr groupadd 8 , +.Xr groupdel 8 , +.Xr groupinfo 8 , +.Xr groupmod 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 1.5 . +It is based on the +.Ar addnerd +package by the same author. +.Sh AUTHORS +The +.Nm +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/static/netbsd/man8/groupadd.8 b/static/netbsd/man8/groupadd.8 new file mode 100644 index 00000000..24eb0e15 --- /dev/null +++ b/static/netbsd/man8/groupadd.8 @@ -0,0 +1,87 @@ +.\" $NetBSD: groupadd.8,v 1.17 2006/05/29 01:38:33 hubertf Exp $ */ +.\" +.\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" +.Dd November 7, 2005 +.Dt GROUPADD 8 +.Os +.Sh NAME +.Nm groupadd +.Nd add a group to the system +.Sh SYNOPSIS +.Nm +.Op Fl ov +.Op Fl g Ar gid +.Op Fl r Ar lowgid Ns Li .. Ns Ar highgid +.Ar group +.Sh DESCRIPTION +The +.Nm +utility adds a group to the system. +See +.Xr group 8 +for more information about +.Dv EXTENSIONS . +The options are as follows: +.Bl -tag -width Ds +.It Fl g Ar gid +Give the numeric group identifier to be used for the new group. +.It Fl o +Allow the new group to have a gid which is already in use for +another group. +.It Fl r Ar lowgid Ns Li .. Ns Ar highgid +Set the low and high bounds of a gid range for new groups. +A new group can only be created if there are gids which can be +assigned inside the range. +This option is included if built with +.Dv EXTENSIONS . +.It Fl v +Enable verbose mode - explain the commands as they are executed. +This option is included if built with +.Dv EXTENSIONS . +.El +.Sh EXIT STATUS +.Ex -std groupadd +.Sh SEE ALSO +.Xr group 5 , +.Xr group 8 , +.Xr user 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 1.5 . +It is based on the +.Ar addnerd +package by the same author. +.Sh AUTHORS +The +.Nm +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/static/netbsd/man8/groupdel.8 b/static/netbsd/man8/groupdel.8 new file mode 100644 index 00000000..dd5bb194 --- /dev/null +++ b/static/netbsd/man8/groupdel.8 @@ -0,0 +1,74 @@ +.\" $NetBSD: groupdel.8,v 1.14 2006/05/29 01:38:33 hubertf Exp $ */ +.\" +.\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" +.Dd November 7, 2005 +.Dt GROUPDEL 8 +.Os +.Sh NAME +.Nm groupdel +.Nd remove a group from the system +.Sh SYNOPSIS +.Nm +.Op Fl v +.Ar group +.Sh DESCRIPTION +The +.Nm +utility removes a group from the system. +See +.Xr group 8 +for more information about +.Dv EXTENSIONS . +The options are as follows: +.Bl -tag -width Ds +.It Fl v +Enable verbose mode - explain the commands as they are executed. +This option is included if built with +.Dv EXTENSIONS . +.El +.Sh EXIT STATUS +.Ex -std groupdel +.Sh SEE ALSO +.Xr group 5 , +.Xr group 8 , +.Xr user 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 1.5 . +It is based on the +.Ar addnerd +package by the same author. +.Sh AUTHORS +The +.Nm +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/static/netbsd/man8/groupinfo.8 b/static/netbsd/man8/groupinfo.8 new file mode 100644 index 00000000..041ff5a7 --- /dev/null +++ b/static/netbsd/man8/groupinfo.8 @@ -0,0 +1,90 @@ +.\" $NetBSD: groupinfo.8,v 1.13 2014/09/19 16:02:59 wiz Exp $ */ +.\" +.\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" +.Dd November 7, 2005 +.Dt GROUPINFO 8 +.Os +.Sh NAME +.Nm groupinfo +.Nd displays group information +.Sh SYNOPSIS +.Nm +.Op Fl ev +.Ar group +.Sh DESCRIPTION +The +.Nm +utility retrieves the group information from the system. +The +.Nm +utility is only available if built with +.Dv EXTENSIONS . +See +.Xr group 8 +for more information. +.Pp +The following command line options are recognised: +.Bl -tag -width Ds +.It Fl e +Return 0 if the group exists, and non-zero if the +group does not exist, on the system. +No information is displayed. +This form of the command is useful for +scripts which need to check whether a particular group +name or gid is already in use on the system. +.It Fl v +Perform any actions in a verbose manner. +.El +.Pp +The +.Ar group +argument may either be a group's name, or a gid. +.Sh FILES +.Bl -tag -width /etc/usermgmt.conf -compact +.It Pa /etc/usermgmt.conf +.El +.Sh EXIT STATUS +.Ex -std groupinfo +.Sh SEE ALSO +.Xr passwd 5 , +.Xr group 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 1.5 . +It is based on the +.Ar addnerd +package by the same author. +.Sh AUTHORS +The +.Nm +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/static/netbsd/man8/groupmod.8 b/static/netbsd/man8/groupmod.8 new file mode 100644 index 00000000..339c354b --- /dev/null +++ b/static/netbsd/man8/groupmod.8 @@ -0,0 +1,83 @@ +.\" $NetBSD: groupmod.8,v 1.14 2005/11/25 08:00:18 agc Exp $ */ +.\" +.\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" +.Dd November 7, 2005 +.Dt GROUPMOD 8 +.Os +.Sh NAME +.Nm groupmod +.Nd modify an existing group on the system +.Sh SYNOPSIS +.Nm +.Op Fl ov +.Op Fl g Ar gid +.Op Fl n Ar newname +.Ar group +.Sh DESCRIPTION +The +.Nm +utility modifies an existing group on the system. +See +.Xr group 8 +for more information about +.Dv EXTENSIONS . +The options are as follows: +.Bl -tag -width Ds +.It Fl g Ar gid +Give the numeric group identifier to be used for the new group. +.It Fl n Ar new-group-name +Give the new name which the group shall have. +.It Fl o +Allow the new group to have a gid which is already in use for +another group. +.It Fl v +Enable verbose mode - explain the commands as they are executed. +This option is included if built with +.Dv EXTENSIONS . +.El +.Sh EXIT STATUS +.Ex -std groupmod +.Sh SEE ALSO +.Xr group 5 , +.Xr group 8 , +.Xr user 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 1.5 . +It is based on the +.Ar addnerd +package by the same author. +.Sh AUTHORS +The +.Nm +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/static/netbsd/man8/gspa.8 b/static/netbsd/man8/gspa.8 new file mode 100644 index 00000000..f1987bf3 --- /dev/null +++ b/static/netbsd/man8/gspa.8 @@ -0,0 +1,87 @@ +.\" $NetBSD: gspa.8,v 1.4 2008/04/30 13:11:02 martin Exp $ +.\" +.\" Copyright (c) 2002 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd May 27, 2002 +.Dt GSPA 8 +.Os +.Sh NAME +.Nm gspa +.Nd assembler for the GSP chip +.Sh SYNOPSIS +.Nm +.Op Fl c Ar c_array_name +.Op Fl l Ar list_file +.Op Fl o Ar hex_file +.Op infile +.Sh DESCRIPTION +.Nm +is an assembler for the TMS34010 and TMS34020 graphics processor +chips. +.Pp +The supported options are: +.Bl -tag -width xxxlistname -compact +.It Fl c Ar c_array_name +Create a pre-initialized C-structure +.Ar c_array_name +with the hex code of the assembler output. +.It Fl l Ar list_file +Create commented (with the input file) hex code of the assembler +output in +.Ar list_file . +.It Fl o Ar hex_file +Create the output in +.Ar hex_file . +If +.Fl c +is used, C code will be written to +.Ar hex_file , +otherwise uncommented hex code of the assembler output will be +written. +.El +.Pp +If no +.Fl o +option is given, output will be written to stdout. +.Pp +If no +.Ar infile +is given, input will be read from stdin. +.Sh HISTORY +.Nm +appeared in +.Nx 1.1 . +.Sh AUTHORS +.Nm +was written by +.An Paul Mackerras . +The +.Fl c +mode was added by +.An Ignatios Souvatzis +.Aq is@NetBSD.org . +This man page was written by +.An Thomas Klausner +.Aq wiz@NetBSD.org . diff --git a/static/netbsd/man8/hdaudioctl.8 b/static/netbsd/man8/hdaudioctl.8 new file mode 100644 index 00000000..90cc7f21 --- /dev/null +++ b/static/netbsd/man8/hdaudioctl.8 @@ -0,0 +1,103 @@ +.\" $NetBSD: hdaudioctl.8,v 1.8 2021/04/12 12:22:10 nia Exp $ +.\" +.\" Copyright (c) 2009 Precedence Technologies Ltd +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Precedence Technologies Ltd +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd April 12, 2021 +.Dt HDAUDIOCTL 8 +.Os +.Sh NAME +.Nm hdaudioctl +.Nd program to manipulate +.Xr hdaudio 4 +devices +.Sh SYNOPSIS +.Nm +.Op Ar -f device +.Ar command +.Op Ar arguments +.Sh DESCRIPTION +The +.Nm +command can be used to inspect and reconfigure High Definition Audio devices +and their child codecs. +.Pp +The mandatory +.Ar command +argument specifies the action to take. +Valid commands are: +.Bl -tag -width XgetXcodecidXnidX +.It list +For each child codec of the chosen +.Xr hdaudio 4 +device, display the nid, vendor, product, subsystem and device IDs. +.It show Ar codecid Ar nid +Retrieve and display the current codec configuration in human-readable form. +.It get Ar codecid Ar nid +Retrieve and display the current codec configuration as a +.Xr proplib 3 +XML plist. +.It set Ar codecid Ar nid Op Ar plist +Detach the specified +.Xr hdafg 4 +codec and then re-attach with its widgets explicitly configured according to +the specified plist. +If no plist is given, the in-built widget parsing rules based on the High +Definition Audio specification will be used. +.It graph Ar codecid Ar nid +Output a DOT file suitable processing by graphviz. +The resulting image will graphically show the structure and interconnections +of the widgets that form the chosen +.Xr hdafg 4 +codec. +.El +.Sh FILES +.Bl -tag -width /dev/hdaudioX -compact +.It Pa /dev/hdaudioX +control devices +.El +.Sh SEE ALSO +.Xr audio 4 , +.Xr hdaudio 4 , +.Pa pkgsrc/graphics/graphviz +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 5.1 . +.Sh AUTHORS +.Nm +is based on two separate programs written by +.An Jared McNeill Aq Mt jmcneill@NetBSD.org +under contract by +.Lk http://www.precedence.co.uk/ Precedence Technologies Ltd . +Integration into one program and writing this manual page was done by +.An Stephen Borrill Aq Mt sborrill@NetBSD.org . +.Sh CAVEATS +When a plist is loaded and the +.Xr hdafg 4 +codec reattaches, all mixer controls will be returned to their default values. diff --git a/static/netbsd/man8/hlfsd.8 b/static/netbsd/man8/hlfsd.8 new file mode 100644 index 00000000..fd261c00 --- /dev/null +++ b/static/netbsd/man8/hlfsd.8 @@ -0,0 +1,322 @@ +.\" $NetBSD: hlfsd.8,v 1.4 2015/01/17 17:46:31 christos Exp $ +.\" +.\" +.\" Copyright (c) 1997-2014 Erez Zadok +.\" Copyright (c) 1989 Jan-Simon Pendry +.\" Copyright (c) 1989 Imperial College of Science, Technology & Medicine +.\" Copyright (c) 1989 The Regents of the University of California. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to Berkeley by +.\" Jan-Simon Pendry at Imperial College, London. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" +.\" File: am-utils/hlfsd/hlfsd.8 +.\" +.\" HLFSD was written at Columbia University Computer Science Department, by +.\" Erez Zadok and Alexander Dupuy +.\" It is distributed under the same terms and conditions as AMD. +.\" +.TH HLFSD 8 "14 September 1993" +.SH NAME +hlfsd \- home-link file system daemon +.SH SYNOPSIS +.B hlfsd +[ +.B \-fhnpvC +] [ +.BI \-a " alt_dir" +] [ +.BI \-c " cache-interval" +] [ +.BI \-g " group" +] [ +.BI \-i " reload-interval" +] [ +.BI \-l " logfile" +] [ +.BI \-o " mount-options" +] [ +.BI \-x " log-options" +] [ +.BI \-D " debug-options" +] [ +.BI \-P " password-file" +] +[ +.I linkname +.RI [ " subdir " ] +] +.SH DESCRIPTION +.B Hlfsd +is a daemon which implements a filesystem containing a symbolic link to +subdirectory within a user's home directory, depending on the user +which accessed that link. It was primarily designed to redirect +incoming mail to users' home directories, so that it can read from +anywhere. +.LP +.B Hlfsd +operates by mounting itself as an +.SM NFS +server for the directory containing +.IR linkname , +which defaults to +.BR /hlfs/home . +Lookups within that directory are handled by +.BR hlfsd , +which uses the password map to determine how to resolve the lookup. +The directory will be created if it doesn't already exist. The symbolic link will be to the accessing user's home directory, with +.I subdir +appended to it. If not specified, +.I subdir +defaults to +.BR .hlfsdir . +This directory will also be created if it does not already exist. +.LP +A SIGTERM sent to +.B hlfsd +will cause it to shutdown. A SIGHUP will flush the internal +caches, and reload the password map. It will also close and +reopen the log file, to enable the original log file to be +removed or rotated. A SIGUSR1 will cause it to dump its internal +table of user IDs and home directories to the file +.BR /usr/tmp/hlfsd.dump.XXXXXX . +.SH OPTIONS +.TP +.BI \-a " alt_dir" +Alternate directory. The name of the directory to which +the symbolic link returned by +.B hlfsd +will point, if it cannot access the home directory of the user. This +defaults to +.BR /var/hlfs . +This directory will be created if it doesn't exist. It is expected +that either users will read these files, or the system administrators +will run a script to resend this "lost mail" to its owner. +.TP +.BI \-c " cache-interval" +Caching interval. +.B Hlfsd +will cache the validity of home directories for this interval, in +seconds. Entries which have been verified within the last +.I cache-interval +seconds will not be verified again, since the operation could +be expensive, and the entries are most likely still valid. +After the interval has expired, +.B hlfsd +will re-verify the validity of the user's home directory, and +reset the cache time-counter. The default value for +.I cache-interval +is 300 seconds (5 minutes). +.TP +.B \-f +Force fast startup. This option tells +.B hlfsd +to skip startup-time consistency checks such as existence of mount +directory, alternate spool directory, symlink to be hidden under the +mount directory, their permissions and validity. +.TP +.BI \-g " group" +Set the special group HLFS_GID to +.IR group . +Programs such as +.B from +or +.BR comsat , +which access the mailboxes of other users) must be setgid HLFS_GID to +work properly. The default group is "hlfs". If no group is provided, +and there is no group "hlfs", this feature is disabled. +.TP +.B \-h +Help. Print a brief help message, and exit. +.TP +.BI \-i " reload-interval" +Map-reloading interval. Each +.I reload-interval +seconds, +.B hlfsd +will reload the password map. +.B Hlfsd +needs the password map for the UIDs and home directory pathnames. +.B Hlfsd +schedules a SIGALRM to reload the password maps. A SIGHUP sent to +.B hlfsd +will force it to reload the maps immediately. The default +value for +.I reload-interval +is 900 seconds (15 minutes.) +.TP +.BI \-l " logfile" +Specify a log file to which +.B hlfsd +will record events. If +.I logfile +is the string +.B syslog +then the log messages will be sent to the system log daemon by +.IR syslog (3), +using the LOG_DAEMON facility. +This is also the default. +.TP +.B \-n +No verify. +.B Hlfsd +will not verify the validity of the symbolic link it will be +returning, or that the user's home directory contains +sufficient disk-space for spooling. This can speed up +.B hlfsd +at the cost of possibly returning symbolic links to home +directories which are not currently accessible or are full. +By default, +.B hlfsd +validates the symbolic-link in the background. +The +.B \-n +option overrides the meaning of the +.B \-c +option, since no caching is necessary. +.TP +.BI \-o " mount-options" +Mount options. Mount options which +.B hlfsd +will use to mount itself on top of +.I dirname. +By default, +.IR mount-options +is set to "ro". If the system supports symbolic-link caching, default +options are set to "ro,nocache". +.TP +.B \-p +Print PID. +Outputs the process-id of +.B hlfsd +to standard output where it can be saved into a file. +.TP +.B \-v +Version. Displays version information to standard error. +.TP +.BI \-x " log-options" +Specify run-time logging options. The options are a comma separated +list chosen from: fatal, error, user, warn, info, map, stats, all. +.TP +.BI \-C +Force +.B hlfsd +to run on systems that cannot turn off the NFS attribute-cache. Use of +this option on those systems is discouraged, as it may result in loss +or mis-delivery of mail. The option is ignored on systems that can turn +off the attribute-cache. +.TP +.BI \-D " log-options" +Select from a variety of debugging options. Prefixing an +option with the string +.B no +reverses the effect of that option. Options are cumulative. +The most useful option is +.BR all . +Since this option is only used for debugging other options are not +documented here. A fuller description is available in the program +source. A SIGUSR1 sent to +.B hlfsd +will cause it to dump its internal password map to the file +.BR /usr/tmp/hlfsd.dump.XXXXXX . +.TP +.BI \-P " password-file" +Read the user-name, user-id, and home directory information from the file +.I password-file. +Normally, +.B hlfsd +will use +.IR getpwent (3) +to read the password database. This option allows you to override the +default database, and is useful if you want to map users' mail files to a +directory other than their home directory. Only the username, uid, and +home-directory fields of the file +.I password-file +are read and checked. All other fields are ignored. The file +.I password-file +must otherwise be compliant with Unix System 7 colon-delimited format +.IR passwd (5). +.SH FILES +.TP 5 +.B /hlfs +directory under which +.B hlfsd +mounts itself and manages the symbolic link +.BR home . +.TP 5 +.B .hlfsdir +default sub-directory in the user's home directory, to which the +.B home +symbolic link returned by +.B hlfsd +points. +.TP 5 +.B /var/hlfs +directory to which +.B home +symbolic link returned by +.B hlfsd +points if it is unable to verify the that +user's home directory is accessible. +.SH "SEE ALSO" +.BR mail(1), +.BR getgrent (3), +.BR getpwent (3), +.BR passwd (5), +.\" .BR mnttab (4), +.\" .BR mtab (5), +.BR amd (8), +.\" .BR automount (8), +.BR cron(8), +.BR mount (8), +.BR sendmail (8), +.BR umount (8). +.LP +.IR "HLFSD: Delivering Email to Your $HOME" , +in +.IR "Proc. LISA-VII, The 7th Usenix System Administration Conference" , +November 1993. +.LP +``am-utils'' +.BR info (1) +entry. +.LP +.I "Linux NFS and Automounter Administration" +by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001). +.LP +.I http://www.am-utils.org +.SH AUTHORS +Erez Zadok , Computer Science Department, Stony Brook +University, Stony Brook, New York, USA. +and +Alexander Dupuy , System Management ARTS, +White Plains, New York, USA. +.P +Other authors and contributors to am-utils are listed in the +.B AUTHORS +file distributed with am-utils. diff --git a/static/netbsd/man8/hostapd.8 b/static/netbsd/man8/hostapd.8 new file mode 100644 index 00000000..d19d862c --- /dev/null +++ b/static/netbsd/man8/hostapd.8 @@ -0,0 +1,59 @@ +.TH HOSTAPD 8 "April 7, 2005" hostapd hostapd +.SH NAME +hostapd \- IEEE 802.11 AP, IEEE 802.1X/WPA/WPA2/EAP/RADIUS Authenticator +.SH SYNOPSIS +.B hostapd +[\-hdBKtv] [\-P ] +.SH DESCRIPTION +This manual page documents briefly the +.B hostapd +daemon. +.PP +.B hostapd +is a user space daemon for access point and authentication servers. +It implements IEEE 802.11 access point management, IEEE 802.1X/WPA/WPA2/EAP Authenticators and RADIUS authentication server. +The current version supports Linux (Host AP, mac80211-based drivers) and FreeBSD (net80211). + +.B hostapd +is designed to be a "daemon" program that runs in the background and acts as the backend component controlling authentication. +.B hostapd +supports separate frontend programs and an example text-based frontend, +.BR hostapd_cli , +is included with +.BR hostapd . +.SH OPTIONS +A summary of options is included below. +For a complete description, run +.BR hostapd +from the command line. +.TP +.B \-h +Show usage. +.TP +.B \-d +Show more debug messages. +.TP +.B \-dd +Show even more debug messages. +.TP +.B \-B +Run daemon in the background. +.TP +.B \-P +Path to PID file. +.TP +.B \-K +Include key data in debug messages. +.TP +.B \-t +Include timestamps in some debug messages. +.TP +.B \-v +Show hostapd version. +.SH SEE ALSO +.BR hostapd_cli (1). +.SH AUTHOR +hostapd was written by Jouni Malinen . +.PP +This manual page was written by Faidon Liambotis , +for the Debian project (but may be used by others). diff --git a/static/netbsd/man8/hostapd_cli.8 b/static/netbsd/man8/hostapd_cli.8 new file mode 100644 index 00000000..d8068b09 --- /dev/null +++ b/static/netbsd/man8/hostapd_cli.8 @@ -0,0 +1,114 @@ +.\" $NetBSD: hostapd_cli.8,v 1.3 2014/03/18 18:20:36 riastradh Exp $ +.\" +.\" Copyright (c) 2005 Sam Leffler +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD: src/usr.sbin/wpa/hostapd_cli/hostapd_cli.8,v 1.2 2005/06/27 06:40:43 ru Exp $ +.\" +.Dd June 16, 2005 +.Dt HOSTAPD_CLI 8 +.Os +.Sh NAME +.Nm hostapd_cli +.Nd text-based frontend program for interacting with +.Xr hostapd 8 +.Sh SYNOPSIS +.Nm +.Op Ar commands +.Sh DESCRIPTION +The +.Nm +utility +is a text-based frontend program for interacting with +.Xr hostapd 8 . +It is used to query the current status. +.Pp +The +.Nm +utility +can show the +current authentication status, +dot11 and dot1x MIBs, etc. +.Pp +The +.Nm +utility +supports two modes: interactive and command line. +Both modes share the same command set. +.Pp +Interactive mode is started when +.Nm +is executed without any parameters on the command line. +Commands are then entered from the controlling terminal in +response to the +.Nm +prompt. +In command line mode, the same commands are +entered as command line arguments. +.Sh COMMANDS +The following commands may be supplied on the command line +or at a prompt when operating interactively. +.Bl -tag -width indent +.It Ic mib +Report MIB variables (dot1x, dot11) for the current interface. +.It Ic sta Ar addr +Report the MIB variables for the associated station with MAC address +.Ar addr . +.It Ic all_sta +Report the MIB variables for all associated stations. +.It Ic help +Show usage help. +.It Ic interface Op Ar ifname +Show available interfaces and/or set the current interface +when multiple are available. +.It Ic level Ar debug_level +Change the debugging level in +.Xr hostapd 8 . +Larger numbers generate more messages. +.It Ic license +Display the full +license for +.Nm . +.It Ic quit +Exit +.Nm . +.El +.Sh SEE ALSO +.Xr hostapd.conf 5 , +.Xr hostapd 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 4.0 . +.Sh AUTHORS +The +.Nm +utility was written by +.An Jouni Malinen Aq Mt jkmaline@cc.hut.fi . +This manual page is derived from the +.Pa README +file included in the +.Nm hostapd +distribution. diff --git a/static/netbsd/man8/hpcboot.8 4.html b/static/netbsd/man8/hpcboot.8 4.html new file mode 100644 index 00000000..f03ac869 --- /dev/null +++ b/static/netbsd/man8/hpcboot.8 4.html @@ -0,0 +1,133 @@ +
+ + + + + +
HPCBOOT(8)System Manager's ManualHPCBOOT(8)
+
+
+

+

hpcboot — load and + boot kernel from Windows CE

+
+
+

+ + + + + +
hpcboot.exe
+
+
+

+

hpcboot is a program that runs on + Windows CE. It loads and executes the specified + NetBSD kernel. hpcboot + supports hpcarm, hpcmips, and hpcsh ports.

+

Click on the “Boot” button to start the boot process + with selected options. Click on the “Cancel” button to exit + hpcboot.

+
+

+

On this tab you can select the kernel to boot and options to pass + to the kernel.

+
+
Directory
+
In this combobox you specify the “current” directory. The + kernel and miniroot image pathnames are taken to be relative to this + directory. +

hpcboot can load kernel and miniroot + from FAT and UFS filesystems, and via HTTP.

+
+
Kernel
+
In this text field you specify the name of the kernel to load. Kernels + compressed with gzip(1) are supported.
+
Model
+
Select your H/PC model in this combobox.
+
Root File System
+
This group of controls lets you specify the desired root file system type. + You can select wd(4), sd(4), + md(4), and NFS root. +

If you select md(4) memory disk root file + system, you should specify the path name of the file system image in the + text field below. Miniroot images compressed with + gzip(1) are supported.

+
+
Kernel Boot Flags
+
This group of controls is used to pass boot flags to the kernel.
+
+
+
+

+

On this tab you can specify miscellaneous options that mostly + control the hpcboot program itself.

+
+
Auto Boot
+
If this option is selected hpcboot will + automatically boot NetBSD after the specified + timeout.
+
Reverse Video
+
Tells kernel if it should use the framebuffer in reverse video mode.
+
Pause Before Boot
+
If selected, a warning dialog will be presented + anything + is done, right after the “Boot” button is pressed.
+
Load Debug Info
+
This option currently does nothing.
+
Safety Message
+
If selected, a warning dialog will be presented + the kernel + has been loaded and prepared to be started. This will be your last chance + to cancel the boot.
+
Extra Kernel Options
+
In this text field you can specify additional options to pass to the + kernel.
+
+
+
+

+

This tab gets its name from the big text area that + hpcboot uses as the “console” to + report its progress.

+
+
Save To File
+
If checked, the progress log will be sent to the specified file + instead.
+
“Checkboxes Anonymous”
+
The row of 8 checkboxes controls debugging options for + hpcboot itself. They control the bits of an + internal variable, the leftmost checkbox being the 7th bit.
+
“Buttons Anonymous”
+
The buttons “a” to “d” control 4 + “hooks” a developer might want to use during + hpcboot development.
+
+
+
+
+

+

kloader(4), boot(8)

+
+
+

+

The hpcboot utility first appeared in + NetBSD 1.6.

+
+
+

+

hpcboot reads the entire kernel image at + once, and requires enough free area on the main memory.

+
+
+ + + + + +
April 3, 2004NetBSD 10.1
diff --git a/static/netbsd/man8/hprop.8 b/static/netbsd/man8/hprop.8 new file mode 100644 index 00000000..e751691c --- /dev/null +++ b/static/netbsd/man8/hprop.8 @@ -0,0 +1,133 @@ +.\" $NetBSD: hprop.8,v 1.7 2023/06/19 21:41:41 christos Exp $ +.\" +.\" Copyright (c) 2000 - 2004 Kungliga Tekniska Högskolan +.\" (Royal Institute of Technology, Stockholm, Sweden). +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" 3. Neither the name of the Institute nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" Id +.\" +.Dd December 8, 2004 +.Dt HPROP 8 +.Os +.Sh NAME +.Nm hprop +.Nd propagate the KDC database +.Sh SYNOPSIS +.Nm +.Bk -words +.Oo Fl m Ar file \*(Ba Xo +.Fl Fl master-key= Ns Pa file +.Xc +.Oc +.Oo Fl d Ar file \*(Ba Xo +.Fl Fl database= Ns Pa file +.Xc +.Oc +.Op Fl Fl source= Ns Ar heimdal|mit-dump +.Oo Fl r Ar string \*(Ba Xo +.Fl Fl v4-realm= Ns Ar string +.Xc +.Oc +.Oo Fl c Ar cell \*(Ba Xo +.Fl Fl cell= Ns Ar cell +.Xc +.Oc +.Oo Fl k Ar keytab \*(Ba Xo +.Fl Fl keytab= Ns Ar keytab +.Xc +.Oc +.Oo Fl R Ar string \*(Ba Xo +.Fl Fl v5-realm= Ns Ar string +.Xc +.Oc +.Op Fl D | Fl Fl decrypt +.Op Fl E | Fl Fl encrypt +.Op Fl n | Fl Fl stdout +.Op Fl v | Fl Fl verbose +.Op Fl Fl version +.Op Fl h | Fl Fl help +.Op Ar host Ns Op : Ns Ar port +.Ar ... +.Ek +.Sh DESCRIPTION +.Nm +takes a principal database in a specified format and converts it into +a stream of Heimdal database records. This stream can either be +written to standard out, or (more commonly) be propagated to a +.Xr hpropd 8 +server running on a different machine. +.Pp +If propagating, it connects to all +.Ar hosts +specified on the command by opening a TCP connection to port 754 +(service hprop) and sends the database in encrypted form. +.Pp +Supported options: +.Bl -tag -width Ds +.It Fl m Ar file , Fl Fl master-key= Ns Pa file +Where to find the master key to encrypt or decrypt keys with. +.It Fl d Ar file , Fl Fl database= Ns Pa file +The database to be propagated. +.It Fl Fl source= Ns Ar heimdal|mit-dump|krb4-dump|kaserver +Specifies the type of the source database. Alternatives include: +.Pp +.Bl -tag -width mit-dump -compact -offset indent +.It heimdal +a Heimdal database +.It mit-dump +a MIT Kerberos 5 dump file +.El ++.It Fl k Ar keytab , Fl Fl keytab= Ns Ar keytab +The keytab to use for fetching the key to be used for authenticating +to the propagation daemon(s). The key +.Pa hprop/hostname +is used from this keytab. The default is to fetch the key from the +KDC database. +.It Fl R Ar string , Fl Fl v5-realm= Ns Ar string +Local realm override. +.It Fl D , Fl Fl decrypt +The encryption keys in the database can either be in clear, or +encrypted with a master key. This option transmits the database with +unencrypted keys. +.It Fl E , Fl Fl encrypt +This option transmits the database with encrypted keys. This is the +default if no option is supplied. +.It Fl n , Fl Fl stdout +Dump the database on stdout, in a format that can be fed to hpropd. +.El +.Sh EXAMPLES +The following will propagate a database to another machine (which +should run +.Xr hpropd 8 ) : +.Bd -literal -offset indent +$ hprop slave-1 slave-2 +.Ed +.Sh SEE ALSO +.Xr hpropd 8 diff --git a/static/netbsd/man8/hpropd.8 b/static/netbsd/man8/hpropd.8 new file mode 100644 index 00000000..3d5d59d1 --- /dev/null +++ b/static/netbsd/man8/hpropd.8 @@ -0,0 +1,92 @@ +.\" $NetBSD: hpropd.8,v 1.5 2023/06/19 21:41:41 christos Exp $ +.\" +.\" Copyright (c) 1997, 2000 - 2003 Kungliga Tekniska Högskolan +.\" (Royal Institute of Technology, Stockholm, Sweden). +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" 3. Neither the name of the Institute nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" Id +.\" +.Dd August 27, 1997 +.Dt HPROPD 8 +.Os +.Sh NAME +.Nm hpropd +.Nd receive a propagated database +.Sh SYNOPSIS +.Nm +.Bk -words +.Oo Fl d Ar file \*(Ba Xo +.Fl Fl database= Ns Ar file +.Xc +.Oc +.Op Fl n | Fl Fl stdin +.Op Fl Fl print +.Op Fl i | Fl Fl no-inetd +.Oo Fl k Ar keytab \*(Ba Xo +.Fl Fl keytab= Ns Ar keytab +.Xc +.Oc +.Op Fl 4 | Fl Fl v4dump +.Ek +.Sh DESCRIPTION +.Nm +receives a database sent by +.Nm hprop . +and writes it as a local database. +.Pp +By default, +.Nm +expects to be started from +.Nm inetd +if stdin is a socket and expects to receive the dumped database over +stdin otherwise. +If the database is sent over the network, it is authenticated and +encrypted. +Only connections authenticated with the principal +.Nm kadmin Ns / Ns Nm hprop +are accepted. +.Pp +Options supported: +.Bl -tag -width Ds +.It Fl d Ar file , Fl Fl database= Ns Ar file +database +.It Fl n , Fl Fl stdin +read from stdin +.It Fl Fl print +print dump to stdout +.It Fl i , Fl Fl no-inetd +not started from inetd +.It Fl k Ar keytab , Fl Fl keytab= Ns Ar keytab +keytab to use for authentication +.It Fl 4 , Fl Fl v4dump +create v4 type DB +.El +.Sh SEE ALSO +.Xr hprop 8 diff --git a/static/netbsd/man8/i2cscan.8 b/static/netbsd/man8/i2cscan.8 new file mode 100644 index 00000000..6f1ce3b2 --- /dev/null +++ b/static/netbsd/man8/i2cscan.8 @@ -0,0 +1,79 @@ +.\" $NetBSD: i2cscan.8,v 1.7 2019/11/30 02:47:14 riastradh Exp $ +.\" +.\" Copyright (c) 2011, 2013 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Thomas Klausner. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd November 26, 2015 +.Dt I2CSCAN 8 +.Os +.Sh NAME +.Nm i2cscan +.Nd scan an IIC bus for devices +.Sh SYNOPSIS +.Nm +.Op Fl r +.Ar i2cdev +.Sh DESCRIPTION +The +.Nm +utility scans the Inter-Integrated Circuit bus +.Pq Xr iic 4 +specified by +.Ar i2cdev +to determine which addresses respond. +.Pp +.Ar i2cdev +can be specified with or without the +.Pa /dev +prefix. +For example, +.Pa /dev/iic0 +or +.Pa iic0 . +.Pp +Available options: +.Bl -tag -width Ds +.It Fl r +scan using 1 byte reads instead of quick writes. +.El +.Pp +.Sy WARNING : +Using this utility can access some devices in such a +manner as to leave them in an unstable or unusable state. +It can also lock up the entire +.Xr iic 4 +bus. +Don't use this utility unless you know what you're doing and can +accept all sorts of unforeseen consequences. +.Sh EXIT STATUS +.Ex -std i2cscan +.Sh EXAMPLES +Scan the first IIC bus found on the system for devices: +.Pp +.Dl "i2cscan /dev/iic0" +.Sh SEE ALSO +.Xr iic 4 diff --git a/static/netbsd/man8/ian.8 b/static/netbsd/man8/ian.8 new file mode 100644 index 00000000..2b95633b --- /dev/null +++ b/static/netbsd/man8/ian.8 @@ -0,0 +1,89 @@ +.\" +.\" Copyright © 2007 Alistair Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd August 28, 2007 +.Dt IAN 8 +.Os +.Sh NAME +.Nm ian +.Nd refuse-based internet access node - ftp/http file system +.Sh SYNOPSIS +.Nm +.Op Fl v +.Op Fl d Ar cache-directory +.Ar mount_point +.Sh DESCRIPTION +The +.Nm +utility is a refuse-based virtual file system, and can be used to +access files on remote machines via the ftp and http protocols. +The +.Nm +utility makes use of the +.Xr virtdir 3 +virtual directory routines, and the +libfetch remote access routines from FreeBSD. +.Pp +The URL is provided as a path below the mountpoint, and is retrieved from +the remote location using the associated scheme. +The file is cached in +the local cache directory, which can be manipulated using the +.Ar d +command +line option. +The default location is /tmp. +.Pp +The +.Nm +utility makes use of the +.Xr virtdir 3 +virtual directory routines. +.Pp +The +.Xr refuse 3 +library is used to provide the file system features. +.Pp +The mandatory parameter is +the local mount +point. +.Pp +The +.Nm +utility was designed to be a +BSD-licensed, refuse-based implementation of +the functionality provided by the older +alex +utility. +.Sh SEE ALSO +.Xr librefuse 3 , +.Xr puffs 3 , +.Xr virtdir 3 . +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 5.0 . diff --git a/static/netbsd/man8/iasl.8 b/static/netbsd/man8/iasl.8 new file mode 100644 index 00000000..fc7ecb06 --- /dev/null +++ b/static/netbsd/man8/iasl.8 @@ -0,0 +1,206 @@ +.\" $NetBSD: iasl.8,v 1.4 2014/03/18 18:20:36 riastradh Exp $ +.\" +.\" Copyright (c) 2010 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Jukka Ruohonen. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd April 10, 2010 +.Os +.Dt IASL 8 +.Sh NAME +.Nm iasl +.Nd Intel ASL compiler and disassembler +.Tn Pq iASL +.Sh SYNOPSIS +.Nm +.Op Ar options +.Ao Ar input file Ac +.Sh DESCRIPTION +The +.Nm +is a fully-featured compiler for the +.Tn ACPI +Source Language +.Tn Pq ASL . +It translates +.Tn ASL +to +.Tn ACPI +Machine Language +.Tn Pq AML , +but +.Nm +can also act as a disassembler, translating +.Tn AML +to +.Tn ASL . +.Sh OPTIONS +.Ss Global +.Bl -tag -width "w 1 | 2 | 3 " -offset 4n -compact +.It Fl @ Ar file +Specify command file. +.It Fl I Ar dir +Specify additional include directory. +.El +.Ss General Output +.Bl -tag -width "w 1 | 2 | 3 " -offset 4n -compact +.It Fl p Ar prefix +Specify a path or filename +.Ar prefix +for all output files. +.It Fl va +Disable all errors and warnings in the summary. +.It Fl vi +Use less verbose errors and warnings. +.It Fl vo +Enable optimization comments. +.It Fl vr +Disable remarks. +.It Fl vs +Disable signon. +.It Fl w Ar 1 | 2 | 3 +Set warning reporting level. +.El +.Ss AML Output Files +.Bl -tag -width "w 1 | 2 | 3 " -offset 4n -compact +.It Fl s Ar a | c +Create +.Tn AML +in assembler +.Pq Pa *.asm +or C +.Pq Pa *.c +source file. +.It Fl i Ar a | c +Create assembler +.Pq Pa *.inc +or C +.Pq Pa *.h +include file. +.It Fl t Ar a | c +Create AML in assembler or C hex table +.Pq Pa *.hex . +.El +.Ss AML Code Generation +.Bl -tag -width "w 1 | 2 | 3 " -offset 4n -compact +.It Fl oa +Disable all optimizations (compatibility mode). +.It Fl of +Disable constant folding. +.It Fl oi +Disable integer optimization to operation codes. +.It Fl on +Disable named reference string optimization. +.It Fl r Ar revision +Override table header +.Ar revision +(1-255). +.El +.Ss Listings +.Bl -tag -width "w 1 | 2 | 3 " -offset 4n -compact +.It Fl l +Create mixed, +.Tn ASL +and +.Tn AML , +listing file +.Pq Pa *.lst . +.It Fl ln +Create namespace file +.Pq Pa *.nsp . +.It Fl ls +Create combined source file +.Pq Pa *.src . +.El +.Ss AML Disassembler +.Bl -tag -width "w 1 | 2 | 3 " -offset 4n -compact +.It Fl d Ar file +Disassemble binary +.Tn ACPI +table to a +.Ar file +.Pq Pa *.dsl . +.It Fl dc Ar file +Disassemble +.Tn AML +and immediately compile it. +.It Fl e Ar f1 , f2 +Include +.Tn ACPI +table(s) for external symbol resolution. +.It Fl 2 +Emit +.Tn ACPI 2.0 +compatible +.Tn ASL +code. +.It Fl g +Get +.Tn ACPI +tables and write to files +.Pq Pa *.dat . +.El +.Ss Help +.Bl -tag -width "w 1 | 2 | 3 " -offset 4n -compact +.It Fl h +Display additional help and compiler debug options. +.It Fl hc +Display operators allowed in constant expressions. +.It Fl hr +Display +.Tn ACPI +reserved method names. +.El +.Sh SEE ALSO +.Xr acpi 4 , +.Xr acpidump 8 , +.Xr amldb 8 +.Rs +.%A Intel Corporation +.%T iASL Compiler/Disassembler User Reference +.%N Revision 2.00 +.%D September 18, 2009 +.%U http://www.acpica.org/download/aslcompiler.pdf +.Re +.Sh HISTORY +The +.Nm +compiler/disassembler is part of the Intel +.Tn ACPI +Component Architecture +.Tn Pq ACPICA . +It first appeared in +.Nx 6.0 . +.Sh AUTHORS +.An -nosplit +Among Intel engineers, +.An Robert Moore Aq Mt robert.moore@intel.com +was the chief architect behind +.Nm . +This manual page was written for +.Nx +by +.An Jukka Ruohonen Aq Mt jruohonen@iki.fi . diff --git a/static/netbsd/man8/icfs.8 b/static/netbsd/man8/icfs.8 new file mode 100644 index 00000000..c57a23f1 --- /dev/null +++ b/static/netbsd/man8/icfs.8 @@ -0,0 +1,66 @@ +.\" +.\" Copyright © 2007 Alistair Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd April 15, 2007 +.Dt ICFS 8 +.Os +.Sh NAME +.Nm icfs +.Nd refuse-based virtual file system to display a case-insensitive interface to a file system +.Sh SYNOPSIS +.Nm +.Op Fl v +.Ar directory +.Ar mount_point +.Sh DESCRIPTION +The +.Nm +utility can be used to mount an existing directory on a new +mount point. +The +.Nm +utility makes use of the +.Xr virtdir 3 +virtual directory routines. +Underneath those virtual directories, the individual directory entries +will be displayed as an exact mirror of the original directory, +except that any capital letters in the original entry's name will +be substituted with an entry name consisting entirely of lower-case +letters. +.Pp +The +.Xr refuse 3 +library is used to provide the file system features. +.Sh SEE ALSO +.Xr librefuse 3 , +.Xr puffs 3 , +.Xr virtdir 3 . +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 5.0 . diff --git a/static/netbsd/man8/id3fs.8 b/static/netbsd/man8/id3fs.8 new file mode 100644 index 00000000..44579c82 --- /dev/null +++ b/static/netbsd/man8/id3fs.8 @@ -0,0 +1,76 @@ +.\" +.\" Copyright © 2007 Alistair Crooks. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd April 15, 2007 +.Dt ID3FS 8 +.Os +.Sh NAME +.Nm id3fs +.Nd refuse-based virtual file system to display mp3 tree by id3 tags +.Sh SYNOPSIS +.Nm +.Op Fl v +.Ar Fl p Ar music-directory +.Ar mount_point +.Sh DESCRIPTION +The +.Nm +utility can be used to mount a number of directory tree +under the +mount point, using id3 tags +to make the artists, genres and years appear as virtual directories. +The +.Nm +utility makes use of the +.Xr virtdir 3 +virtual directory routines. +Underneath those virtual directories, the individual trackes will be +displayed by category, allowing a different view of the id3-tagged +files from the standard one. +.Pp +The +.Xr refuse 3 +library is used to provide the file system features. +.Pp +The mandatory parameter is +the local mount +point. +.Pp +The id3 package, found in pkgsrc/audio/id3, is necessary +to run this package. +.Pp +Two shel lscripts are also included, which must be used to build up an id3 +database in advance. First id3info.sh must be run, followed by id3db.sh. +.Sh SEE ALSO +.Xr librefuse 3 , +.Xr puffs 3 , +.Xr virtdir 3 . +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 5.0 . diff --git a/static/netbsd/man8/identd.8 b/static/netbsd/man8/identd.8 new file mode 100644 index 00000000..49a2f207 --- /dev/null +++ b/static/netbsd/man8/identd.8 @@ -0,0 +1,245 @@ +.\" $NetBSD: identd.8,v 1.22 2016/12/12 10:07:48 wiz Exp $ +.\" +.\" This software is in the public domain. +.\" Written by Peter Postma +.\" +.Dd December 9, 2016 +.Dt IDENTD 8 +.Os +.Sh NAME +.Nm identd +.Nd TCP/IP Ident protocol server +.Sh SYNOPSIS +.Nm +.Op Fl 46beIilNnr +.Op Fl a Ar address +.Op Fl c Ar charset +.Op Fl F Ar format +.Op Fl f Ar username +.Op Fl g Ar uid +.Op Fl L Ar username +.Op Fl m Ar filter +.Op Fl o Ar osname +.Op Fl P Ar address +.Op Fl p Ar portno +.Op Fl t Ar seconds +.Op Fl u Ar uid +.Sh DESCRIPTION +.Nm +is a TCP/IP server which implements the user identification protocol +as specified in RFC 1413. +.Pp +.Nm +operates by looking up specific TCP/IP connections and returning +information which may or may not be associated with the process owning +the connection. +.Pp +The following options are available: +.Bl -tag -width XXusernameXX +.It Fl 4 +Bind to IPv4 addresses only +(valid with flag +.Fl b ) . +.It Fl 6 +Bind to IPv6 addresses only +(valid with flag +.Fl b ) . +.It Fl a Ar address +Bind to the specified +.Ar address . +This may be an IPv4 or IPv6 address or even a hostname. +If a hostname is specified then +.Nm +will resolve it to an address (or addresses) and will bind this address +(valid with flag +.Fl b ) . +.It Fl b +Run in the background (as daemon). +.It Fl c Ar charset +Specify an optional character set designator to be included in replies. +.Ar charset +should be a valid charset set as described in the +.Tn MIME RFC +in upper case characters. +.It Fl e +Return +.Dq UNKNOWN-ERROR +instead of the usual +.Dq NO-USER +or +.Dq INVALID-PORT +error replies. +.It Fl F Ar format +Specify the format to display info. +The allowed format specifiers are: +.Bd -literal +%u print user name +%U print user number +%g print (primary) group name +%G print (primary) group number +%l print list of all groups by name +%L print list of all groups by number +.Ed +.Pp +The lists of groups (%l, %L) are comma-separated, and start with the primary +group which is not repeated. +Any other characters (preceded by %, and those not preceded by it) +are printed literally. +.It Fl f Ar username +Specify a fall back +.Ar username . +If the lookup fails then this username will be returned. +This can be useful for when running this service on a NAT host and +not using the forward/proxy functionality. +.It Fl g Ar gid +Specify the group id number or name which the server should switch to after +binding itself to the TCP/IP port. +.It Fl I +Same as +.Fl i +but without the restriction that the username in +.Pa .ident +must not match an existing user. +.It Fl i +If the +.Pa .ident +file exists in the home directory of the identified user, return the username +found in that file instead of the real username. +If the username found in +.Pa .ident +is that of an existing user, then the real username will be returned. +.It Fl L Ar username +Specify a +.Dq lie +.Ar username . +.Nm +will return this name for all valid ident requests. +.It Fl l +Use +.Xr syslogd 8 +for logging purposes. +.It Fl m Ar filter +Enables forwarding of ident queries. +The +.Ar filter +argument specifies which packet filter should be used to lookup the +connections, currently +.Sq ipfilter , +.Sq npf , +and +.Sq pf +are supported packet filters. +Note that +.Nm +changes the ident queries to use the local port on the NAT host instead of +the local port on the forwarding host. +This is needed because otherwise we can't do a lookup on the proxy host. +On the proxy host, +.Dq proxy mode +should be enabled with the +.Fl P +flag or +.Dq lying mode +with the +.Fl L +flag. +.It Fl N +Enable +.Pa .noident +files. +If this file exists in the home directory of the identified user then return +.Dq HIDDEN-USER +instead of the normal USERID response. +.It Fl n +Return numeric user IDs instead of usernames. +.It Fl o Ar osname +Return +.Ar osname +instead of the default +.Dq UNIX . +.It Fl P Ar address +Specify a proxy server which will be used to receive proxied ident +queries from. +See also the +.Fl m +flag how this operates. +.It Fl p Ar portno +Specify an alternative port number under which the server should run. +The default is port 113 +(valid with flag +.Fl b ) . +.It Fl r +Return a random name of alphanumeric characters. +If the +.Fl n +flag is also enabled then a random number will be returned. +.It Fl t Ar seconds +Specify a timeout for the service. +The default timeout is 30 seconds. +.It Fl u Ar uid +Specify the user id number or name to which the server should switch after +binding itself to the TCP/IP port. +.El +.Sh FILES +.Pa /etc/inetd.conf +.Sh EXAMPLES +.Nm +operates from +.Xr inetd 8 +or as standalone daemon. +Put the following lines into +.Xr inetd.conf 5 +to enable +.Nm +as an IPv4 and IPv6 service via inetd: +.Pp +ident stream tcp nowait nobody /usr/libexec/identd identd -l +.Pp +ident stream tcp6 nowait nobody /usr/libexec/identd identd -l +.Pp +To run +.Nm +as standalone daemon, use the +.Fl b +flag. +.Sh SEE ALSO +.Xr inetd.conf 5 , +.Xr inetd 8 +.Sh AUTHORS +This implementation of +.Nm +is written by +.An Peter Postma +.Aq peter@NetBSD.org . +.Sh CAVEATS +Since +.Nm +should typically not be run as a privileged user or group, +.Pa .ident +files for use when running with the +.Fl I +or +.Fl i +flags will need to be world accessible. +The same applies for +.Pa .noident +files when running with the +.Fl N +flag. +.Pp +When forwarding is enabled with the +.Fl m +flag then +.Nm +will need access to either +.Pa /dev/ipnat +(ipfilter), +.Pa /dev/pf +(pf), or +.Pa /dev/npf . +Since it's not a good idea to run +.Nm +under root, you'll need to adjust group owner/permissions to the device(s) +and run +.Nm +under that group. diff --git a/static/netbsd/man8/ifconfig.8 b/static/netbsd/man8/ifconfig.8 new file mode 100644 index 00000000..fb23ec74 --- /dev/null +++ b/static/netbsd/man8/ifconfig.8 @@ -0,0 +1,948 @@ +.\" $NetBSD: ifconfig.8,v 1.131 2024/09/25 14:55:31 roy Exp $ +.\" +.\" Copyright (c) 1983, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)ifconfig.8 8.4 (Berkeley) 6/1/94 +.\" +.Dd September 25, 2024 +.Dt IFCONFIG 8 +.Os +.Sh NAME +.Nm ifconfig +.Nd configure network interface parameters +.Sh SYNOPSIS +.Nm +.Op Fl N +.Ar interface address_family +.Oo +.Ar address +.Op Ar dest_address +.Oc +.Op Ar parameters +.Nm +.Op Fl hLmNvz +.Ar interface +.Op Ar protocol_family +.Nm +.Fl a +.Op Fl bdhLNmsuvz +.Op Ar protocol_family +.Nm +.Fl l +.Op Fl bdsu +.Nm +.Fl s +.Ar interface +.Nm +.Fl w +.Ar secs +.Op Fl W Ar secs +.Nm +.Fl C +.Sh DESCRIPTION +.Nm +is used to assign an address +to a network interface and/or configure +network interface parameters. +.Nm +must be used at boot time to define the network address +of each interface present on a machine; it may also be used at +a later time to redefine an interface's address +or other operating parameters. +.Pp +Available operands for +.Nm : +.Bl -tag -width Ds +.It Ar address +For the +.Tn DARPA-Internet +family, +the address is either a host name present in the host name data +base, +.Xr hosts 5 , +or a +.Tn DARPA +Internet address expressed in the Internet standard +.Dq dot notation . +.It Ar address_family +Specifies the +.Ar address_family +which affects interpretation of the remaining parameters. +Since an interface can receive transmissions in differing protocols +with different naming schemes, specifying the address family is recommended. +The address or protocol families currently +supported are +.Dq inet , +.Dq inet6 , +.Dq atalk , +and +.Dq link . +.It Ar interface +The +.Ar interface +parameter is a string of the form +.Dq name unit , +for example, +.Dq en0 +.El +.Pp +The following parameters may be set with +.Nm : +.Bl -tag -width dest_addressxx +.It Cm active +This keyword applies when +.Nm +adds or modifies any link-layer address. +It indicates that +.Nm +should +.Dq activate +the address. +Activation makes an address the default source for transmissions +on the interface. +You may not delete the active address from an interface. +You must activate some other address, first. +.It Cm advbase Ar n +If the driver is a +.Xr carp 4 +pseudo-device, set the base advertisement interval to +.Ar n +seconds. +This ia an 8-bit number; the default value is 1 second. +.It Cm advskew Ar n +If the driver is a +.Xr carp 4 +pseudo-device, skew the advertisement interval by +.Ar n . +This is an 8-bit number; the default value is 0. +.Pp +Taken together the +.Cm advbase +indicate how frequently, in seconds, the host will advertise the fact that it +considers itself the master of the virtual host. +The formula is +.Cm advbase ++ +.Pf ( Cm advskew +/ 256). +If the master does not advertise within three times this interval, this host +will begin advertising as master. +.It Cm alias +Establish an additional network address for this interface. +This is sometimes useful when changing network numbers, and +one wishes to accept packets addressed to the old interface. +.It Fl alias +Remove the specified network address alias. +.It Cm arp +Enable the use of the Address Resolution Protocol in mapping +between network level addresses and link level addresses +.Pq default . +This is currently implemented for mapping between +.Tn DARPA +Internet +addresses and Ethernet addresses. +.It Fl arp +Disable the use of the Address Resolution Protocol. +.It Cm anycast +.Pq inet6 only +Set the IPv6 anycast address bit. +.It Fl anycast +.Pq inet6 only +Clear the IPv6 anycast address bit. +.It Cm broadcast Ar mask +.Pq Inet only +Specify the address to use to represent broadcasts to the +network. +The default broadcast address is the address with a host part of all 1's. +.It Cm carpdev Ar iface +If the driver is a +.Xr carp 4 +pseudo-device, attach it to +.Ar iface . +If not specified, the kernel will attempt to select an interface with +a subnet matching that of the carp interface. +.It Cm description Ar description , Cm descr Ar description +Set a description of the interface. (0-63 characters) +.It Cm -description , Cm -descr +Clear the description of the interface. +.It Cm debug +Enable driver dependent debugging code; usually, this turns on +extra console error logging. +.It Fl debug +Disable driver dependent debugging code. +.It Cm delete +Remove the network address specified. +This would be used if you incorrectly specified an alias, or it +was no longer needed. +If you have incorrectly set an NS address having the side effect +of specifying the host portion, removing all NS addresses will +allow you to respecify the host portion. +.Cm delete +does not work for IPv6 addresses. +Use +.Fl alias +with explicit IPv6 address instead. +.It Ar dest_address +Specify the address of the correspondent on the other end +of a point to point link. +.It Cm down +Mark an interface ``down''. +When an interface is +marked ``down'', the system will not attempt to +transmit messages through that interface. +If possible, the interface will be reset to disable reception as well. +This action does not automatically disable routes using the interface. +.It Cm media Ar type +Set the media type of the interface to +.Ar type . +Some interfaces support the mutually exclusive use of one of several +different physical media connectors. +For example, a 10Mb/s Ethernet +interface might support the use of either +.Tn AUI +or twisted pair connectors. +Setting the media type to +.Dq 10base5 +or +.Dq AUI +would change the currently active connector to the AUI port. +Setting it to +.Dq 10baseT +or +.Dq UTP +would activate twisted pair. +Refer to the interfaces' driver +specific man page for a complete list of the available types +and the +.Xr ifmedia 4 +manual page for a list of media types. +See the +.Fl m +flag below. +.It Cm mediaopt Ar opts +Set the specified media options on the interface. +.Ar opts +is a comma delimited list of options to apply to the interface. +Refer to the interfaces' driver specific man page for a complete +list of available options. +Also see the +.Xr ifmedia 4 +manual page for a list of media options. +.It Fl mediaopt Ar opts +Disable the specified media options on the interface. +.It Cm mode Ar mode +If the driver supports the media selection system, set the specified +operating mode on the interface to +.Ar mode . +For IEEE 802.11 wireless interfaces that support multiple operating modes +this directive is used to select between 802.11a +.Pq Dq 11a , +802.11b +.Pq Dq 11b , +and 802.11g +.Pq Dq 11g +operating modes. +.It Cm instance Ar minst +Set the media instance to +.Ar minst . +This is useful for devices which have multiple physical layer interfaces +.Pq PHYs . +Setting the instance on such devices may not be strictly required +by the network interface driver as the driver may take care of this +automatically; see the driver's manual page for more information. +.It Cm metric Ar n +Set the routing metric of the interface to +.Ar n , +default 0. +The routing metric is used by the routing protocol +.Pq Xr routed 8 . +Higher metrics have the effect of making a route +less favorable; metrics are counted as addition hops +to the destination network or host. +.It Cm mtu Ar n +Set the maximum transmission unit of the interface to +.Ar n . +Most interfaces do not support this option. +.It Cm netmask Ar mask +.Pq inet and inet6 +Specify how much of the address to reserve for subdividing +networks into sub-networks. +The mask includes the network part of the local address +and the subnet part, which is taken from the host field of the address. +The mask can be specified as a single hexadecimal number +with a leading 0x, with a dot-notation Internet address, +or with a pseudo-network name listed in the network table +.Xr networks 5 . +The mask contains 1's for the bit positions in the 32-bit address +which are to be used for the network and subnet parts, +and 0's for the host part. +The mask should contain at least the standard network portion, +and the subnet field should be contiguous with the network +portion. +.Pp +For INET and INET6 addresses, the netmask can also be given with +slash-notation after the address +.Pq e.g 192.168.17.3/24 . +.\" see +.\" Xr eon 5 . +.It Cm state Ar state +Explicitly force the +.Xr carp 4 +pseudo-device to enter this state. +Valid states are +.Ar INIT , +.Ar BACKUP , +and +.Ar MASTER . +.It Cm frag Ar threshold +.Pq IEEE 802.11 devices only +Configure the fragmentation threshold for IEEE 802.11-based wireless +network interfaces. +.It Cm rts Ar threshold +.Pq IEEE 802.11 devices only +Configure the RTS/CTS threshold for IEEE 802.11-based wireless +network interfaces. +This controls the number of bytes used for the RTS/CTS handshake boundary. +The +.Ar threshold +can be any value between 0 and 2347. +The default is 2347, which indicates the RTS/CTS mechanism should not be used. +.It Cm ssid Ar id +.Pq IEEE 802.11 devices only +Configure the Service Set Identifier (aka the network name) +for IEEE 802.11-based wireless network interfaces. +The +.Ar id +can either be any text string up to 32 characters in length, +or a series of up to 64 hexadecimal digits preceded by +.Dq 0x . +Setting +.Ar id +to the empty string allows the interface to connect to any available +access point. +.It Cm nwid Ar id +Synonym for +.Dq ssid . +.It Cm hidessid +.Pq IEEE 802.11 devices only +When operating as an access point, do not broadcast the SSID +in beacon frames or respond to probe request frames unless +they are directed to the ap (i.e., they include the ap's SSID). +By default, the SSID is included in beacon frames and +undirected probe request frames are answered. +.It Fl hidessid +.Pq IEEE 802.11 devices only +When operating as an access point, broadcast the SSID +in beacon frames and answer and respond to undirected probe +request frames (default). +.It Cm nwkey Ar key +.Pq IEEE 802.11 devices only +Enable WEP encryption for IEEE 802.11-based wireless network interfaces +with the +.Ar key . +The +.Ar key +can either be a string, a series of hexadecimal digits preceded by +.Dq 0x , +or a set of keys in the form +.Ar n:k1,k2,k3,k4 , +where +.Ar n +specifies which of keys will be used for all transmitted packets, +and four keys, +.Ar k1 +through +.Ar k4 , +are configured as WEP keys. +Note that the order must be match within same network if multiple keys +are used. +For IEEE 802.11 wireless network, the length of each key is restricted to +40 bits, i.e., 5-character string or 10 hexadecimal digits, +while the WaveLAN/IEEE Gold cards accept the 104 bits +.Pq 13 characters +key. +.It Cm nwkey Cm persist +.Pq IEEE 802.11 devices only +Enable WEP encryption for IEEE 802.11-based wireless network interfaces +with the persistent key written in the network card. +.It Cm nwkey Cm persist : Ns Ar key +.Pq IEEE 802.11 devices only +Write the +.Ar key +to the persistent memory of the network card, and +enable WEP encryption for IEEE 802.11-based wireless network interfaces +with the +.Ar key . +.It Fl nwkey +.Pq IEEE 802.11 devices only +Disable WEP encryption for IEEE 802.11-based wireless network interfaces. +.It Cm apbridge +.Pq IEEE 802.11 devices only +When operating as an access point, pass packets between +wireless clients directly (default). +.It Fl apbridge +.Pq IEEE 802.11 devices only +When operating as an access point, pass packets through +the system so that they can be forwarded using some other mechanism. +Disabling the internal bridging is useful when traffic +is to be processed with packet filtering. +.It Cm pass Ar passphrase +If the driver is a +.Xr carp 4 +pseudo-device, set the authentication key to +.Ar passphrase . +There is no passphrase by default +.It Cm powersave +.Pq IEEE 802.11 devices only +Enable 802.11 power saving mode. +.It Fl powersave +.Pq IEEE 802.11 devices only +Disable 802.11 power saving mode. +.It Cm powersavesleep Ar duration +.Pq IEEE 802.11 devices only +Set the receiver sleep duration in milliseconds for 802.11 power saving mode. +.It Cm bssid Ar bssid +.Pq IEEE 802.11 devices only +Set the desired BSSID for IEEE 802.11-based wireless network interfaces. +.It Fl bssid +.Pq IEEE 802.11 devices only +Unset the desired BSSID for IEEE 802.11-based wireless network interfaces. +The interface will automatically select a BSSID in this mode, which is +the default. +.It Cm chan Ar chan +.Pq IEEE 802.11 devices only +Select the channel +.Pq radio frequency +to be used for IEEE 802.11-based wireless network interfaces. +.It Fl chan +.Pq IEEE 802.11 devices only +Unset the desired channel to be used +for IEEE 802.11-based wireless network interfaces. +It does not affect the channel to be created for IBSS or hostap mode. +.It Cm list scan +.Pq IEEE 802.11 devices only +Display the access points and/or ad-hoc neighbors +located in the vicinity. +The +.Fl v +flag may be used to display long SSIDs. +.Fl v +also causes received information elements to be displayed symbolically. +The interface must be up before any scanning operation. +Only the super-user can use this command. +.It Cm tunnel Ar src_addr Ns Oo Ar ,src_port Oc Ar dest_addr Ns Oo Ar ,dest_port Oc +.Pq IP tunnel devices only +Configure the physical source and destination address for IP tunnel +interfaces, including +.Xr gif 4 . +The arguments +.Ar src_addr +and +.Ar dest_addr +are interpreted as the outer source/destination for the encapsulating +IPv4/IPv6 header. +.Pp +On a +.Xr gre 4 +interface in UDP mode, the arguments +.Ar src_port +and +.Ar dest_port +are interpreted as the outer source/destination port for the encapsulating +UDP header. +.It Cm deletetunnel +Unconfigure the physical source and destination address for IP tunnel +interfaces previously configured with +.Cm tunnel . +.It Cm session Ar local_session Ar remote_session +.Pq L2TPv3 devices only +Configure local session id and remote session id for L2TPv3 +interface. +The length of session id is 4 bytes. +.It Cm deletesession +Unconfigure the local session id and remote session id for +L2TPv3 interface previously configured with +.Cm session . +.It Cm cookie Ar local_cookie_length Ar local_cookie Ar remote_cookie_length Ar remote_cookie +.Pq L2TPv3 devices only +Configure local cookie and remote cookie for L2TPv3 interface. +The cookie length must be 4 or 8 bytes. +Generally, cookies are managed by daemon. +So, this command would be used for test or debug only. +.It Cm deletecookie +Unconfigure the local cookie and remote cookie for L2TPv3 +interface previously configured with +.Cm cookie . +.It Cm create +Create the specified network pseudo-device. +.It Cm destroy +Destroy the specified network pseudo-device. +.It Cm pltime Ar n +.Pq inet6 only +Set preferred lifetime for the address. +.It Cm prefixlen Ar n +.Pq inet and inet6 only +Effect is similar to +.Cm netmask . +but you can specify by prefix length by digits. +.It Cm deprecated +.Pq inet6 only +Set the IPv6 deprecated address bit. +.It Fl deprecated +.Pq inet6 only +Clear the IPv6 deprecated address bit. +.It Cm eui64 +.Pq inet6 only +Fill interface index +.Pq lowermost 64bit of an IPv6 address +automatically. +.It Cm link[0-2] +Enable special processing of the link level of the interface. +These three options are interface specific in actual effect, however, +they are in general used to select special modes of operation. +An example +of this is to enable SLIP compression, or to select the connector type +for some Ethernet cards. +Refer to the man page for the specific driver +for more information. +.It Fl link[0-2] +Disable special processing at the link level with the specified interface. +.It Cm linkstr Ar str +Set a link-level string parameter for the interface. +This functionality varies from interface to interface. +Refer to the man page for the specific driver +for more information. +.It Fl linkstr +Remove an interface link-level string parameter. +.It Cm up +Mark an interface ``up''. +This may be used to enable an interface after an ``ifconfig down.'' +It happens automatically when setting the first address on an interface. +If the interface was reset when previously marked down, +the hardware will be re-initialized. +.It Cm vhid Ar n +If the driver is a +.Xr carp 4 +pseudo-device, set the virtual host ID to +.Ar n . +Acceptable values are 1 to 255. +.It Cm vlan Ar vid +If the interface is a +.Xr vlan 4 +pseudo-interface, set the VLAN identifier to +.Ar vid . +These are the first 12 bits (0-4095) from a 16-bit integer used +to create an 802.1Q VLAN header for packets sent from the +.Xr vlan 4 +interface. +Note that +.Cm vlan +and +.Cm vlanif +must be set at the same time. +.It Cm vlanif Ar iface +If the interface is a +.Xr vlan 4 +pseudo-interface, associate the physical interface +.Ar iface +with it. +Packets transmitted through the +.Xr vlan 4 +interface will be diverted to the specified physical interface +.Ar iface +with 802.1Q VLAN encapsulation. +Packets with 802.1Q encapsulation received +by the physical interface with the correct VLAN tag will be diverted to the +associated +.Xr vlan 4 +pseudo-interface. +The VLAN interface is assigned a copy of the physical +interface's flags and +.Tn Ethernet +address. +If the +.Xr vlan 4 +interface already has a physical interface associated with it, this command +will fail. +To change the association to another physical interface, the +existing association must be cleared first. +Note that +.Cm vlanif +and +.Cm vlan +must be set at the same time. +.It Cm -vlanif Ar iface +Dissociate +.Ar iface +from the +.Xr vlan 4 +interface. +.It Cm agrport Ar iface +Add +.Ar iface +to the +.Xr agr 4 +interface. +.It Cm -agrport Ar iface +Remove +.Ar iface +from the +.Xr agr 4 +interface. +.It Cm laggport Ar interface Oo Cm pri Ar n Oc +Add the interface named by +.Ar interface +as a port of the +.Xr lagg 4 +interface, +and set the priority of +.Ar interface +to +.Ar n . +.It Cm -laggport Ar interface +Remove the interface named by +.Ar interface +from the +.Xr lagg 4 +interface. +.It Cm laggportpri Ar interface Ar n +If the interface is a +.Xr lagg 4 +pseudo-interface, set the priority of +.Ar interface +to +.Ar n +.It Cm laggproto Ar proto +Set the aggregation protocol of +.Xr lagg 4 . +The default is +.Li none . +The available options are +.Li failover , +.Li lacp , +.Li loadbalance , +and +.Li none . +.It Cm eee +Enable IEEE 802.3az Energy Efficiency Ethernet function. +.It Cm -eee +Disable IEEE 802.3az Energy Efficiency Ethernet function. +.It Cm vltime Ar n +.Pq inet6 only +Set valid lifetime for the address. +.It Cm ip4csum +Shorthand of +.Dq ip4csum-tx ip4csum-rx +.It Cm -ip4csum +Shorthand of +.Dq -ip4csum-tx -ip4csum-rx +.It Cm tcp4csum +Shorthand of +.Dq tcp4csum-tx tcp4csum-rx +.It Cm -tcp4csum +Shorthand of +.Dq -tcp4csum-tx -tcp4csum-rx +.It Cm udp4csum +Shorthand of +.Dq udp4csum-tx udp4csum-rx +.It Cm -udp4csum +Shorthand of +.Dq -udp4csum-tx -udp4csum-rx +.It Cm tcp6csum +Shorthand of +.Dq tcp6csum-tx tcp6csum-rx +.It Cm -tcp6csum +Shorthand of +.Dq -tcp6csum-tx -tcp6csum-rx +.It Cm udp6csum +Shorthand of +.Dq udp6csum-tx udp6csum-rx +.It Cm -udp6csum +Shorthand of +.Dq -udp6csum-tx -udp6csum-rx +.It Cm ip4csum-tx +Enable hardware-assisted IPv4 header checksums for the out-bound direction. +.It Cm -ip4csum-tx +Disable hardware-assisted IPv4 header checksums for the out-bound direction. +.It Cm ip4csum-rx +Enable hardware-assisted IPv4 header checksums for the in-bound direction. +.It Cm -ip4csum-rx +Disable hardware-assisted IPv4 header checksums for the in-bound direction. +.It Cm tcp4csum-tx +Enable hardware-assisted TCP/IPv4 checksums for the out-bound direction. +.It Cm -tcp4csum-tx +Disable hardware-assisted TCP/IPv4 checksums for the out-bound direction. +.It Cm tcp4csum-rx +Enable hardware-assisted TCP/IPv4 checksums for the in-bound direction. +.It Cm -tcp4csum-rx +Disable hardware-assisted TCP/IPv4 checksums for the in-bound direction. +.It Cm udp4csum-tx +Enable hardware-assisted UDP/IPv4 checksums for the out-bound direction. +.It Cm -udp4csum-tx +Disable hardware-assisted UDP/IPv4 checksums for the out-bound direction. +.It Cm udp4csum-rx +Enable hardware-assisted UDP/IPv4 checksums for the in-bound direction. +.It Cm -udp4csum-rx +Disable hardware-assisted UDP/IPv4 checksums for the in-bound direction. +.It Cm tcp6csum-tx +Enable hardware-assisted TCP/IPv6 checksums for the out-bound direction. +.It Cm -tcp6csum-tx +Disable hardware-assisted TCP/IPv6 checksums for the out-bound direction. +.It Cm tcp6csum-rx +Enable hardware-assisted TCP/IPv6 checksums for the in-bound direction. +.It Cm -tcp6csum-rx +Disable hardware-assisted TCP/IPv6 checksums for the in-bound direction. +.It Cm udp6csum-tx +Enable hardware-assisted UDP/IPv6 checksums for the out-bound direction. +.It Cm -udp6csum-tx +Disable hardware-assisted UDP/IPv6 checksums for the out-bound direction. +.It Cm udp6csum-rx +Enable hardware-assisted UDP/IPv6 checksums for the in-bound direction. +.It Cm -udp6csum-rx +Disable hardware-assisted UDP/IPv6 checksums for the in-bound direction. +.It Cm tso4 +Enable hardware-assisted TCP/IPv4 segmentation on interfaces that +support it. +.It Cm -tso4 +Disable hardware-assisted TCP/IPv4 segmentation on interfaces that +support it. +.It Cm tso6 +Enable hardware-assisted TCP/IPv6 segmentation on interfaces that +support it. +.It Cm -tso6 +Disable hardware-assisted TCP/IPv6 segmentation on interfaces that +support it. +.It Cm vlan-hwfilter +Enable hardware-assisted VLAN frame filter on interfaces that support it. +.It Cm -vlan-hwfilter +Disable hardware-assisted VLAN frame filter on interfaces that support it. +.It Cm vlan-hwtagging +Enable hardware-assisted VLAN tag insertion/removal on interfaces that +support it. +.It Cm -vlan-hwtagging +Disable hardware-assisted VLAN tag insertion/removal on interfaces that +support it. +.It Cm maxupd Ar n +If the driver is a +.Xr pfsync 4 +pseudo-device, indicate the maximum number +of updates for a single state which can be collapsed into one. +This is an 8-bit number; the default value is 128. +.It Cm syncdev Ar iface +If the driver is a +.Xr pfsync 4 +pseudo-device, use the specified interface +to send and receive pfsync state synchronisation messages. +.It Fl syncdev +If the driver is a +.Xr pfsync 4 +pseudo-device, stop sending pfsync state +synchronisation messages over the network. +.It Cm syncpeer Ar peer_address +If the driver is a +.Xr pfsync 4 +pseudo-device, make the pfsync link point-to-point rather than using +multicast to broadcast the state synchronisation messages. +The peer_address is the IP address of the other host taking part in +the pfsync cluster. +With this option, +.Xr pfsync 4 +traffic can be protected using +.Xr ipsec 4 . +.It Fl syncpeer +If the driver is a +.Xr pfsync 4 +pseudo-device, broadcast the packets using multicast. +.It Cm unnumbered +Treat the interface as unnumbered. +.It Cm -unnumbered +Don't treat the interface as unnumbered. +.El +.Pp +.Nm +displays the current configuration for a network interface +when no optional parameters are supplied. +If a protocol family is specified, +.Nm +will report only the details specific to that protocol +family. +.Pp +If the +.Fl s +flag is passed before an interface name, +.Nm +will query the interface for its link state. +If the link state is reported to be down, +.Nm +will exit with status of 1 +.Pq false ; +otherwise, it will exit with a status of 0 +.Pq true . +.Pp +If the +.Fl m +flag is passed before an interface name, +.Nm +will display all of the supported media for the specified interface. +If the +.Fl L +flag is supplied, address lifetime is displayed for IPv6 addresses, +as time offset string. +.Pp +Optionally, the +.Fl a +flag may be used instead of an interface name. +This flag instructs +.Nm +to display information about all interfaces in the system. +This is also the default behaviour when no arguments are given to +.Nm +on the command line. +When +.Fl a +is used, the output can be modified by adding more flags: +.Fl d +limits this to interfaces that are down, +.Fl u +limits this to interfaces that are up, +.Fl b +limits this to broadcast interfaces, and +.Fl s +omits interfaces which appear not to be connected to a network. +.Pp +The +.Fl l +flag may be used to list all available interfaces on the system, with +no other additional information. +Use of this flag is mutually exclusive +with all other flags and commands, except for +.Fl d +.Pq only list interfaces that are down , +.Fl u +.Pq only list interfaces that are up , +.Fl s +.Pq only list interfaces that may be connected , +.Fl b +.Pq only list broadcast interfaces . +.Pp +The +.Fl C +flag may be used to list all of the interface cloners available on +the system, with no additional information. +Use of this flag is +mutually exclusive with all other flags and commands. +.Pp +The +.Fl v +flag prints additional information like statistics on packets sent and received +on the interface and the link state of the interface. +If +.Fl h +is used in conjunction with +.Fl v , +the byte statistics will be printed in "human-readable" format. +The +.Fl z +flag is identical to the +.Fl v +flag except that it zeros the interface input and output statistics +after printing them. +.Pp +The +.Fl w +flag may be used to wait +.Ar seconds +seconds for the +.Cm tentative +flag to be removed from all addresses. +0 seconds means to wait indefinitely until all addresses no longer have the +.Cm tentative +flag. +The optional +.Fl W +flag may be used to wait +.Ar seconds +seconds during the above time for the detached flag to be removed from all +addresses whose interface is marked ``up'' as well. +The detached flag is set when the interface does not have a carrier. +.Pp +The +.Fl N +flag is just the opposite of the +.Fl n +flag in +.Xr netstat 1 +or in +.Xr route 8 : +it tells +.Nm +to try to resolve numbers to hostnames or to service names. +The default +.Nm +behavior is to print numbers instead of names. +.Pp +Only the super-user may modify the configuration of a network interface. +.Sh EXAMPLES +Add a link-layer (MAC) address to an Ethernet: +.Pp +.Ic ifconfig sip0 link 00:11:22:33:44:55 +.Pp +Add and activate a link-layer (MAC) address: +.Pp +.Ic ifconfig sip0 link 00:11:22:33:44:55 active +.Sh DIAGNOSTICS +Messages indicating the specified interface does not exist, the +requested address is unknown, or the user is not privileged and +tried to alter an interface's configuration. +.Sh SEE ALSO +.Xr netstat 1 , +.Xr agr 4 , +.Xr lagg 4 , +.Xr carp 4 , +.Xr ifmedia 4 , +.Xr netintro 4 , +.Xr pfsync 4 , +.Xr vlan 4 , +.Xr ifconfig.if 5 , +.\" .Xr eon 5 , +.Xr ifmcstat 8 , +.Xr rc 8 , +.Xr routed 8 +.Sh BUGS +Due to hardware limitations some of the capabilities cannot be turned on +and off individually and need to be specified together. +For example the +.Xr ixg 4 +driver can't enable separately tcp and udp, or the transmit and receive +checksumming capabilities. +Unfortunately the diagnostic messages in this case are lacking. +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.2 . diff --git a/static/netbsd/man8/ifmcstat.8 b/static/netbsd/man8/ifmcstat.8 new file mode 100644 index 00000000..6601f55f --- /dev/null +++ b/static/netbsd/man8/ifmcstat.8 @@ -0,0 +1,45 @@ +.\" $NetBSD: ifmcstat.8,v 1.5 2000/10/15 11:45:16 itojun Exp $ +.\" $KAME: ifmcstat.8,v 1.3 2000/10/15 11:43:57 itojun Exp $ +.\" +.\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the project nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd October 14, 2000 +.Dt IFMCSTAT 8 +.Os +.Sh NAME +.Nm ifmcstat +.Nd dump multicast group management statistics per interface +.Sh SYNOPSIS +.Nm +.\" +.Sh DESCRIPTION +The +.Nm +command dumps multicast group information in the kernel. +.Pp +There are no command-line options. diff --git a/static/netbsd/man8/ifwatchd.8 b/static/netbsd/man8/ifwatchd.8 new file mode 100644 index 00000000..b82d6832 --- /dev/null +++ b/static/netbsd/man8/ifwatchd.8 @@ -0,0 +1,223 @@ +.\" $NetBSD: ifwatchd.8,v 1.29 2019/02/17 20:50:25 gutteridge Exp $ +.\" +.\" Copyright (c) 2001-2003 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Martin Husemann . +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 17, 2019 +.Dt IFWATCHD 8 +.Os +.Sh NAME +.Nm ifwatchd +.Nd "watch for addresses added to or deleted from interfaces and call up/down-scripts for them" +.Sh SYNOPSIS +.Nm +.Op Fl hiqv +.Op Fl A Ar arrival-script +.Op Fl c Ar carrier-script +.Op Fl D Ar departure-script +.Op Fl d Ar down-script +.Op Fl u Ar up-script +.Op Fl n Ar no-carrier-script +.Ar ifname(s) +.Sh DESCRIPTION +.Nm +is used to monitor dynamic interfaces (for example PPP interfaces) +for address changes, and to monitor static interfaces for carrier +changes. +Sometimes these interfaces are accompanied by a daemon program, +which can take care of running any necessary scripts (like +.Xr pppd 8 ) , +but sometimes the interfaces run completely autonomously (like +.Xr pppoe 4 ) . +.Pp +.Nm +provides a generic way to watch these types of changes. +It works by monitoring the routing socket and interpreting +.Ql RTM_NEWADDR +.Pq address added , +.Ql RTM_DELADDR +.Pq address deleted +and +.Ql RTM_IFINFO +.Pq carrier detect or loss of carrier +messages. +It does not need special privileges to do this. +The scripts called for up or down events are run with the same user +id as +.Nm +is run. +.Pp +The following options are available: +.Bl -tag -width indent +.It Fl A Ar arrival-script +Specify the command to invoke on arrival of new interfaces (like +PCMCIA cards). +.It Fl c Ar carrier-script +Specify the command to invoke when the carrier status transitions from +no carrier to carrier. +.It Fl D Ar departure-script +Specify the command to invoke when an interface departs (for example +a PCMCIA card is removed.) +.It Fl d Ar down-script +Specify the command to invoke on +.Dq interface down +events (or: deletion of an address from an interface). +.It Fl h +Show the synopsis. +.It Fl i +Inhibit a call to the up-script on startup for all watched interfaces +already marked up. +If this option is not given, +.Nm +will check all watched interfaces on startup whether they are +already marked up and, if they are, call the up-script with +appropriate parameters. +Additionally, if the interface is up and has a link, +.Nm +will run the carrier script. +.Pp +Since ifwatchd typically is started late in the system boot sequence, +some of the monitored interfaces may already have come up when it +finally starts, but their up-scripts have not been called. +By default +.Nm +calls them on startup to account for this (and make the scripts +easier.) +.It Fl n Ar no-carrier-script +Specify the command to invoke when the carrier status transitions from +carrier to no carrier. +.It Fl q +Be quiet and don't log non-error messages to syslog. +.It Fl u Ar up-script +Specify the command to invoke on +.Dq interface up +events (or: addition of an address to an interface). +.It Fl v +Run in verbose debug mode and do not detach from the controlling +terminal. +Output verbose progress messages and flag errors ignored during +normal operation. +.Em You do not want to use this option in +.Pa /etc/rc.conf ! +.It Ar ifname(s) +The name of the interface to watch. +Multiple interfaces may be specified. +Events for other interfaces are ignored. +.El +.Sh EXAMPLES +.Bd -literal -offset indent +# ifwatchd -u /etc/ppp/ip-up -d /etc/ppp/ip-down pppoe0 +.Ed +.Pp +If your pppoe0 interface is your main connection to the internet, +the typical use of the up/down scripts is to add and remove a +default route. +This is an example for an up script doing this: +.Bd -literal -offset indent +#! /bin/sh +/sbin/route add default $5 +/sbin/route add -inet6 default fe80::2 -iface ifp $1 +.Ed +.Pp +As described below the fifth command line parameter will contain +the peer address of the pppoe link. +The corresponding ip-down script is: +.Bd -literal -offset indent +#! /bin/sh +/sbin/route delete default $5 +/sbin/route delete -inet6 default fe80::2 +.Ed +.Pp +Note that this is not a good idea if you have pppoe0 configured to +connect only on demand (via the link1 flag), but works well for +all permanent connected cases. +Use +.Bd -literal -offset indent +! /sbin/route add default -iface 0.0.0.1 +.Ed +.Pp +in your +.Pa /etc/ifconfig.pppoe0 +file in the on-demand case. +.Sh PARAMETERS PASSED TO SCRIPTS +The invoked scripts get passed these parameters: +.Bl -tag -width destination +.It Ar ifname +The name of the interface this change is for (this allows to share +the same script for multiple interfaces watched and dispatching on +the interface name in the script). +.It Ar tty +Dummy parameter for compatibility with +.Xr pppd 8 +which will always be +.Em /dev/null . +.It Ar speed +Dummy parameter for compatibility with +.Xr pppd 8 +which will always be +.Em 9600 . +.It Ar address +The new address if this is an up event, or the no longer valid old +address if this is a down event. +.Pp +The format of the address depends on the address family, for IPv4 +it is the usual dotted quad notation, for IPv6 the colon separated +standard notation. +.It Ar destination +For point to point interfaces, this is the remote address of the +interface. +For other interfaces it is the broadcast address. +.El +.Sh ERRORS +The program logs to the syslog daemon as facility +.Dq daemon . +For detailed debugging use the +.Fl v +(verbose) option. +.Sh SEE ALSO +.Xr pppoe 4 , +.Xr route 4 , +.Xr ifconfig.if 5 , +.Xr rc.d 8 , +.Xr route 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Nx 1.6 . +.Sh AUTHORS +The program was written by +.An Martin Husemann +.Aq martin@NetBSD.org . +.Sh CAVEATS +Due to the nature of the program a lot of stupid errors can not +easily be caught in advance without removing the provided facility +for advanced uses. +For example typing errors in the interface name can not be detected +by checking against the list of installed interfaces, because it +is possible for a pcmcia card with the name given to be inserted +later. diff --git a/static/netbsd/man8/inetd.8 b/static/netbsd/man8/inetd.8 new file mode 100644 index 00000000..e54ff342 --- /dev/null +++ b/static/netbsd/man8/inetd.8 @@ -0,0 +1,898 @@ +.\" $NetBSD: inetd.8,v 1.69 2025/12/27 08:06:38 mlelstv Exp $ +.\" +.\" Copyright (c) 1998 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, +.\" NASA Ames Research Center. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" Copyright (c) 1985, 1991 The Regents of the University of California. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)inetd.8 8.4 (Berkeley) 6/1/94 +.\" +.Dd October 12, 2021 +.Dt INETD 8 +.Os +.Sh NAME +.Nm inetd , +.Nm inetd.conf +.Nd internet +.Dq super-server +.Sh SYNOPSIS +.Nm +.Op Fl d +.Op Fl l +.Op Ar configuration file +.Sh DESCRIPTION +.Nm +should be run at boot time by +.Pa /etc/rc +(see +.Xr rc 8 ) . +It then opens sockets according to its configuration and listens +for connections. +When a connection is found on one of its sockets, it decides what +service the socket corresponds to, and invokes a program to service +the request. +After the program is finished, it continues to listen on the socket +(except in some cases which will be described below). +Essentially, +.Nm +allows running one daemon to invoke several others, +reducing load on the system. +.Pp +The options available for +.Nm : +.Bl -tag -width Ds +.It Fl d +Turns on debugging and runs +.Nm +in the foreground. +.It Fl f +Runs +.Nm +in the foreground. +.It Fl l +Turns on libwrap connection logging. +.El +.Pp +Upon execution, +.Nm +reads its configuration information from a configuration +file which, by default, is +.Pa /etc/inetd.conf . +The path given for this configuration file must be absolute, unless +the +.Fl d +option is also given on the command line. +.Pp +Services can be specified using the legacy `positional' notation or the +`key-values' notation described in the sections +.Sx Positional Notation +and +.Sx Key-Values Notation +below. +.Ss Positional Notation +There must be an entry for each field of the configuration +file, with entries for each field separated by a tab or +a space. +Comments are denoted by a ``#'' at the beginning of a line (see subsection +.Sx Key-Values Notation +for defining comments in key-values definitions). +There must be an entry for each field (except for one +special case, described below). +A positional definition is terminated by a newline. +The fields of the configuration file are as follows: +.Pp +.Bd -unfilled -offset indent -compact +[listen-addr:]service-spec +socket-type[,accept-max][:accept-filter] +protocol[,sndbuf=size][,rcvbuf=size] +wait/nowait[:max] +user[:group] +server-program +server program arguments +.Ed +.Pp +The +.Em listen-addr +parameter specifies the local address +.Nm +should use when listening. +The single character +.Dq \&* +means +.Dv INADDR_ANY : +all local addresses. +The +.Em listen-addr +parameter may be a host name, which will be resolved once, when the service +definition is read from the config file. +.Pp +Note that restricted listen addresses are meaningless and ignored for +UNIX-domain services, and are not supported for +.Em Sun-RPC +services. +All +.Em Sun-RPC +services always listen on all interfaces. +.Pp +The form of the +.Em service-spec +parameter varies with the service type. +For Internet services, the +.Em service-spec +parameter can be either the name of a service from +.Pa /etc/services +or a decimal port number. +For +.Dq internal +services (discussed below), the service name +.Em must +be the official name of the service (that is, the first entry in +.Pa /etc/services ) +and not an alias for it. +.Pp +For +.Em Sun-RPC +based services, the +.Em service-spec +parameter has the form +.Em service-name Ns Li / Ns Em version . +The service name must be a valid RPC service name from +the file +.Pa /etc/rpc . +The +.Em version +on the right of the +.Dq / +is the RPC version number. +This can simply be a single numeric argument or a range of versions. +A range is bounded by the low version to the high version, e.g. +.Dq rusers/1-3 . +.Pp +For UNIX-domain (local) services, the +.Em service-spec +parameter is the path name to listen on. +.Pp +The +.Em service-spec +parameter must not begin with a dot. +See +.Sx Directives . +.Pp +The +.Em socket-type +parameter should be one of +.Dq stream , +.Dq dgram , +.Dq raw , +.Dq rdm , +or +.Dq seqpacket , +depending on whether the socket is a stream, datagram, raw, +reliably delivered message, or sequenced packet socket. +.Pp +Optionally, for Internet services, an accept limit +and an accept filter +(see +.Xr accept_filter 9 ) +can be specified. +The accept limit is appended with a comma followed by a decimal number, +the accept filter is appended with a colon to +.Em socket-type , +followed by the name of the desired accept filter. +In this case +.Nm +will not see new connections for the specified service until the +number of running instances is below the accept limit and the +accept filter decides they are ready to be handled. +The accept limit is ignored for services marked as +.Dq wait, +because the socket is handed over to the server program. +.\" XXX: do accept filters work for AF_UNIX sockets? nobody probably +.\" cares, but... +.Pp +The +.Em protocol +parameter must be a valid protocol as given in +.Pa /etc/protocols +or (for UNIX-domain services) the string +.Dq unix . +The most common are +.Dq tcp +and +.Dq udp . +For TCP and UDP, the IP version (4 or 6) may be specified explicitly +by appending 4 or 6 to the protocol name. +Otherwise the default version (IPv4) is used. +For +.Em Sun-RPC +the string +.Dq rpc +and a slash should be prepended: +.Dq rpc/tcp +or +.Dq rpc/udp . +If you would like to enable special support for +.Xr faithd 8 , +prepend the string +.Dq faith +and a slash: +.Dq faith/tcp6 . +.Pp +In addition to the protocol, the configuration file may specify the +send and receive socket buffer sizes for the listening socket. +This is especially useful for +.Tn TCP : +the window scale factor, which is based on the receive socket +buffer size, is advertised when the connection handshake occurs +and thus the socket buffer size must be set on the listen socket. +By increasing the socket buffer sizes, better +.Tn TCP +performance may be realized in some situations. +The socket buffer sizes are specified by appending their values to +the protocol specification as follows: +.Bd -literal -offset indent +tcp,rcvbuf=16384 +tcp,sndbuf=64k +tcp,rcvbuf=64k,sndbuf=1m +.Ed +.Pp +A literal value may be specified, or modified using +.Sq k +to indicate kibibytes or +.Sq m +to indicate mebibytes. +Socket buffer sizes may be specified for all +services and protocols except for tcpmux services. +.Pp +The +.Em wait/nowait +entry is used to tell +.Nm +if it should wait for the server program to return, +or continue processing connections on the socket. +If a datagram server reads a single datagram and connects +to its peer through a different socket, freeing the service's socket so +.Nm +can receive further messages on the socket, it is said to be +a +.Dq multi-threaded +server, and should use the +.Dq nowait +entry. +For datagram servers which process all incoming datagrams +on a socket and eventually time out, the server is said to be +.Dq single-threaded +and should use a +.Dq wait +entry. +.Xr comsat 8 +.Pq Xr biff 1 +and +.Xr ntalkd 8 +are both examples of the latter type of +datagram server. +.Xr tftpd 8 +is an exception; it is a datagram server that establishes pseudo-connections. +It must be listed as +.Dq wait +in order to avoid a race; +the server reads the first packet, creates a new socket, +and then forks and exits to allow +.Nm +to check for new service requests to spawn new servers. +The optional +.Dq max +suffix (separated from +.Dq wait +or +.Dq nowait +by a dot or a colon) specifies the maximum number of server instances that may +be spawned from +.Nm +within an interval of 60 seconds. +When omitted, +.Dq max +defaults to 40. +If it reaches this maximum spawn rate, +.Nm +will log the problem (via the syslogger using the +.Dv LOG_DAEMON +facility and +.Dv LOG_ERR +level) +and stop handling the specific service for ten minutes. +.Pp +Stream servers are usually marked as +.Dq nowait +but if a single server process is to handle multiple connections, it may be +marked as +.Dq wait . +The master socket will then be passed as fd 0 to the server, which will then +need to accept the incoming connection. +The server should eventually time +out and exit when no more connections are active. +.Nm +will continue to +listen on the master socket for connections, so the server should not close +it when it exits. +.Xr identd 8 +is usually the only stream server marked as wait. +.Pp +The +.Em user +entry should contain the user name of the user as whom the server should run. +This allows for servers to be given less permission than root. +Optionally, a group can be specified by appending a colon to the user name, +followed by the group name (it is possible to use a dot (``.'') in lieu of a +colon, however this feature is provided only for backward compatibility). +This allows for servers to run with a different (primary) group id than +specified in the password file. +If a group is specified and +.Em user +is not root, the supplementary groups associated with that user will still be +set. +.Pp +The +.Em server-program +entry should contain the pathname of the program which is to be +executed by +.Nm +when a request is found on its socket. +If +.Nm +provides this service internally, this entry should +be +.Dq internal . +.Pp +The +.Em server program arguments +should be just as arguments +normally are, starting with argv[0], which is the name of +the program. +If the service is provided internally, the +word +.Dq internal +should take the place of this entry. +It is possible to quote an argument using either single or double quotes. +This allows you to have, e.g., spaces in paths and parameters. +.Ss Key-Values Notation +In key-values notation, keys are separated from their associated values by `=', +values are separated by whitespace, and key-values options are separated by +commas. +A service definition is terminated by a semicolon. +Multiple definitions may exist on a single line (and a line may +end with a positional definition. +A key-values definition has the following form: +.Bd -filled -offset indent +[listen-addr:]service-spec {on|off}