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

[Guillaume ALAUX]

On 18 September 2010 23:40, Guillaume ALAUX <guillaume at alaux.net> wrote:
> 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
>

Denis,

Here is already an other version that is a bit more verbose. Please
correct it if I misunderstood some options.

BTW: "usage" says:
pacman-key -a | --add [<file>] ...                - add the key
contained in <file> (empty for stdin)")
But I guess it won't go without a file (I'm talking about the "stdin"
feature). So I removed it from the man. You may want to fix the usage
(or implement the feature :) )

I haven't actually tested it but command "--trust" sets the user on an
interactive gpg dialogue right? Then we should document this a bit and
maybe tell user to read "man gpg" if needed.

--
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, ie the keyring of GnuPG keys used to sign packages.
It enables to import, export and fetch keys from keyservers as well as update the key trust database.


Options
-------
*\--config* 'file'::
	Set an alternative configuration file to use (default is /etc/pacman.conf)

*\--gpgdir* 'directory'::
	Set an alternative home directory for GnuPG (default is set in /etc/pacman.conf)


Commands
-------
*-a*, *\--add* 'file ...'::
	Add the key(s) contained in 'file'(s) to pacman's keyring. If a key already exists, update it.

*\--adv* 'param ...'::
	Use this option to issue particular GnuPG actions to pacman's keyring. This option should be used with care as it can modify pacman's trust in packages' signatures.

*-d*, *\--del* 'keyid ...'::
	Remove the key(s) identified by 'keyid'(s) from pacman's keyring

*-e*, *\--export* ['keyid ...']::
	Export key(s) identified by 'keyid'(s) to STDOUT or all keys if no 'keyid' is specified

*-f*, *\--finger* ['keyid ...']::
	List fingerprint(s) for specified 'keyid'(s) or for all if none is specified

*\--help*::
	Displays this message

*-l*, *\--list*::
	List keys and signatures in pacman's keyring. Same as option \--list-sigs of GnuPG. See GnuPG's man pages for flag significations

*-r*, *\--receive* 'keyserver' 'keyid ...'::
	Fetch the 'keyid'(s) from the specified 'keyserver' URL

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

*-t*, *\--trust* 'keyid'::
	Set the trust level of the given key

*-u*, *\--updatedb*::
	Update the trustdb of pacman. Same as option \--check-trustdb of GnuPG.

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


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

include::footer.txt[]