Commit Graph

58 Commits

Author SHA1 Message Date
Kay Sievers
7b86ada7d4 all man pages rewritten to use DocBook XML
Signed-off-by: Kay Sievers <kay.sievers@suse.de>
2005-08-30 23:30:52 +02:00
Kay Sievers
420a506ef0 write man page masters in DocBook XML
The troff man pages will still be checked into the tree but the
source is DocBook XML format living in the docs/ directory now.
Start with the easy ones, the main udev page is still left to
rewrite.

Signed-off-by: Kay Sievers <kay.sievers@suse.de>
2005-08-30 04:41:42 +02:00
greg@kroah.com
438ac360e8 [PATCH] first step of making man pages dynamically generated.
Based on a an original patch from Olaf Hering <olh@suse.de>
2005-04-26 21:35:14 -07:00
kay.sievers@vrfy.org
fc238cffaf [PATCH] put netdev handling and dev.d/ in manpages
Mention the recently added netdev handling and the dev.d/ directories
in the man pages.
2005-04-26 21:35:14 -07:00
tytso@mit.edu
c58286656e [PATCH] Trivial man page typo fixes to udev
Fix minor man page typo's.
2005-04-26 21:35:10 -07:00
kay.sievers@vrfy.org
558f80ba64 [PATCH] callout part selector tweak
Martin Schwenke <martin@meltin.net> asked for this feature and posted a
patch:

 The following patch almost let's me have the following configuration:

  PROGRAM="/sbin/aliaser %b %k %n %M %m", RESULT="?*", NAME="%c{1}", SYMLINK="%c{2+}"

 allowing me to specify an arbitrary number of symlinks by saying
 "giveme the second and later words"."


Here is the actual version with tests and a few words in the man page.
2005-04-26 21:35:09 -07:00
kay.sievers@vrfy.org
e41016d354 [PATCH] allow to specify node permissions in the rule
This allows to set the permissions along with the rule.

This is not a general replacement for the permissions config, but it
may be easier sometimes for the user to specify the permissions along
with the rule, cause the permissions config file wants the final node
name to match, which seems sometimes a bit difficult to guess, if
format % chars are used in the NAME field.

Any value not given in the rule is still be read from the permissions
file or set to the default. This one will also work:

  BUS="usb", KERNEL="video*", NAME="my-%k", OWNER="$local"

A few words to man page are also added and add_perm_dev() is moved into
namedev_parse.c where it belongs to.
2005-04-26 21:35:09 -07:00
kay.sievers@vrfy.org
b86f56ff09 [PATCH] man page beauty
Thanks to Christian Gierke, he sent me a beauty patch for our man pages.
Some typos are fixed and a few word are clarified.
2005-04-26 21:35:08 -07:00
kay.sievers@vrfy.org
2bd07cf29b [PATCH] put symlink only rules to the man page
Here we mention the "symlink only - add it to another rule" feature
to the man page. Andrey, does this describe what you have implemented :)
2005-04-26 21:35:08 -07:00
kay.sievers@vrfy.org
d5f91372dd [PATCH] conditional remove of trailing sysfs whitespace
Hey, it may never happen, that one wants to distinguish attributes by
trailing spaces, but we should not lose the control over it, just for
being lazy :)

Here we remove the trailing spaces of the sysfs attribute only if the
configured value to match doesn't have any trailing spaces by itself.
So if you put a attribute in a rule with spaces at the end, the sysfs
attribute _must_ match exactly.

Is that cool for everyone?

As usual, 2 tests are added for it with a artificial sysfs file and
a few words to the man page.
2005-04-26 21:35:08 -07:00
hannal@us.ibm.com
a3fa7908e2 [PATCH] Small fix to remove extra "will" in man page
remove extraneous word.
2005-04-26 21:35:08 -07:00
rml@ximian.com
a6f01502bd [PATCH] update documetation for $local
On Mon, 2004-03-01 at 17:44, Greg KH wrote:
> Hm, that should be Robert's job actually, he should do something for
> real...  :)

Hey, I wrote the nifty local user detection snippet - but, I owe Kay, so
here is an updated man page.
2005-04-26 21:35:06 -07:00
kay.sievers@vrfy.org
311e9ae681 [PATCH] udev - man page update
Here is a small change to the udev man page:

  - clarify the use of the NAME{all_partitions} syntax
    and add a example to udev.rules.example
  - mention the empty NAME field to ignore the device
  - prepare a SYMLINK field for the addition of Andrey's
    "multiple symlinks" documentation :)
2005-04-26 21:35:06 -07:00
md@Linux.IT
758f236fd1 [PATCH] escape dashes in man pages
man-dashes.diff: escape dashes in man pages, helps with UTF-8 locales
(by Philipp Matthias Hahn).
2005-04-26 21:35:06 -07:00
kay.sievers@vrfy.org
63ead27c22 [PATCH] udev - activate formt length attribute
We carried the the old callout part selector syntax for two releases
now after it was replaced by the new %c{1} syntax. So here we remove
the old syntax and use the code to possibly specify the maximum count
of chars to insert into the string. It will work with all of our format
chars.
I don't know if somebody will use it, but the code is already there :)

's%3s{vendor}' returns "IBM" now, instead of "IBM-ESXS".

Also added is a test for it and a few words in the man page.
2005-04-26 21:34:29 -07:00
greg@kroah.com
dde05ccb8d [PATCH] remove limit of the number of args passed to PROGRAM
If we go over our internal limit of 7, then we call out to /bin/sh
otherwise we handle it ourself without relying on a shell.
2005-04-26 21:32:31 -07:00
kay.sievers@vrfy.org
bef370d6eb [PATCH] udev - man page update
Hey it's not longer the "goal" to provide a dynamic dev directory,
we have just arrived. So I  change it to more self-confident words :)

I've also added the completly missing environment variables to the
man pages.

To stop the misuse of the PROGRAM= call paramenters, we better mention
its limitations.
2005-04-26 21:32:30 -07:00
kay.sievers@vrfy.org
167a27e70f [PATCH] manpage update
Nice, here is the corresponding man update which also removes the
mention of the limitation of getgrname() and friends with klibc.
2005-04-26 21:32:30 -07:00
kay.sievers@vrfy.org
ad63031e49 [PATCH] udev - add %s{filename} to man page
Add the new %s{filename} to the udev man page.
And add the automatic start of udevd to the udevd man page.
2005-04-26 21:32:28 -07:00
kay.sievers@vrfy.org
16378373cb [PATCH] udev - switch SYSFS_file to SYSFS{file}
Here we switch the configs and man pages to the new attribute syntax.
Also the 'partition trick' is mentioned in udev.8

I think it's more clear visible now, that inside the brackets are user
supplied values used and not some magic keys handled:

  'SYSFS_dev' is now 'SYSFS{dev}'

The old syntax is still supported.
2005-04-26 21:32:28 -07:00
greg@kroah.com
0c040e8d7c [PATCH] add udev_log to the documentation. 2005-04-26 21:32:27 -07:00
greg@kroah.com
05c0c9da0b [PATCH] remove command line documentation from udev man page 2005-04-26 21:13:19 -07:00
kay.sievers@vrfy.org
765cbd9759 [PATCH] set default owner/group in db - update
I've edited the man page today, so this is alreay included :)

Also a few more trivials:
  o added the defaults to udev.conf.in
  o removed class_dev from get_default_mode(), to match with Hanna's
  o changed size of mode_str to MODE_SIZE
  o changed a few char compares from from 0x00 to '\0'
2005-04-26 21:13:17 -07:00
kay.sievers@vrfy.org
b2a21a3547 [PATCH] udev - reverse user query options
Here we get the ability to query with the name of the node instead of
the device path. It uses a linear search over the whole database.

  kay@pim:~/src/udev.kay$ ./udev -q path -n video/webcam0
  /class/video4linux/video0


New version, with better function return codes for error handling.
2005-04-26 21:13:17 -07:00
greg@kroah.com
18f0045bc8 [PATCH] remove the %D modifier as it is not longer needed. 2005-04-26 21:13:16 -07:00
kay.sievers@vrfy.org
b6864b4bf1 [PATCH] udev - mention format string escape char in man page
If we want to pass any '%' down to a program, you need to ecape it by '%%',
otherwise we try to expand it with our own format char list.
2005-04-26 21:13:16 -07:00
kay.sievers@vrfy.org
e68faf511d [PATCH] udev - more CALLOUT is PROGRAM now
On Tue, Jan 13, 2004 at 02:45:17AM +0100, Kay Sievers wrote:
> replace CALLOUT by PROGRAM and fix old rule format

One is missing.
2005-04-26 21:13:16 -07:00
greg@kroah.com
2ebcaa235f [PATCH] fix -d typo in the manpage update 2005-04-26 21:13:15 -07:00
kay.sievers@vrfy.org
4bd46ac7e5 [PATCH] update documentation for new config file format
Here is the man page update after my udev-weekend :)
2005-04-26 21:13:15 -07:00
christophe@saout.de
f1db055ab2 [PATCH] add IGNORE rule type
On Wed, Dec 31, 2003 at 11:24:53AM -0800, Greg KH wrote:

> > There should be a possibility to tell udev not to create a device node.
> >
> > device-mapper: Usually set up by libdevmapper (or EVMS tools) which
> > creates the device node on its own under /dev/mapper/<name>.
> >
> > With udev a second device is created named /dev/dm-<minor> which is not
> > really needed.
>
> Good point.  Ok, I'll agree with you.  Care to make up a patch for this
> kind of feature?

Yes, I can try.

There was no way to tell not to do anything so I created one. Errors
are signalled via negative return values, so I thought that a positive,
non-zero one could mean to ignore the device. I don't like it but
perhaps you have a better solution.
2005-04-26 21:13:14 -07:00
kay.sievers@vrfy.org
4070d2fea0 [PATCH] mention user callable udev + options in man page
As usual, here is the corresponding man page update and
a small text correction.
2005-04-26 21:13:12 -07:00
kay.sievers@vrfy.org
e15b5ed5de [PATCH] small trivial cleanup of latest changes
here is a patch for a typo in the man page, a whitespace cleanup
and a replace for the magic hex ASCII in char operations.
2005-04-26 21:13:11 -07:00
greg@kroah.com
2b8b644177 [PATCH] add documentation about the BUS key being optional for the LABEL rule. 2005-04-26 21:13:11 -07:00
greg@kroah.com
a38401d3e8 [PATCH] add documentation about the BUS key being optional for the CALLOUT rule. 2005-04-26 21:13:11 -07:00
greg@kroah.com
170ae44e7d [PATCH] add documentation for the new '%k' modifier (kernel name replacement) 2005-04-26 21:13:10 -07:00
greg@kroah.com
aa9c2a1e25 [PATCH] add documentation about the multiple sysfs values that are now allowed for the LABEL rule. 2005-04-26 21:13:10 -07:00
kay.sievers@vrfy.org
4868e8fba7 [PATCH] trivial cleanup parser changes
o use defines in debug strings
  o replace my 'xxx' debug :)
  o shorten line in man page example to not to exceed 80 chars when printed
2005-04-26 21:13:09 -07:00
greg@kroah.com
3c54f73e84 [PATCH] some cleanups due to the need for LABEL rules to use "SYSFS_" now. 2005-04-26 21:13:08 -07:00
kay.sievers@vrfy.org
d94df23242 [PATCH] don't rely on field order in namedev_parse
o change the parsing to get a key from the rule and sort it
    into our list of known keys instead of expecting a special order
  o the key to match a sysfs file must be prependend by 'SYSFS_' now
    to match with the new parsing.
    (The config must be changed, but it's a bit more descriptive too.)
  o put names of fields in define's, like the name of the methods
  o update all tests and the man page
2005-04-26 21:13:08 -07:00
greg@kroah.com
525d07e78e [PATCH] change devfs disk name rule from 'disk' to 'disc' 2005-04-26 21:13:07 -07:00
kay.sievers@vrfy.org
26004fcc66 [PATCH] man-page mention multiple symlinks
As usual, when the stuff gets in the tree - here is a small
man page update and a TODO line removal.

  mention multiple symlinks
  update example with silly symlink rule :)
  shorten example line to have less than 80 chars
  remove "want symlink support" from TODO
2005-04-26 21:13:07 -07:00
kay.sievers@vrfy.org
c6c13c3181 [PATCH] cleanup man & remove symlink comment
remove "want symlinks" text from udev-add.c
  mention SYMLINK in man page
  man page format cleanup
  man page example for SYMLINK
2005-04-26 21:13:06 -07:00
kay.sievers@vrfy.org
83fa40fc2a [PATCH] man page beauty
I've never seen any project where the documentation is in sync with the
code at this early stage. Nice! So here is the patch to make it extra perfect :)

  remove random indent to be consistent
  style is "shell style"
  s/wildcard/pattern/
  mention negation char in character class
2005-04-26 21:13:06 -07:00
greg@kroah.com
fc1f0d4326 [PATCH] Added Kay's name to the man page. 2005-04-26 21:13:05 -07:00
greg@kroah.com
07d7cfd1fa [PATCH] update the wildcard documentation in the man page to show the new styles supported. 2005-04-26 21:13:05 -07:00
greg@kroah.com
4865de4429 [PATCH] Update the man page to show the new config file, it's format, and how to use it.
wow, update the docs to keep in line with reality, what a concept...
2005-04-26 21:13:05 -07:00
greg@kroah.com
36043f8418 [PATCH] add test and documentation for new %D devfs format modifier 2005-04-26 21:13:04 -07:00
kay.sievers@vrfy.org
5b8ba50aa2 [PATCH] udev.8 tweak numeric id text
04-udev.8-tweak-numeric-id-text.diff
  o change "return value" to "returned string"
  o add textual owner/group example for udev.permissions
  o mention klibc compile as special case for udev.permissions
  o remove duplicated numeric owner clause
2005-04-26 21:13:04 -07:00
greg@kroah.com
67922099bf [PATCH] updated the man page with the latest format specifier changes. 2005-04-26 21:13:02 -07:00
kay.sievers@vrfy.org
cb08e0f253 [PATCH] namedev.c - change order of fields in CALLOUT
I want to bring the CALLOUT field ordering in line with the other
methods, cause the current parsing relies on the ordering it's good
to have it like the others. The BUS= is now the first expected field.

Also made the last two remaining field names to uppercase and the man page
callout example is updated.
2005-04-26 21:06:25 -07:00