devinfo: devinfo(1) manual page.
Signed-off-by: Davidlohr Bueso <dave@xxxxxxx>
---
misc-utils/devinfo.1 | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 110 insertions(+), 0 deletions(-)
create mode 100644 misc-utils/devinfo.1
diff --git a/misc-utils/devinfo.1 b/misc-utils/devinfo.1
new file mode 100644
index 0000000..10151fd
--- /dev/null
+++ b/misc-utils/devinfo.1
@@ -0,0 +1,110 @@
+.\" Copyright 2010 Davidlohr Bueso <dave@xxxxxxx>
+.\"
+.\" This man page was created for devinfo.
+.\"
+.\" This file may be copied under the terms of the GNU Public License.
+.\"
+.\" Based on blkid, 2000, Andreas Dilger
+.TH DEVINFO 1 "September 2010" "Linux"
+.SH NAME
+devinfo \- command\-line GNU/Linux device information helper
+.SH SYNOPSIS
+.B devinfo
+.RB \-d
+.IR device " | "
+.IR device
+
+.B devinfo
+.RB [ \-cb ]
+
+.SH DESCRIPTION
+The
+.B devinfo
+program is a GNU/Linux device information helper. It aims at being
+quick and simple to use while getting valuable data. It
+reads information about the device(s) on a GNU/Linux machine, thus
+aiding the user to find relevant information.
+
+It relies on both proc and sys filesystems to gather data, hence
+this program does not read information directly from the hardware,
+but uses the kernel's interpretation of it.
+Because of this,
+.B devinfo
+is not device dependent, so the user can obtain
+information regarding any devices, both block (CDROM, Hard Drives, etc.)
+and character (input, video, etc.).
+.PP
+.B devinfo
+has two main forms of operation: either entering a specific device, or listing all the block/character devices on the system.
+.TP
+.BI \-d " device"
+Specify a specific device of interest to get information of it. Usually it will be under the /dev directory, ie: /dev/sda.
+This option can be ommited, and simply pass the device name, since it's a quicker, more intuitive, way of working. Therefore
+the following are identical:
+.sp
+devinfo /dev/null
+
+devinfo -d /dev/null
+.TP
+.B \-c
+List all the character devices that are on the machine. It reads from /sys/dev/char and /proc/devices.
+.TP
+.B \-b
+List all the block devices that are on the machine. It reads from /sys/dev/block and /proc/devices.
+
+\" .SH "EXAMPLES"
+\" $
+\" .B devinfo
+\" /dev/null
+\" .TP 7
+\" Character device: `null' (1:3) Class: mem Access: crw-rw-rw-
+
+
+
+.SH "FILE"
+.TP
+.B /proc/devices
+.TP
+.B /sys/dev/{char,block}/[major:minor]/uname
+.TP
+.B /sys/dev/{char,block}/[major:minor]/device/uname
+.TP
+.B /sys/dev/{char,block}/[major:minor]/removable
+.TP
+.B /sys/dev/{char,block}/[major:minor]/device/removable
+.TP
+.B /sys/dev/{char,block}/[major:minor]/version
+.TP
+.B /sys/dev/{char,block}/[major:minor]/device/version
+.TP
+.B /sys/dev/{char,block}/[major:minor]/model
+.TP
+.B /sys/dev/{char,block}/[major:minor]/device/model
+.TP
+.B /sys/dev/{char,block}/[major:minor]/vendor
+.TP
+.B /sys/dev/{char,block}/[major:minor]/device/vendor
+.TP
+.B /sys/dev/{char,block}/[major:minor]/removable
+.TP
+.B /sys/dev/{char,block}/[major:minor]/device/removable
+
+.SH BUGS
+Because
+.B devinfo
+uses the files in sysfs and procfs extensively, it relies on the proper formating and writing
+of these files by the kernel. The more information device writers export to userspace, the more this program can benefit. If any interface of either procfs or sysfs is broken, unexpected behavior can be expected in this program. Bug reports and constructive criticisms are welcome.
+
+.SH AUTHOR
+.B devinfo
+was written by Davidlohr Bueso <dave@xxxxxxx>
+.SH AVAILABILITY
+The
+.B devinfo
+command is part of the util-linux-ng package and is available from
+ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.
+.SH "SEE ALSO"
+.BR proc (5)
+.BR stat (1)
+.BR dmesg (1)
+.BR fdisk (8)
--
1.7.0.4
--
To unsubscribe from this list: send the line "unsubscribe util-linux-ng" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
