[pacman-dev] [PATCH 1/5] pacman-key: keyring management tool

[Guillaume ALAUX]

On 18 September 2010 22:05, Guillaume ALAUX <guillaume at alaux.net> wrote:
> On 16 September 2010 17:58, Denis A. Altoé Falqueto
> <denisfalqueto at gmail.com> wrote:
>> On Thu, Sep 16, 2010 at 4:37 AM, Guillaume ALAUX
>> <guillaume at archlinux.org> wrote:
>>> Hi Denis, Hi everyone,
>>>
>>> I'm really pleased to see you're back on track.
>>
>> Hi and thanks for the support :)
>>
>>>> If any of the collaborators want to help, this is the time
>>> I would be glad to.
>>> I see you need help to write the man right? Is this the number one
>>> task? Because I could also help with some more technical things if
>>> needed.
>>>
>>> Just let me know.
>>
>> Yeah, right now the man page for pacman-key is the work that needs to
>> be done. The script is not very complex, but 1) English is not my
>> mother language and 2) I don't have lots of time. My wife is doing an
>> internship and my daughter is consuming almost all my free time. But
>> if you want to start a draft, I can surely help to develop it.
>>
>> If you want to discuss the script itself, you are also welcome. When
>> the developers start to comment on the other patches, you can also
>> help. Or you can start commenting on them right now. Don't be shy :)
>>
>> --
>> A: Because it obfuscates the reading.
>> Q: Why is top posting so bad?
>>
>> -------------------------------------------
>> Denis A. Altoe Falqueto
>> -------------------------------------------
>>
>>
>
> Denis,
>
> Silly question: what is the format for "source man pages" for pacman?
> Pacman man page has a comment saying it was generated by "DocBook XSL
> Stylesheets" but I can't find SGML (nor XML file). Are they plain
> text? AsciiDoc?
>
> --
> Guillaume
>

Here is a TXT version of the "usage" of pacman-key. Nothing more from
now on but that is a starter. Anyone willing to check my English or
add things is welcome. Footer.txt is the one from pacman/doc folder.

I may dig a bit further into the script to elaborate the man.

As I'm completely new to writing man pages, here is how I get HTML and
man page from this:

Generate HTML from TXT
	asciidoc pacman-key.8.txt

Generate XML from TXT
	asciidoc -b docbook -d manpage pacman-key.8.txt

Generate man from XML
	docbook2man pacman-key.8.xml

Let me know if that looks useful.
--
Guillaume
-------------- next part --------------
/////
vim:set ts=4 sw=4 syntax=asciidoc noet:
/////
pacman-key(8)
=============


Name
----
pacman-key - manage pacman's list of trusted keys


Synopsis
--------
'pacman-key' [options] command [arguments]


Description
-----------
The script pacman-key manage pacman's keyring. It imports, exports,
fetches from keyservers, helps in the process of trusting and updates the trust database.


Options
-------
*\--config*::
	Set an alternative configuration file to use.
	Default is /etc/pacman.conf

*\--gpg-dir*::
	Set an alternative home directory for GnuPG.
	Default is set in /etc/pacman.conf


Commands
-------
*-a, \--add [<file>] ...*::
	Add the key contained in <file> (empty for stdin)

*-d, \--del <keyid> ...*::
	Remove the key <keyid>

*-e, \--export <keyid> ...*::
	Output the key <keyid>

*-r, \--receive <keyserver> <keyid> ...*::
	Fetch the keyids from the specified keyserver URL

*-t, \--trust <keyid> ...*::
	Set the trust level of the given key

*-u, \--updatedb*::
	Update the trustdb of pacman

*\--reload*::
	Reloads the keys from the keyring package

*-l, \--list*::
	List keys

*-f, \--finger [<keyid]> ...*::
	List fingerprint for specified keyids (or for all, if none is specified

*\--adv <params>*::
	Use pacman's keyring as target for advanced commands

*-h, \--help*::
	Displays this message

*-v, \--version*::
	Displays the current version


See Also
--------
linkman:pacman.conf[5]

include::footer.txt[]