| Summary: | Manpage capitalization | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | shige2 <shige2> |
| Component: | Books & Articles | Assignee: | freebsd-doc (Nobody) <doc> |
| Status: | Closed FIXED | ||
| Severity: | Affects Only Me | ||
| Priority: | Normal | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
On Sun, Aug 08, 1999 at 12:46:34PM +0900, tomoShige Tashiro wrote: > > I found Capitalized function call 'Putc' in man 3 putc, > in Feb 1999 (docs/10247) and send-pr and fixed by Mr.hoek. They are illegal only when they bother someone... > About a half of manpages are written in 2. and 4. > and last half of manpages are written in 3. The _New_Hacker_Dictionary_ suggests moving function-names, etc. away from the beginning of sentences. I usually try to do this. In lue of that, I prefer writing "The gack() will return NULL on failure.". I appear to be alone in preferring this to "The gack() function will return NULL on failure.". > But I think, if it's not strange for native English speakers, > then thats O.K. and no need to fix them. I think we should leave the PR open for about a year (until September, 2000). If nobody has dealt with it by that time, then it should be closed ("state: filibustered" :-). -- This is my .signature which gets appended to the end of my messages. Responsible Changed From-To: freebsd-doc->mpp I'll deal with this mega PR. Responsible Changed From-To: mpp->freebsd-doc I'll probably never have the time to address this, and we have been slowly working over time to improve this situation, so a number of the cases in the original PR have probably already been fixed. State Changed From-To: open->closed This is a known issue, and is likely to be addressed globally in the near future. |
About manpage capitalization. I found Capitalized function call 'Putc' in man 3 putc, in Feb 1999 (docs/10247) and send-pr and fixed by Mr.hoek. So, I thought Capitalized systemcalls/functioncalls/commands are illigal, and it's OK to send-pr if I found. Then I checked up those Capitalized names, and I found a lot of these. Each manuals have each notation rules, 1. Command name is foo, and manual are all Foo (e.g. Perl, Bison, ...) 2. Command name is foo, and manual are all foo even when starting a sentence. 3. Capitalized. When starting a sentence. other case, not Capitalized. 4. "The" are added for to avoid Capitalization. About a half of manpages are written in 2. and 4. and last half of manpages are written in 3. but, man(7) shows rules Commands The syntax of the command and its arguments as would be typed on the command line. Words that have to be typed exactly as printed are to be presented in bold face. Arguments are indicated by the use of an ital- ic face. Arguments and command names so indicated should not be capitalized, even when starting a sen- tence. So, I confused. (^^; For me (as a Japanese, English is not mother language), Capitalized syscall/funcall/commands are little strange. But I think, if it's not strange for native English speakers, then thats O.K. and no need to fix them. So, It's not a request to fix, but I just tell there is a Capitalization in manpages. #It's difficult for me to make patch. sorry. Below lists are checked in May 1999. and It's not a perfect report. Thanks. ---- ---- ---- Confused notation in manpage. fetch flex groff hexdump dummynet(4) isdntrace(8) Manpages written by rule 3. man1 a2p basename biff btreeop cal calendar cap_mkdb catman cdcontrol checknr chkey chpass col colcrt colldef colrm column comm compile_et compress cpp crontab crunchgen crunchide csh ctags ctm date dc df dialog dig dirname dnsquery domainname doscmd du ed ee egrep enigma env error ex expand f2c false fdformat fdwrite fetch fgrep file find finger flex fmt fold fontedit fpr from fsplit fstat gcore gctags gdbserver getopt global gprof grep groff gtags gzip hexdump host hostname htags idprio indent ipcrm jot key keyinfo keyinit keylogin keylogout kill killall lam last lastcomm leave limits lock logger login look lorder lp lpq lpr lprm lptest mail mailq make man md5 minigzip mkdep mkdir mkstr mktemp more mset msgs mt newaliases nex nice nohup pagesize passwd patch pax pic printenv printf ps pwd quota rcp rdist rlogin rpcgen rs rsh rtprio rup ruptime s2p script sed sh sleep soelim startslip su systat talk tar tconv tcopy tcpdump tcpslice tftp tip tn3270 top troff true truss tset tsort tty ul uncompress unexpand unifdef unvis users uudecode uuencode vacation vgrind vi view vis vt220keys vttest wall which whois window write xstr xten yacc yes ypcat ypmatch ypwhich zcmp zmore znew man1aout ranlib size strings strip man2 access acct adjtime bind brk chdir chflags chmod chown chroot close creat dup execve fchdir fchflags fchmod fchown fcntl flock fork fpathconf fstat fstatfs fsync ftruncate getdirentries getfh getfsstat getgroups getitimer getpeername getpid getppid getpriority getrlimit getrusage getsockname getsockopt ioctl kill killpg ktrace lchown link listen lseek lstat mkdir mkfifo mknod mlock mmap mount munlock munmap nanosleep pathconf poll pread pwrite read readlink readv reboot recv recvfrom rename rfork rmdir select semctl semget semop send sendfile setgroups setlogin setpgid setpgrp shmat shmctl shmdt shmget sigaction sigaltstack sigblock sigpause sigreturn sigsetmask sigsuspend sigvec socket stat statfs swapon sync sysarch syscall truncate utimes vfork wait write writev man3 ascftime asprintf bindresvport calendar cftime cgetent com_err dbopen exec execl exect exit forkpty getdomainname gethostid gethostname getpagesize hash heapsort inet inet_addr libdisk login_tty logout mergesort mktime mpool openpty pause printf qsort readline regcomp regerror regex regexec regfree rune setdomainname sethostid sethostname setnetgrent signal snprintf sprintf strunvis tempnam unvis valloc man4 dummynet intro ipfirewall matcd sysmouse tw yp man5 disktab printcap vgrindefs man6 arithmetic atc banner battlestar caesar cribbage factor fish grdc hack larn mille phantasia piano quiz random robots rogue sail snake trek man7 hostname mailaddr man8 ac adduser adjkerntz amd amq apm apmconf atmarpd atrun bad144 badsect bootparamd bootpd bootpgw ccdconfig chkgrp chkprintcap chown clri comcontrol comsat config cron dhclient disklabel diskpart dm dmesg dump dumpfs dumpon edquota fdcontrol fdisk fingerd fsck fsdb fsirand ft ftpd ifconfig init iostat isdnd isdntrace kernbb keyadmin keyserv kgmon kvm_mkdb ldconfig loader locate.updatedb lpc lpd lptcontrol mail.local makekey manctl map-mbone mknetid mount_mfs mount_null mount_std mount_umap mountd mrinfo mrouted mtrace named-xfer named natd newfs newkey newsyslog nextboot nfsd nfsiod nologin nos-tun nslookup ntpdate ntpq ntptrace pac pccardd ping portmap pppctl pppd procctl pstat pw pwd_mkdb quot quotacheck quotaoff quotaon rarpd rbootd rc renice repquota restore revnetgroup rexecd rlogind rmail rmt rmuser rndcontrol route routed rpc.lockd rpc.rquotad rpc.rstatd rpc.rusersd rpc.rwalld rpc.sprayd rpc.statd rpc.yppasswdd rpcinfo rshd rtquery rwhod sa savecore scspd sendmail showmount shutdown sicontrol slattach sliplogin spkrtest spray stlload stlstats strfile swapon sync sysctl talkd telnetd tftpd timed timedc traceroute trpt tunefs uucpd vipw vmstat watch wormcontrol xntpd xntpdc xtend yp_mkdb ypbind ypinit yppoll yppush ypset ypxfr zdump zic zzz man9 asleep await sleep tsleep Fix: Each manpage fix will take little work though... How-To-Repeat: man *