From owner-freebsd-doc@FreeBSD.ORG Tue Dec 29 20:46:17 2009 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id CBA05106566C; Tue, 29 Dec 2009 20:46:17 +0000 (UTC) (envelope-from dhillonv10@gmail.com) Received: from mail-fx0-f227.google.com (mail-fx0-f227.google.com [209.85.220.227]) by mx1.freebsd.org (Postfix) with ESMTP id 319DC8FC14; Tue, 29 Dec 2009 20:46:16 +0000 (UTC) Received: by fxm27 with SMTP id 27so11082596fxm.3 for ; Tue, 29 Dec 2009 12:46:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:received:in-reply-to:references :date:message-id:subject:from:to:cc:content-type :content-transfer-encoding; bh=cN82qz52XkZcMliivIT9Daa4esPIQCO7G7i8r/Ic95Y=; b=ifcMDB+DpKebdw79Yu8VaoTyGZqm35PBgBjK36MaptVwsu1o0loFUBVS1M90qg27nr lAlhsCpytUjuHUukrsIdBJWiqZTn0916UQhwX4MC0VOAf+VpEc+tcDJCcyCYVPNBr9bc Cwn8rkeI/G87zwOpStTjzZmyvutL41whP6ntQ= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type:content-transfer-encoding; b=Hr8ULA+0itzVn8eDzh0+o/d03UIdA+r2Y7zSR5bGjvZM81+6m1wPgxA8mXBidiAM7E +TCtx2bHvjLz5aYPirXk3zPlH7jyc89pjywMCZ1T5N3vW3B/AI+PZeTBNaVhFjQBfkBY 7wuOpGN3tjjz/orW4LeXez8iAVjt+FKMai314= MIME-Version: 1.0 Received: by 10.239.132.204 with SMTP id 12mr1852877hbs.208.1262119568950; Tue, 29 Dec 2009 12:46:08 -0800 (PST) In-Reply-To: <4B3A5AA4.1020507@FreeBSD.org> References: <200912281106.nBSB67UA078764@freefall.freebsd.org> <4B3A5AA4.1020507@FreeBSD.org> Date: Tue, 29 Dec 2009 15:46:08 -0500 Message-ID: From: Vikram Dhillon To: Doug Barton Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Cc: FreeBSD doc list , Gavin Atkinson Subject: Re: Current unassigned doc problem reports X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 29 Dec 2009 20:46:17 -0000 Thanks a lot, I'll get working on that then :D Regards, Vikram Dhillon ~~~ There are lots of Linux users who don't care how the kernel works, but only want to use it. That is a tribute to how good Linux is. -- Linus Torvalds On Tue, Dec 29, 2009 at 2:38 PM, Doug Barton wrote: > Vikram Dhillon wrote: >> Thanks a lot for getting back to me, I see that there are some >> problems that involve writing a man-page. I don't know how to do that, >> can you please point me to some links that can help me in doing so. > > There are example man page files in /usr/share/examples/mdoc. They > form a good basis to get you started. That's what I use whenever I > have to write one from scratch. Of course you can always read the > nroff and mdoc man pages, although they are pretty dense. There are > also a lot of good examples for "how do I do ?" in the man > pages in the base. In general it's better to avoid using the pages in > src/contrib as examples since they are not always "the state of the art." > > To check the output of the page you're writing, you do this: > nroff -mdoc example.1 | more > > After that it's basically a process of trial and error. :) =C2=A0We have > some people who are quite good with nroff/mdoc who are always glad to > help. > > Writing man pages is something that not a lot of people are willing to > tackle, so this is an area where help is particularly welcome. > > > Good luck, > > Doug > > -- > > =C2=A0 =C2=A0 =C2=A0 =C2=A0Improve the effectiveness of your Internet pre= sence with > =C2=A0 =C2=A0 =C2=A0 =C2=A0a domain name makeover! =C2=A0 =C2=A0http://Su= persetSolutions.com/ > >