diff options
author | cinap_lenrek <cinap_lenrek@centraldogma> | 2011-05-12 18:36:46 +0000 |
---|---|---|
committer | cinap_lenrek <cinap_lenrek@centraldogma> | 2011-05-12 18:36:46 +0000 |
commit | c8a551c414eacc3d756efa21e93a8389bdafd180 (patch) | |
tree | d2a4f9b3f6ac54729b58e4b369c56f5a4572b559 | |
parent | cc8ee7f932624d6d3e6094db13fa63327e81c191 (diff) |
manpage updates
-rw-r--r-- | sys/lib/man/permind/toc | 543 | ||||
-rw-r--r-- | sys/man/1/kbmap | 4 | ||||
-rwxr-xr-x | sys/man/3/cons | 94 | ||||
-rw-r--r-- | sys/man/3/kbd | 43 | ||||
-rw-r--r-- | sys/man/3/kbin | 36 | ||||
-rw-r--r-- | sys/man/3/kbmap | 70 | ||||
-rw-r--r-- | sys/man/4/cifs | 5 | ||||
-rw-r--r-- | sys/man/4/usb | 8 | ||||
-rw-r--r-- | sys/man/8/boot | 86 | ||||
-rw-r--r-- | sys/man/8/fshalt | 4 | ||||
-rw-r--r-- | sys/man/8/kbdfs | 222 | ||||
-rw-r--r-- | sys/man/8/plan9.ini | 27 | ||||
-rw-r--r-- | sys/man/8/prep | 61 | ||||
-rw-r--r-- | sys/man/8/update | 127 | ||||
-rw-r--r-- | sys/man/mkfile | 6 |
15 files changed, 307 insertions, 1029 deletions
diff --git a/sys/lib/man/permind/toc b/sys/lib/man/permind/toc deleted file mode 100644 index 839848d26..000000000 --- a/sys/lib/man/permind/toc +++ /dev/null @@ -1,543 +0,0 @@ -INTRO 1 1 -2A 1 4 -2C 1 5 -2L 1 8 -ABACO 1 10 -ACID 1 11 -ACME 1 15 -AP 1 20 -AR 1 21 -ASCII 1 22 -AWK 1 23 -BASENAME 1 27 -BC 1 28 -BIND 1 30 -BITSYLOAD 1 32 -BUNDLE 1 33 -CAL 1 34 -CALENDAR 1 35 -CAT 1 36 -CB 1 37 -CHGRP 1 38 -CHMOD 1 39 -CLEANNAME 1 40 -CMP 1 41 -COL 1 42 -COLORS 1 43 -COMM 1 44 -CON 1 45 -CP 1 47 -CPP 1 48 -CPU 1 49 -CROP 1 51 -DATE 1 52 -DB 1 53 -DC 1 59 -DD 1 61 -DELKEY 1 63 -DEROFF 1 64 -DIFF 1 65 -DOC2TXT 1 66 -DOCTYPE 1 67 -DU 1 68 -ECHO 1 69 -ECP 1 70 -ED 1 71 -EMACS 1 75 -EQN 1 76 -EXPECT 1 78 -FACES 1 80 -FACTOR 1 81 -FEDEX 1 82 -FILE 1 83 -FILTER 1 84 -FMT 1 86 -FORTUNE 1 87 -FREQ 1 88 -GAMES 1 89 -GRAP 1 91 -GRAPH 1 93 -GREP 1 94 -GS 1 95 -GVIEW 1 98 -GZIP 1 100 -HG 1 102 -HGET 1 124 -HISTORY 1 125 -HOC 1 126 -HTMLROFF 1 127 -IDIFF 1 128 -IO 1 129 -JOIN 1 130 -JPG 1 131 -KBMAP 1 133 -KILL 1 134 -KTRACE 1 135 -LEAK 1 136 -LENS 1 138 -LEX 1 139 -LOCK 1 140 -LOOK 1 141 -LP 1 142 -LS 1 144 -MAIL 1 146 -MAN 1 147 -MARSHAL 1 148 -MC 1 149 -MK 1 150 -MKDIR 1 155 -MLMGR 1 156 -MP3DEC 1 157 -MP3ENC 1 158 -MS2HTML 1 160 -MTIME 1 161 -MUG 1 162 -NEDMAIL 1 163 -NETSTAT 1 166 -NEWS 1 167 -NM 1 168 -NS 1 169 -P 1 170 -PAGE 1 171 -PASSWD 1 173 -PATCH 1 174 -PCC 1 176 -PIC 1 178 -PIPEFILE 1 181 -PLOT 1 182 -PLUMB 1 183 -PR 1 184 -PROF 1 185 -PROOF 1 187 -PS 1 188 -PS2PDF 1 189 -PUMP 1 190 -PWD 1 191 -PYTHON 1 192 -RATRACE 1 196 -RC 1 197 -REPLICA 1 203 -RESAMPLE 1 206 -RIO 1 207 -RM 1 211 -RWD 1 212 -SAM 1 214 -SECSTORE 1 219 -SED 1 221 -SEG 1 224 -SEQ 1 225 -SIZE 1 226 -SLEEP 1 227 -SORT 1 228 -SPELL 1 230 -SPIN 1 231 -SPLIT 1 233 -SRC 1 234 -SSH 1 235 -STOP 1 238 -STRINGS 1 239 -STRIP 1 240 -SUM 1 241 -SYSCALL 1 242 -TAIL 1 243 -TAR 1 244 -TBL 1 246 -TCS 1 248 -TEE 1 250 -TEL 1 251 -TEST 1 252 -THESAURUS 1 254 -TIME 1 255 -TOUCH 1 256 -TR 1 257 -TRACE 1 258 -TROFF 1 259 -TROFF2HTML 1 261 -TWEAK 1 262 -UNIQ 1 264 -UNITS 1 265 -UPTIME 1 266 -VAC 1 267 -VENTI 1 269 -VI 1 270 -VNC 1 272 -VT 1 274 -WC 1 275 -WEATHER 1 276 -WHO 1 277 -WINWATCH 1 278 -XD 1 279 -YACC 1 280 -YESTERDAY 1 282 -INTRO 2 284 -9P 2 287 -9PCMDBUF 2 292 -9PFID 2 293 -9PFILE 2 295 -ABORT 2 297 -ABS 2 298 -ACCESS 2 299 -ADDPT 2 300 -AES 2 302 -ALLOCIMAGE 2 303 -ARG 2 306 -ARITH3 2 308 -ASSERT 2 310 -ATOF 2 311 -AUTH 2 312 -AUTHSRV 2 315 -AVL 2 317 -BIN 2 319 -BIND 2 320 -BIO 2 322 -BLOWFISH 2 325 -BRK 2 326 -CACHECHARS 2 327 -CHDIR 2 330 -CLEANNAME 2 331 -COLOR 2 332 -COMPLETE 2 333 -CONTROL 2 334 -CPUTIME 2 349 -CTIME 2 350 -CTYPE 2 352 -DEBUGGER 2 353 -DES 2 356 -DIAL 2 358 -DIRREAD 2 361 -DISK 2 362 -DRAW 2 363 -DSA 2 369 -DUP 2 371 -ELGAMAL 2 372 -ENCODE 2 374 -ENCRYPT 2 375 -ERRSTR 2 376 -EVENT 2 377 -EXEC 2 380 -EXITS 2 382 -EXP 2 383 -FAUTH 2 384 -FCALL 2 385 -FD2PATH 2 388 -FGETC 2 389 -FLATE 2 391 -FLOOR 2 393 -FMTINSTALL 2 394 -FOPEN 2 397 -FORK 2 400 -FPRINTF 2 402 -FRAME 2 405 -FREXP 2 408 -FSCANF 2 409 -FVERSION 2 412 -GETCALLERPC 2 413 -GETENV 2 414 -GETFCR 2 415 -GETFIELDS 2 416 -GETPID 2 417 -GETUSER 2 418 -GETWD 2 419 -GRAPHICS 2 420 -HTML 2 424 -HTTPD 2 436 -HYPOT 2 441 -INTMAP 2 442 -IOPROC 2 443 -IOUNIT 2 445 -IP 2 446 -ISALPHARUNE 2 449 -KEYBOARD 2 450 -LOCK 2 451 -MACH 2 454 -MALLOC 2 457 -MATRIX 2 459 -MEMDRAW 2 461 -MEMLAYER 2 465 -MEMORY 2 468 -MKTEMP 2 469 -MOUSE 2 470 -MP 2 472 -MULDIV 2 476 -NAN 2 477 -NDB 2 478 -NOTIFY 2 482 -OBJECT 2 484 -OPEN 2 486 -PERROR 2 487 -PIPE 2 488 -PLUMB 2 489 -POOL 2 491 -POSTNOTE 2 494 -PRIME 2 495 -PRINT 2 496 -PRIVALLOC 2 499 -PROTO 2 500 -PUSHSSL 2 501 -PUSHTLS 2 502 -QBALL 2 505 -QSORT 2 506 -QUATERNION 2 507 -QUOTE 2 509 -RAND 2 510 -RC4 2 512 -READ 2 513 -READCOLMAP 2 514 -READV 2 515 -REGEXP 2 516 -REMOVE 2 518 -RENDEZVOUS 2 519 -RSA 2 520 -RUNE 2 522 -RUNESTRCAT 2 524 -SCRIBBLE 2 525 -SCSI 2 527 -SECHASH 2 529 -SEEK 2 531 -SEGATTACH 2 532 -SEGBRK 2 534 -SEGFLUSH 2 535 -SEMACQUIRE 2 536 -SETJMP 2 537 -SIN 2 538 -SINH 2 539 -SLEEP 2 540 -STAT 2 541 -STRCAT 2 543 -STRING 2 545 -STRINGSIZE 2 547 -SUBFONT 2 548 -SYMBOL 2 550 -THREAD 2 553 -TIME 2 557 -TMPFILE 2 558 -USB 2 559 -USBFS 2 563 -VENTI 2 566 -VENTI-CACHE 2 567 -VENTI-CLIENT 2 569 -VENTI-CONN 2 571 -VENTI-FCALL 2 573 -VENTI-FILE 2 575 -VENTI-LOG 2 577 -VENTI-MEM 2 578 -VENTI-PACKET 2 579 -VENTI-SERVER 2 581 -VENTI-ZERO 2 582 -WAIT 2 583 -WINDOW 2 584 -INTRO 3 586 -AOE 3 587 -APM 3 590 -ARCH 3 591 -AUDIO 3 593 -BRIDGE 3 594 -CAP 3 596 -CONS 3 597 -DRAW 3 600 -DUP 3 604 -ENV 3 605 -ETHER 3 606 -FLASH 3 607 -FLOPPY 3 609 -FS 3 610 -I82365 3 612 -IP 3 613 -KBIN 3 621 -KBMAP 3 622 -KPROF 3 623 -LOOPBACK 3 624 -LPT 3 625 -MNT 3 626 -MOUSE 3 627 -PIPE 3 629 -PNP 3 630 -PROC 3 632 -ROOT 3 636 -RTC 3 637 -SD 3 638 -SDAHCI 3 640 -SDAOE 3 642 -SEGMENT 3 643 -SRV 3 644 -SSL 3 645 -TLS 3 647 -TWSI 3 649 -UART 3 650 -USB 3 651 -VGA 3 655 -INTRO 4 657 -ACME 4 658 -ARCHFS 4 661 -CDFS 4 662 -CFS 4 664 -CIFS 4 665 -CONSOLEFS 4 667 -CWFS 4 669 -DOSSRV 4 671 -EXECNET 4 673 -EXPORTFS 4 674 -EXT2SRV 4 676 -FACTOTUM 4 677 -FLASHFS 4 682 -FS 4 683 -FTPFS 4 685 -HTTPFILE 4 687 -IMPORT 4 688 -IOSTATS 4 690 -KEYFS 4 691 -KFS 4 693 -LNFS 4 694 -MNTGEN 4 695 -NAMESPACE 4 696 -NFS 4 699 -NNTPFS 4 701 -PAQFS 4 702 -PLUMBER 4 703 -RAMFS 4 704 -RATFS 4 705 -RDBFS 4 706 -RIO 4 707 -SACFS 4 710 -SNAP 4 711 -SRV 4 712 -TAPEFS 4 714 -TELCO 4 715 -U9FS 4 717 -UPASFS 4 719 -USB 4 721 -USBD 4 724 -VACFS 4 726 -WEBCOOKIES 4 727 -WEBFS 4 729 -WIKIFS 4 732 -INTRO 5 734 -ATTACH 5 738 -CLUNK 5 739 -ERROR 5 740 -FLUSH 5 741 -OPEN 5 742 -READ 5 744 -REMOVE 5 745 -STAT 5 746 -VERSION 5 748 -WALK 5 749 -INTRO 6 750 -A.OUT 6 751 -AR 6 753 -AUTHSRV 6 754 -COLOR 6 758 -FACE 6 760 -FONT 6 761 -HTMLROFF 6 762 -IMAGE 6 765 -KEYBOARD 6 767 -KEYS.WHO 6 769 -MAN 6 770 -MAP 6 772 -MHTML 6 773 -MNIHONGO 6 774 -MPICTURES 6 775 -MS 6 776 -NAMESPACE 6 778 -NDB 6 779 -PLOT 6 782 -PLUMB 6 784 -REGEXP 6 788 -REWRITE 6 789 -SMTPD 6 790 -SNAP 6 792 -STYLE 6 793 -THUMBPRINT 6 794 -USERS 6 795 -UTF 6 796 -VENTI 6 797 -VENTI.CONF 6 800 -VGADB 6 801 -INTRO 7 804 -ASTRO 7 805 -DICT 7 806 -JUKE 7 807 -MAP 7 810 -PLAYLISTFS 7 814 -SCAT 7 816 -INTRO 8 819 -6IN4 8 820 -9BOOT 8 821 -9PCON 8 822 -AAN 8 823 -ALIASMAIL 8 824 -APM 8 825 -AQUARELA 8 826 -AUTH 8 828 -BACKUP 8 830 -BOOT 8 831 -BOOTING 8 834 -CEC 8 836 -CPURC 8 837 -CRON 8 838 -DHCPD 8 839 -DISKPARTS 8 841 -DISKSIM 8 842 -DRAWTERM 8 843 -FS 8 844 -FSCONFIG 8 849 -FSHALT 8 853 -GETFLAGS 8 854 -GPSFS 8 855 -HGIGNORE 8 857 -HGRC 8 859 -HISTOGRAM 8 870 -HTTPD 8 871 -INIT 8 873 -IPCONFIG 8 874 -IPSERV 8 877 -KFSCMD 8 879 -LISTEN 8 881 -LP 8 883 -MK9660 8 884 -MKFLASHFS 8 886 -MKFS 8 887 -MKPAQFS 8 888 -MKSACFS 8 889 -MOUSE 8 890 -NA 8 891 -NDB 8 892 -NEWUSER 8 897 -NFSSERVER 8 899 -PARTFS 8 901 -PCI 8 902 -PCMCIA 8 903 -PEM 8 904 -PING 8 905 -PLAN9.INI 8 907 -POP3 8 914 -PPP 8 915 -PREP 8 917 -QER 8 921 -REALEMU 8 923 -REBOOT 8 924 -REPLICA 8 925 -RSA 8 927 -SCANMAIL 8 929 -SCREENLOCK 8 932 -SCUZZ 8 933 -SECSTORE 8 936 -SECURENET 8 937 -SEND 8 938 -SMTP 8 939 -SNOOPY 8 941 -STATS 8 943 -STATUSBAR 8 945 -STUB 8 946 -SWAP 8 947 -TIMESYNC 8 948 -TLSSRV 8 949 -TRAMPOLINE 8 950 -UDPECHO 8 951 -UPDATE 8 952 -VENTI 8 953 -VENTI-BACKUP 8 957 -VENTI-FMT 8 958 -VGA 8 961 -WOL 8 963 diff --git a/sys/man/1/kbmap b/sys/man/1/kbmap index 5a8d8a4e3..a5bcbe9bd 100644 --- a/sys/man/1/kbmap +++ b/sys/man/1/kbmap @@ -22,14 +22,14 @@ for the system; typing 'q' quits. requires that the file .B /dev/kbmap served by -.IR kbmap (3) +.IR kbdfs (8) exists and is writable. ..SH FILES .TF /lib/kbmap/* .SH SOURCE .B /sys/src/cmd/kbmap.c .SH "SEE ALSO" -.IR kbmap (3) +.IR kbdfs (8) .SH BUGS Not all keyboards map the entire set of characters, so one has to switch back to the default map before changing to another. diff --git a/sys/man/3/cons b/sys/man/3/cons index c816e1b17..4dadd7b16 100755 --- a/sys/man/3/cons +++ b/sys/man/3/cons @@ -8,7 +8,6 @@ cons \- console, clocks, process/process group ids, user, null, reboot, etc. .B /dev/bintime .B /dev/config .B /dev/cons -.B /dev/consctl .B /dev/cputime .B /dev/drivers .B /dev/hostdomain @@ -31,81 +30,18 @@ cons \- console, clocks, process/process group ids, user, null, reboot, etc. .fi .SH DESCRIPTION The console device serves a one-level directory -giving access to the console and +giving access to the console screen and miscellaneous information. .PP -Reading the -.B cons -file returns characters typed on the keyboard. -Normally, characters are buffered to enable erase and kill processing. -A control-U, -.LR ^U , -typed at the keyboard -.I kills -the current input line (removes all characters -from the buffer of characters -not yet read via -.BR cons ), -and a backspace -.I erases -the previous non-kill, non-erase character from the input buffer. -Killing and erasing only delete characters back to, but not including, -the last newline. -Characters typed at the keyboard actually produce 16-bit runes (see -.IR utf (6)), -but the runes are translated into the variable-length -.SM UTF -encoding (see -.IR utf (6)) -before putting them into the buffer. -A -.IR read (2) -of length greater than zero causes the process to wait until a -newline or a -.L ^D -ends the buffer, and then returns as much of the buffer as the argument -to -.B read -allows, but only up to one complete line. -A terminating -.L ^D -is not put into the buffer. -If part of the line remains, the next -.B read -will return bytes from that remainder and not part of any new line -that has been typed since. -.PP -If -the string -.B rawon -has been written to the -.B consctl -file and the file is still open, -.B cons -is in -.IR "raw mode" : -characters are not echoed as they are typed, -backspace, -.L ^U -and -.L ^D -are not treated specially, -and characters are available to -.I read -as soon as they are typed. -Ordinary mode is reentered when -.B rawoff -is written to -.B consctl -or this file is closed. -.PP A .I write (see .IR read (2)) to .B cons -causes the characters to be printed on the console screen. +causes the characters to be printed on the console screen. Console +input is handled by a different program (see +.IR kbdfs (8)). .PP The .B osversion @@ -352,29 +288,11 @@ process number parent's process number .SH SEE ALSO .IR draw (3), +.IR kbd (3), +.IR kbdfs (8), .IR keyboard (6), .IR authsrv (6), .IR utf (6), .IR swap (8) .SH SOURCE .B /sys/src/9/port/devcons.c -.SH BUGS -For debugging, two control-T's followed by a letter -generate console output and manage debugging: -.L ^T^Td -toggles whether the console debugger will be run if the system fails. -.L ^T^TD -starts the console debugger immediately. -.L ^T^Tk -kills the largest process; use with care. -.L ^T^Tp -prints data about processes. -.L ^T^Tq -prints the run queue for processor 0. -.L ^T^Ts -prints the kernel stack. -.L ^T^Tx -prints data about kernel memory allocation. -.PP -The system can be rebooted by typing -.LR ^T^Tr . diff --git a/sys/man/3/kbd b/sys/man/3/kbd new file mode 100644 index 000000000..b1f85f508 --- /dev/null +++ b/sys/man/3/kbd @@ -0,0 +1,43 @@ +.TH KBD 3 +.SH NAME +kbd \- pc keyboard driver +.SH SYNOPSIS +.nf +.B bind -a #b /dev + +.B /dev/scancode +.B /dev/leds +.fi +.SH DESCRIPTION +.PP +The +.I kbd +device serves a one-level directory containing the files +.BR scancode +and +.BR leds . +.PP +Reading the +.BR scancode +file returns the raw scancode stream as it is emited by the keyboard +device without any translation. It is usualy +.IR kbdfs (8) +task to interpret the scancodes and provide device independent +keyboard input to programs. The +.BR scancode +file can be only opend once by the hostowner. +.PP +Writing a number to the write only +.BR leds +file changes the status leds on the keyboard. the value of the +number is the addition of 1, 2 and 4 representing activated +Scroll, Num and Caps leds. +.SH EXAMPLE +Set the Scroll and Caps leds: +.EX +echo 5 >/dev/leds +.EE +.SH "SEE ALSO" +.IR kbdfs (8) +.SH SOURCE +.B /sys/src/9/pc/devkbd.c diff --git a/sys/man/3/kbin b/sys/man/3/kbin deleted file mode 100644 index ffc9c271d..000000000 --- a/sys/man/3/kbin +++ /dev/null @@ -1,36 +0,0 @@ -.TH KBIN 3 -.SH NAME -kbin \- external keyboard input -.SH SYNOPSIS -.nf -.B bind -a #Ι /dev -.sp 0.3v -.B /dev/kbin -.fi -.SH DESCRIPTION -The -.I kbin -device is a PC driver that -serves a one-level directory containing a single file, -.BR kbin , -which can be used to send -keyboard scan codes to the kernel. -.PP -.I Kbin -is necessary for -.IR usb (4) -drivers that handle keyboards. -Keyboard input -is processed as described in -.IR cons (3). -The scan codes correspond to the PC keyboard used by the -.IR cons (3) -driver and can be translated by the -.IR kbmap (3) -device. -.SH "SEE ALSO" -.IR cons (3), -.IR kbmap (3), -.IR keyboard (6) -.SH SOURCE -.B /sys/src/9/pc/devkbin.c diff --git a/sys/man/3/kbmap b/sys/man/3/kbmap deleted file mode 100644 index a3b9fad37..000000000 --- a/sys/man/3/kbmap +++ /dev/null @@ -1,70 +0,0 @@ -.TH KBMAP 3 -.SH NAME -kbmap \- keyboard map -.SH SYNOPSIS -.nf -.B bind -a #κ /dev - -.B /dev/kbmap -.fi -.SH DESCRIPTION -.PP -The -.I kbmap -device serves a one-level directory containing a single file, -.BR kbmap , -representing the kernel's mapping of -keyboard scan codes to Unicode characters -(see -.IR cons (3) -and -.IR keyboard (6)). -.PP -Reads return the current contents of the map. -Each entry is one line containing three 11 character numeric fields, each followed by a space: -a table number, an index into the table (scan code), and the decimal value -of the corresponding Unicode character (0 if none). -The table numbers are platform dependent; they typically distinguish -between unshifted and shifted keys. -The scan code values are hardware dependent and can vary -from keyboard to keyboard. -.PP -Writes to the file change the map. -Lines written to the file must contain three space-separated fields, -representing the table number, scan code index, and Unicode character. -Values are taken to be decimal unless they start with -.B 0x -(hexadecimal) or -.B 0 -(octal). -The Unicode character can also be represented as -.BI ' x -where -.I x -gives the UTF-8 representation of the character -(see -.IR utf (6)), -or as -.BI ^ X -to represent a control character. -.PP -The Unicode character can also be -.BI M n -to represent mouse button -.IR n . -The map -.B /sys/lib/kbmap/mouse-fn -maps the F1 through F5 keys to the three mouse buttons and the two -scroll wheel buttons. -Similarly, -.B mouse-csa -maps the left Control, Start, and Alt keys to the three mouse buttons. -These maps are useful on laptops without three-button mice. -.SH "SEE ALSO" -.IR cons (3), -.IR keyboard (6), -.IR utf (6) -.SH FILES -.B /sys/lib/kbmap/* -.SH SOURCE -.B /sys/src/9/port/devkbmap.c diff --git a/sys/man/4/cifs b/sys/man/4/cifs index f53cf1f1b..9481df6c5 100644 --- a/sys/man/4/cifs +++ b/sys/man/4/cifs @@ -170,7 +170,7 @@ DNS paths are usually assigned dynamicially as a form of load balancing. .B /sys/src/cmd/cifs .SH SEE ALSO .IR factotum (4), -.IR aquarela (8) +.IR cifsd (8) .SH BUGS NetApp Filer compatibility has not yet been tested; there may not be any. .PP @@ -182,7 +182,6 @@ NetBios name resolution is not supported, though it is now rarely used. .PP .I Cifs has only been tested against -.IR aquarela (8), -Windows 95, NT4.0sp6, +aquarela, Windows 95, NT4.0sp6, Windows server 2003, WinXP pro, Samba 3.0, and Samba 2.0 (Pluto VideoSpace). No support is attempted for servers predating NT 4.0. diff --git a/sys/man/4/usb b/sys/man/4/usb index 5df684c9e..fa20e3a5d 100644 --- a/sys/man/4/usb +++ b/sys/man/4/usb @@ -175,7 +175,9 @@ supports USB keyboards and mice either as separate USB devices or as a single combined USB device. Scan codes from the keyboard are sent to .B /dev/kbin -to let the kernel process them. +to let +.IR kbdfs (8) +process them. Mouse events are sent to .B /dev/mousein in the same way. @@ -487,13 +489,13 @@ at once, with one action per line. .SH SOURCE .B /sys/src/cmd/usb .SH "SEE ALSO" -.IR kbin (3), .IR mouse (3), .IR sd (3), .IR uart (3), .IR usb (3), .IR usbd (4), -.IR partfs (8) +.IR partfs (8), +.IR kbdfs (8) .SH BUGS The various device drivers are generic USB drivers and may work only for certain devices on each class. diff --git a/sys/man/8/boot b/sys/man/8/boot index 094bf83ec..e18b8c4ae 100644 --- a/sys/man/8/boot +++ b/sys/man/8/boot @@ -90,7 +90,7 @@ Method and address are prompted for first. The prompt lists all valid methods, with the default in brackets, for example: .IP .EX -root is from (tcp, local!#S/sdC0/fs)[tcp]: +bootargs is (tcp, local!device)[/dev/sdC0/fscache]: .EE .PP A newline picks the default. @@ -253,56 +253,6 @@ connect to the local file system. The first argument is a disk holding a file system. .I Boot inspects the disk. -If the disk is a -.IR fossil (4) -file system, it invokes -.B /boot/fossil -to serve it. -If the -.B venti -environment variable (really, -.IR plan9.ini (8) -variable) is set, -.I boot -first arranges for fossil to be able to -contact the named -.IR venti (8) -server. -The variable's value can take the following forms: -.RS -.TP -.B /dev/sdC0/arenas -the file should be a venti partition with a configuration -stored on it using -.I venti/conf -(see -.IR venti-fmt (8)). -.I Boot -will start a loopback IP interface on 127.0.0.1 -and start -.I venti -announcing on -.B tcp!127.1!17034 -for venti service -and -.B tcp!127.1!8000 -for web service, -using the configuration stored in that partition. -.TP -.B /dev/sdC0/arenas tcp!*!17034 -same as the last but specify an alternate venti service address. -In this example, using -.B * -will announce on all available IP interfaces (even ones configured later) -rather than just the loopback device. -The loopback interface is still configured. -.TP -.B /dev/sdC0/arenas tcp!*!17034 tcp!*!80 -same as the last but specify alternate venti service and web addresses. -The loopback interface is still configured. -.TP -.B tcp!135.104.9.2!17034 \fR[ \fIargs\fR ] -the network address of a venti server running on a separate machine. .I Boot will configure the IP stack by passing .IR args , @@ -310,28 +260,6 @@ if any, to .IR ipconfig (8). .RE .PP -If the disk is not a -.IR fossil (4) -partition, -.I boot -invokes -.BR /boot/kfs . -A variety of programs, like -.I 9660srv -and -.IR dossrv (4) -masquerade as -.I kfs -to allow booting from alternate media formats, -so as long as the disk is not a -.I fossil -disk, no check is made that the disk is in fact -a -.I kfs -disk. -The args are passed to -.IR kfs (4). -.PP For the .B tcp method, @@ -348,11 +276,11 @@ variable in .IR plan9.ini (8). .PP Start -.IR kfs (4) -with extra disk buffers: +.IR cwfs (4) +in config mode: .IP .EX -bootargs=local!#S/sdC0/fs -B 4096 +bootargs=local!/dev/sdC0/fscache -c .EE .LP Use an IP stack on an alternate ethernet interface @@ -362,7 +290,7 @@ server addresses. .EX fs=192.168.0.2 auth=192.168.0.3 -bootargs=tcp -g 192.168.0.1 ether /net/ether1 \e +bootargs=tcp!-g 192.168.0.1 ether /net/ether1 \e 192.168.0.50 255.255.255.0 .EE .LP @@ -383,7 +311,3 @@ line is split only for presentation; it is one line in the file.) The use of .B bootargs in general is odd. -The configuration specification -for fossil and venti servers -is particularly odd, but it does -cover the common cases well. diff --git a/sys/man/8/fshalt b/sys/man/8/fshalt index d01537830..25b9e4b61 100644 --- a/sys/man/8/fshalt +++ b/sys/man/8/fshalt @@ -11,13 +11,13 @@ fshalt, reboot \- halt any local file systems and optionally reboot the system .SH DESCRIPTION .I Fshalt syncs all local -.IR fossil (4), +.IR cwfs (4), .IR venti (8), and .IR kfs (4) servers, then halts all local -.IR fossil +.IR cwfs and .IR kfs servers. diff --git a/sys/man/8/kbdfs b/sys/man/8/kbdfs new file mode 100644 index 000000000..cb13cbd7e --- /dev/null +++ b/sys/man/8/kbdfs @@ -0,0 +1,222 @@ +.TH KBDFS 8 +.SH NAME +kbdfs \- keyboard and console filesystem +.SH SYNOPSIS +.B aux/kbdfs +[ +.B -Dd +] [ +.B -s +.I srv +] [ +.B -m +.I mntpnt +] [ +.I consfile +] +.nf + +.B mount -b /srv/cons /dev +.B /dev/cons +.B /dev/consctl +.B /dev/kbd +.B /dev/kbin +.B /dev/kbmap +.fi +.SH DESCRIPTION +.PP +Started on +.IR boot (8), +.IR kbdfs +translates raw keyboard scancodes from +.B /dev/scancode +(see +.IR kbd (3)) +and its +.BR kbin +file and optionaly reads console input from +.I consfile +to provide initial keyboard and console input. +.PP +It serves a one-level directory containing the files +.BR cons, +.BR consctl, +.BR kbd, +.BR kbin +and +.BR kbmap. +.PP +The +.B -D +flag enables a debug trace of +.I 9p +messages and +.B -d +prevents +.IR kbdfs +from making its memory private. +.PP +The +.B -s +option causes +.IR kbdfs +to post its channel on +.B /srv/ +.I srv. +On system startup, +.IR boot (8) +sets this to +.B cons. +With the +.B -m +option, +.IR kbdfs +mounts itself before (see +.IR bind (2)) +on +.I mntpnt +otherwise on +.B /dev +(default). +.SS Console +.PP +Reading the +.BR cons +file returns characters typed on the console. Normally, characters +are buffered to enable erase and kill processing. A control-U, +.LR ^U , +typed at the keyboard +.I kills +the current input line (removes all +characters from the buffer of characters not yet read via cons), and a +backspace +.I erases +the previous non-kill, non-erase character from the +input buffer. Killing and erasing only delete characters back to, but +not including, the last newline. Characters typed at the keyboard +actually produce 16-bit runes (see +.IR utf (6)), +but the runes are translated into the variable-length +.SM UTF +encoding (see +.IR utf (6)) +before putting them into the buffer. A +.IR read (2) +of length greater than zero causes the process to wait until a newline +or a +.LR ^D +ends the buffer, and then returns as much of the buffer as the +argument to read allows, but only up to one complete line. A +terminating +.LR ^D +is not put into the buffer. If part of the line remains, the next +read will return bytes from that remainder and not part of any new +line that has been typed since. +.PP +If the string +.B rawon +has been written to the +.BR consctl +file and the file +is still open, +.BR cons +is in +.IR "raw mode" : +characters are not echoed as they are typed, +backspace, +.L ^U +and +.L ^D +are not treated specially, and characters are +available to read as soon as they are typed. Ordinary mode is +reentered when +.B rawoff +is written to +.BR consctl +or this file is closed. +.PP +A write (see +.IR read (2)) +to +.BR cons +causes the characters to be printed on the console screen. +.PP +When +.IR kbdfs (8) +gets a +.I consfile +passed as its last argument, it reads and processes the +characters from that file and forwards them to the +.BR cons +file with the same text processing applied as on keyboard input. +This is used on serial consoles. +.SS Keyboard +A read on the +.BR kbd +file returns a null terminated variable-length +.SM UTF +encoded string of all the keys that are currently pressed (key is +down) on the keyboard. This includes all keys that have a keyboard +mapping and modifier keys. No key is treated specially. A new event +is generated on each state change or at keyboard repeat rate and put +in a buffer. Each +.IR read (2) +will return a single event or block until there are new events +available. There always will be a null-byte at the end of the read +data, so when all keys are released (all keys are up), a single +null-byte will be returned. New pressed keys are appended to the +string at the end before the null-byte. Key releases remove the +character from the string. Change on modifier keys like +.B Shift +or +.B Num +will not change +the characters in the string of keys already pressed down, but take +effect on newly pressed keys. +.PP +Raw scancodes can be written to the +.BR kbin +file for external keyboard input (used for usb keyboards). +.SS "Keyboard map" +Scancodes are maped to Unicode characters with a number of +translation tables. These tables can be accessed with the +.BR kbmap +file. +.PP +Reads return the current contents of the map. +Each entry is one line containing three 11 character numeric fields, +each followed by a space: +a table number, an index into the table (scan code), and the decimal value +of the corresponding Unicode character (0 if none). +The table numbers are platform dependent; they typically distinguish +between unshifted and shifted keys. +The scan code values are hardware dependent and can vary +from keyboard to keyboard. +.PP +Writes to the file change the map. +Lines written to the file must contain three space-separated fields, +representing the table number, scan code index, and Unicode character. +Values are taken to be decimal unless they start with +.B 0x +(hexadecimal) or +.B 0 +(octal). +The Unicode character can also be represented as +.BI ' x +where +.I x +gives the UTF-8 representation of the character +(see +.IR utf (6)), +or as +.BI ^ X +to represent a control character. +.SH "SEE ALSO" +.IR cons (3), +.IR keyboard (6), +.IR utf (6), +.IR kbd (3) +.SH FILES +.B /dev/lib/kbmap/* +.SH SOURCE +.B /sys/src/cmd/aux/kbdfs.c diff --git a/sys/man/8/plan9.ini b/sys/man/8/plan9.ini index 7eef78466..fab498f30 100644 --- a/sys/man/8/plan9.ini +++ b/sys/man/8/plan9.ini @@ -5,7 +5,7 @@ plan9.ini \- configuration file for PCs .I none .SH DESCRIPTION When booting Plan 9 on a PC, the DOS program -.IR 9load (8) +.IR 9boot (8) first reads a DOS file containing configuration information from the boot disk. This file, @@ -70,15 +70,6 @@ Almost all cards can be automatically detected. For debugging purposes, automatic probing can be disabled by specifying the line .BR *noetherprobe= . -This automatic probing is only done by the kernel, not by -.IR 9load (8). -Thus, if you want to load a kernel over the Ethernet, you need -to specify an -.B ether0 -line so that -.I 9load -can find the Ethernet card, even if the kernel would -have automatically detected it. .PP Some cards are software configurable and do not require all options. Unspecified options default to the factory defaults. @@ -128,9 +119,6 @@ Can't boot through these due to enormous firmware loads. .B i82598 The Intel 8259[89] 10-Gigabit Ethernet PCI-Express controllers. Completely configurable. -Can't boot through these due to lack of a -.I 9load -driver. .TP .B i82557 Cards using the Intel 8255[789] Fast Ethernet PCI Bus LAN Controller such as the @@ -652,19 +640,6 @@ It is superseded by .B bootargs and .BR cfs . -.SS \fLpartition=value\fP -This defines the partition table -.IR 9load (8) -will examine to find disk partitioning information. -By default, a partition table in a Plan 9 partition -is consulted; if no such table is found, an old-Plan 9 -partition table on the next-to-last or last sector -of the disk is consulted. -A value of -.B new -consults only the first table, -.B old -only the second. .SS \fLfs=a.b.c.d\fP .SS \fLauth=a.b.c.d\fP These specify the IP address of the file and authentication server diff --git a/sys/man/8/prep b/sys/man/8/prep index 68f92a267..bf5b53816 100644 --- a/sys/man/8/prep +++ b/sys/man/8/prep @@ -132,10 +132,15 @@ A .IR cfs (4) file system cache. .TP -.B fossil +.B fscahe A -.IR fossil (4) -file system. +.IR cwfs (4) +worm cache partition. +.TP +.B fsworm +A +.IR cwfs (4) +worm filesystem. .TP .B fs A @@ -157,7 +162,7 @@ A one-sector partition used to simulate non-volatile RAM on PCs. .TP .B other A non-archived -.IR fossil (4) +.IR cwfs (4) file system. .TP .B swap @@ -583,13 +588,6 @@ listed are added, in order, to the root directory of the FAT file system. The files are contiguously allocated. -If a file is named -.BR 9load , -it will be created with the -.B SYSTEM -attribute set so that -.IR dossrv (4) -keeps it contiguous when modifying it. .PP .I Format checks for a number of common mistakes; in particular, @@ -623,15 +621,11 @@ It gets loaded by the BIOS at 0x7C00, reads the first sector of the root directory into address 0x7E00, and looks for a directory entry named -.BR 9LOAD . +.BR 9BOOTFAT . If it finds such an entry, it uses -single sector reads to load the file into address 0x10000 and then +single sector reads to load the file into address 0x7C00 and then jumps to the loaded file image. -The file -.B /386/pbslba -is similar, but because it uses LBA addressing (not supported -by older BIOSes), it can access more than the first 8.5GB of the disk. .PP .I Mbr installs a new boot block in sector 0 (the master boot record) @@ -652,7 +646,7 @@ partition and then executes the boot block for that partition. The partition boot block then loads a bootstrap program such as -.IR 9load (8), +.IR 9boot (8), which then loads the operating system. If MS-DOS or Windows 9[58] is already installed on your hard disk, the master boot record @@ -691,38 +685,15 @@ for(disk in /dev/sd??) { } .EE .PP -Create a Plan 9 boot floppy on a previously formatted diskette. -.IP -.EX -disk/format -b /386/pbs -df /dev/fd0disk \e - /386/9load /tmp/plan9.ini /386/9pcf.gz -.EE -.PP Initialize the blank hard disk .BR /dev/sdC0/data . .IP .EX disk/mbr -m /386/mbr /dev/sdC0/data disk/fdisk -baw /dev/sdC0/data -disk/prep -bw -a^(9fat nvram fossil cache swap) /dev/sdC0/plan9 -disk/format -b /386/pbslba -d -r 2 /dev/sdC0/9fat \e - /386/9load /386/9pcf /tmp/plan9.ini -.EE -.PP -Create a bootable USB disk or flash-memory device to be booted -via the BIOS and containing only a FAT Plan 9 partition. -.IP -.EX -mount /srv/usb /n/usb -ls -d /n/usb/sdU* # note the name, normally sdU0.0 -disk/partfs /n/usb/sdU0.0/data -cd /dev/sdXX -disk/mbr -m /386/mbr data -disk/fdisk -baw data -disk/prep -bw -a^(9fat nvram fossil) plan9 -cp /386/9loadusb /tmp/9load # force format to use the name `9load' -disk/format -b /386/pbslba -d -r 2 9fat /tmp/9load \e - /386/9pccpuf /tmp/plan9.ini +disk/prep -bw -a^(9fat nvram fscache fsworm other swap) /dev/sdC0/plan9 +disk/format -b /386/pbs -d -r 2 /dev/sdC0/9fat \e + /386/9bootfat /386/9pcf /tmp/plan9.ini .EE .SH FILES .TF /386/mbr.bootmgr @@ -746,7 +717,7 @@ compilable on (l)unix .IR floppy (3), .IR sd (3), .IR usb (4), -.IR 9load (8), +.IR 9boot (8), .IR partfs (8) .SH BUGS .I Format diff --git a/sys/man/8/update b/sys/man/8/update deleted file mode 100644 index 2519f213b..000000000 --- a/sys/man/8/update +++ /dev/null @@ -1,127 +0,0 @@ -.TH UPDATE 8 -.SH NAME -bootfloppy, bootplan9, bootwin9x, bootwinnt, personalize, setup.9fat, setup.disk, -setup.kfs, update \- administration for local file systems -.SH SYNOPSIS -.B pc/bootfloppy -.I floppydisk -.I plan9.ini -.br -.B pc/bootplan9 -.I /dev/sdXX -.br -.B pc/bootwin9x -.br -.B pc/bootwinnt -.br -.B pc/personalize -.br -.B pc/setup.9fat -.I /dev/sdXX/9fat -.I plan9.ini -.br -.B pc/setup.disk -.I /dev/sdXX -.I plan9.ini -.br -.B pc/update -.PD -.SH DESCRIPTION -These programs help maintain a file system on a local disk for a private machine. -.PP -.I Setup.disk -partitions a disk -and makes a new file system on the disk. -It then calls -.IR setup.9fat , -.IR update , -and -.I personalize -to initialize the file system. -.PP -.I Setup.9fat -formats the named -.I 9fat -partition, -installing -.BR /386/9load , -.BR /386/9pcdisk , -and the named -.I plan9.ini -file. -.PP -.I Update -copies the current kernel to the disk and updates -files on the local file system by copying them from the main file server -(named by the environment variable -.BR $fileserver ). -The files it updates are specified by the -.IR mkfs (8) -prototype file -.BR /sys/lib/sysconfig/proto/386proto . -.PP -.I Personalize -removes the contents of the -.B /usr -directory on the local disk and copies a minimal set of files for -the user who runs the command. -.PP -The boot scripts prepare various ways to bootstrap Plan 9. -.I Bootfloppy -creates a boot floppy containing -.BR 9load , -a zeroed 512-byte -.BR plan9.nvr , -and the named file as -.BR plan9.ini . -.I Bootplan9 -sets the -.B 9fat -partition to be the active partition, the one -used at boot time. -.I Bootwin9x -edits the files -.BR config.sys , -.BR msdos.sys , -and -.B autoexec.bat -on the drive mounted by -.B c: -to provide Plan 9 -as a boot menu option. -These system files are first backed up -as -.BR config.p9 , -.BR msdos.p9 , -and -.BR autoexec.p9 . -.I Bootwinnt -edits the Windows NT -boot loader menu contained in -the first FAT partition's -.I boot.ini -to provide Plan 9 -as an option. -It is first backed up as -.IR boot.p9 . -If backup files already exist, -.I bootwin9x -and -.I bootwinnt -do nothing. -.SH FILES -.TF /sys/lib/sysconfig/proto/ -.TP -.B /sys/lib/sysconfig/proto/ -.IR Mkfs (8) -prototype files. -.SH SOURCE -.B /rc/bin/pc/* -.SH "SEE ALSO" -.IR kfs (4), -.IR 9load (8), -.IR mkfs (8), -.IR prep (8), -.IR sd (3) -.br -``Installing the Plan 9 Distribution''. diff --git a/sys/man/mkfile b/sys/man/mkfile index 2a60a393c..3bb6aaa51 100644 --- a/sys/man/mkfile +++ b/sys/man/mkfile @@ -13,7 +13,7 @@ indices:V: $LIB/mksearchindex > searchindex # index for man2html searches permind:V: - rm -f /sys/lib/man/permind/toc + rm -f $LIB/permind/toc { echo .am TH echo .tm '\\$1' '\\$2' '\\n%' @@ -35,7 +35,7 @@ permind:V: } builtin cd .. } - } | troff -$MAN > /dev/null >[2] /sys/lib/man/permind/toc + } | troff -$MAN > /dev/null >[2] $LIB/permind/toc builtin cd $LIB/permind rm -f out mk out > /dev/null >[2] /dev/null @@ -116,6 +116,6 @@ print.out:V: permind ps2pdf $prereq $target clean:V: - rm -f man.out print.out searchindex $LIB/lookman/index [0-8]^/INDEX^('' .html) + rm -f man.out print.out searchindex $LIB/permind/toc $LIB/lookman/index [0-8]^/INDEX^('' .html) builtin cd $LIB/permind mk clean |