Hi all, I've taken a new leadership role on man pages. I have some man page updates for you (bugs, legal, guidelines) and I want to open a discussion about objectives related to man pages (collaboration).
BUGS So far, we've been focused internally on fixing man page bugs submitted by the community. We've fixed 6 more since June, as follows: 6465629 section3c 4 Defect solaris manpage solaris_ne 10-Fix Delivered 08/30/2006 snv_48 man page incorrectly reports return 6306499 section1m 5 RFE solaris manpage solaris_ne 10-Fix Delivered 08/04/2005 snv_22 SMF man pages should mention differ 6287765 section7d 5 Defect solaris manpage solaris_ne 10-Fix Delivered 06/19/2005 snv_43 "Black On White" and "White on Blac 6449146 section1 4 Defect solaris manpage solaris_ne 10-Fix Delivered 07/14/2006 snv_45 cmp command synopsis does not 6454441 section1 3 Defect solaris manpage solaris_ne 10-Fix Delivered 07/30/2006 snv_46 du option merge manpage sync 6460197 section1m 5 Defect solaris manpage solaris_ne 10-Fix Delivered 08/15/2006 snv_48 dtrace(1M) does not document -h swi Many thanks to the community members who took time to file these bugs, and to Sun writers for delivering the fixes. I don't have the names off-hand, so we'll capture and publish these in the next newsletter. We'll start to publish these fixes more frequently on docs-discuss going forward, so you can get a better sense of the changes happening. All fixes before June are reflected in the program list of bugs fixed, so the list above should be added to the program list as appropriate. LEGAL We've also been doing the legal preparation of our man page source files for delivery to OpenSolaris. I reported to p-team two weeks back that we were 30% complete with this preparation overall. In detail, this means we have phase1 preparations underway for all ~6,000 man page files that exist, we have phase2 preparations underway for ~1,700 man page files, and we have final preparations completed and approvals for 373 man page files. I've added below the list of the 373 files for those who are interested. I expect the files in the list below to be released first, through the man page consolidation, with follow-on releases of the remaining man page files as they are completed and approved. We will start with tarball releases just like ON did and follow ON's lead on migration of the man page gate from SCCS/Teamware to Mercurial (hg). GUIDELINES Internally, we use some very simple guidelines to help writers know what each section of a man page should include, these have been posted at the following URL as a reference: http://opensolaris.org/os/community/documentation/doc_collab/manpageguide/ COLLABORATION I assume from the baseline requirements gathering for the books that the following requirements for man page collaboration exist: -use freely available tools -can be updated with vi or emacs -use standard templates Are there other/different requirements that should drive our decision-making as we move forward? What is most important to you with regard to man page collaboration as a developer/quality engineer/sysadmin/writer/enthusiast? Regards, Michelle Exacct.3perl FSS.7 Kstat.3perl NIS+LDAPmapping.4 Privilege.3perl Project.3perl TIMEZONE.4 Task.3perl Ucred.3perl acctadm.1m add_drv.1m admin.4 allocate.1 ar.h.3head asswd.1 attributes.5 audit.1m auditconfig.1m auditd.1m audit.log.4 auditon.2 auditreduce.1m audit_syslog.5 audit_warn.1m autofs.4 automount.1m automountd.1m bart.1m boot.1m bootadm.1m bsmconv.1m cdrw.1 cfgadm.1m cfgadm_fp.1m cmn_err.9f consadm.1m contract.4 core.4 coreadm.1m cron.1m cryptoadm.1m ct_ctl_adopt.3contract ct_event_read.3contracT ctfs.7fs ct_pr_event_get_pid.3contract ct_pr_tmpl_set_transfer.3contract ctstat.1 ct_status_get_param.3contract ct_status_read.3contract ct_tmpl_activate.3contract cvcd.1m dcs.1m ddi_cred.9f ddi_dma_addr_bind_handle.9f ddi_dma_buf_bind_handle.9f ddi_dma_req.9s deallocate.1 devfsadm.1m device_clean.5 dhcpconfig.1m dig.1m dispadmin.1m dnssec-keygen.1m dnssec-makekeyset.1m dnssec-signkey.1m dnssec-signzone.1m domainname.1m dtrace.1m dtrace.7d dumpadm.1m ea_error.3exacct ea_open.3exacct ea_pack_object.3exacct ea_set_item.3exacct eeprom.1m efdaemon.1m environ.5 fasttrap.7d fbt.7d filesystem.5 flar.1m flarcreate.1m fmadm.1m fmd.1m fmdump.1m fmstat.1m format.dat.4 fp.7d fsstat.1m ftpaccess.4 ftpconfig.1m getacct.2 getaddrinfo.3socket getdevpolicy.1m getloadavg.3c getprojent.3project getsockopt.3socket getzoneid.3c gssd.1m halt.1m host.1m ifconfig.1m if_tcp.7p in.chargend.1m in.comsat.1m in.daytimed.1m in.dhcpd.1m in.discardd.1m in.echod.1m inetadm.1m inetconv.1m inetd.1m inetd.conf.4 in.fingerd.1m in.ftpd.1m init.1m init.d.4 inittab.4 in.lpd.1m in.rarpd.1m in.rexecd.1m in.rlogind.1m in.rshd.1m installf.1m in.talkd.1m in.telnetd.1m in.tftpd.1m in.timed.1m in.tnamed.1m intrd.1m intrstat.1m in.uucpd.1m iostat.1m ip6.7p ip.7p ipsecconf.1m isdnio.7i kadmind.1m kbd.1 kdestroy.1 kernel.1m keyserv.1m kinit.1 klist.1 kpasswd.1 kprop.1m kpropd.1m krb5kdc.1m ksslcfg.1m ktkt_warnd.1m ktutil.1 lastcomm.1 ldap_cachemgr.1m libc.3lib libcontract.3lib libdtrace.3lib libm.3lib libpool.3lib libscf.3lib libsys.3lib libtsol.3lib list_devices.1 live_upgrade.5 localeadm.1m lockd.1m lockstat.1m lockstat.7d logadm.1m login.1 lpsched.1m luupgrade.1m mail.local.1m makeuuid.1m mdmonitord.1m metaroot.1m metasync.1m mount.2 mpstat.1m named.1m named-checkconf.1m named-checkzone.1m netstat.1m newtask.1 nfs4cbd.1m nfsd.1m nfsmapid.1m nisaddent.1m nis_cachemgr.1m nispasswd.1 nisrestore.1m nissetup.1m nscd.1m nslookup.1m nsupdate.1m ocfserv.1m oplhpd.1m patchadd.1m patchrm.1m pcfs.7fs pgrep.1 picld.1m pkgadd.1m pkgadm.1m pkgask.1m pkgchk.1m pkginfo.4 pkgrm.1m plockstat.1m pmconfig.1m p_online.2 pooladm.1m poolbind.1m poolcfg.1m poold.1m poolstat.1m ppriv.1 pprosetup.1m prctl.1 priocntl.1 priocntl.2 priv_addset.3c privileges.5 priv_set.3c priv_str_to_set.3c proc.1 proc.4 process.4 processor_bind.2 processor_info.2 prodreg.1m profile.7d projadd.1m projdel.1m projects.1 project_walk.3project projmod.1m prstat.1m pset_bind.2 pset_create.2 pset_getloadavg.3c pset_info.2 pset_list.2 pset_setattr.2 ptree.1 rcapadm.1m rcapd.1m rcapstat.1 rctladm.1m rem_drv.1m removef.1m resource_controls.5 rndc.1m rndc.conf.4 rndc-confgen.1m routeadm.1m rpcbind.1m rpc.bootparamd.1m rpc.mdcommd.1m rpc.metad.1m rpc.metamedd.1m rpc.metamhd.1m rpc.nisd.1m rpc.nispasswdd.1m rpc.rexd.1m rpc.rstatd.1m rpc.rusersd.1m rpc.rwalld.1m rpc.smserverd.1m rpc.sprayd.1m rpc.yppasswdd.1m rquotad.1m rtc.1m sar.1 sar.1m savecore.1m scp.1 scf_entry_create.3scf scf_error.3scf scf_handle_create.3scf scf_handle_decode_fmri.3scf scf_instance_create.3scf scf_iter_create.3scf scf_limit.3scf scf_pg_create.3scf scf_property_create.3scf scf_scope_create.3scf scf_service_create.3scf scf_simple_prop_get.3scf scf_simple_walk_instances.3scf scf_snaplevel_create.3scf scf_snapshot_create.3scf scf_transaction_create.3scf scf_value_create.3scf sdt.7d sendmail.1m service_bundle.4 setproject.3project setrctl.2 settaskid.2 sf880drd.1m sftp.1 sftp-server.1m showrev.1m siginfo.h.3head slpd.1m smcron.1m smdiskless.1m smf.5 smf_bootstrap.5 smf_enable_instance.3scf smf_method.5 smf_restarter.5 smf_security.5 snmptrapd.1m ssh-add.1 ssh-agent.1 ssh-keygen.1 ssh.1 sshd.1m statd.1m svcadm.1m svccfg.1m svcprop.1 svcs.1 svc.startd.1m syseventadm.1m syseventconfd.1m syseventd.1m sysidcfg.4 sysidconfig.1m sysidtool.1m syslogd.1m systrace.7d sys-unconfig.1m tcp.7p timezone.4 traceroute.1m ttymon.1m tzselect.1m ucred_get.3c umem_alloc.3malloc umem_cache_create.3malloc umem_debug.3malloc umount.2 update_drv.1m useradd.1m userdel.1m usermod.1m utmpd.1m vmstat.1m vntsd.1m vold.1m volfs.7fs warn.conf.4 watchmalloc.3malloc wracct.1m xntpd.1m ypbind.1m ypinit.1m ypserv.1m zcons.7d zdb.1m zdump.1m zfs.1m zic.1m zlogin.1 zoneadm.1m zoneadmd.1m zonecfg.1m zoneinfo.4 zonename.1 zones.5 zpool.1m This message posted from opensolaris.org
