All of lore.kernel.org
 help / color / mirror / Atom feed
* Man page lsfd(1)
@ 2021-09-22 17:37 Mario Blättermann
  0 siblings, 0 replies; only message in thread
From: Mario Blättermann @ 2021-09-22 17:37 UTC (permalink / raw)
  To: util-linux

[-- Attachment #1: Type: text/plain, Size: 533 bytes --]

Hello,

although lsfd isn't official part of util-linux, this mailing list is
probably the right channel, because I assume it will become part of it
one day.

In the pull request I read "The man page is not available yet". See
the attached file: The diff contains an Asciidoctor man page mostly
based on the output with the --help option. Admittedly, not all info
what users need (in comparison with the current lsof(8)), but better
than nothing for the time being. Besides that, I've fixed two typos in
lsfd.c.

Best Regards,
Mario

[-- Attachment #2: lsfd-manpage.diff --]
[-- Type: text/x-patch, Size: 3865 bytes --]

diff --git a/misc-utils/lsdf.1.adoc b/misc-utils/lsdf.1.adoc
new file mode 100644
index 000000000..450b25ce0
--- /dev/null
+++ b/misc-utils/lsdf.1.adoc
@@ -0,0 +1,156 @@
+//po4a: entry man manual
+////
+Copyright 2021 Red Hat, Inc.
+
+This file may be copied under the terms of the GNU Public License.
+////
+= lsfd(1)
+:doctype: manpage
+:man manual: User Commands
+:man source: util-linux {release-version}
+:page-layout: base
+:command: lsfd
+
+== NAME
+
+lsfd - list file descriptors
+
+== SYNOPSIS
+
+*lsfd* [option]
+
+== DESCRIPTION
+
+*lsfd* is intended to be a drop-in replacement for *lsof*(8) on Linux systems. It uses Libsmartcols for output formatting.
+
+Available output columns:
+
+ASSOC::
+Association between file and process.
+
+CHRDRV::
+Character device driver name resolved by _/proc/devices_.
+
+COMMAND::
+Command of the process opening the file.
+
+DELETED::
+Reachability from the file system.
+
+DEV::
+ID of the device containing the file.
+
+DEVTYPE::
+Device type (_blk_, _char_, or _nodev_).
+
+FD::
+File descriptor for the file.
+
+FLAGS::
+Flags specified when opening the file.
+
+INODE::
+Inode number.
+
+MAJ:MIN::
+Device ID for special, or ID of device containing file.
+
+MAPLEN::
+Length of file mapping (in page).
+
+MISCDEV::
+Misc character device name resolved by _/proc/misc_.
+
+MNTID::
+Mount ID.
+
+MODE::
+Access mode (rwx).
+
+NAME::
+Name of the file.
+
+NLINK::
+Link count.
+
+PARTITION::
+Block device name resolved by _/proc/partition_.
+
+PID::
+PID of the process opening the file.
+
+POS::
+File position.
+
+PROTONAME::
+Protocol name.
+
+RDEV::
+Device ID (if special file).
+
+SIZE::
+File size.
+
+SOURCE::
+File system, partition, or device containing the file.
+
+TID::
+Thread ID of the process opening the file.
+
+TYPE::
+File type.
+
+UID::
+User ID number.
+
+USER::
+User of the process.
+
+== OPTIONS
+
+*-l*, *--threads*::
+List in threads level.
+
+*-J*, *--json*
+Use JSON output format.
+
+*-n*, *--noheadings*
+Don't print headings.
+
+*-o*, *--output* _list_
+Output columns.
+
+*-r*, *--raw*
+Use raw output format.
+
+*--sysroot* _dir_
+Use specified directory as system root.
+
+*--notruncate*
+Don't truncate text in columns.
+
+*-V*, *--version*::
+Display version information and exit.
+
+*-h*, *--help*::
+Display help text and exit.
+
+== HISTORY
+
+The *lsfd* command is part of the util-linux package since v2.38.
+
+== AUTHORS
+
+mailto:yamato@redhat.com[Masatake YAMATO]
+
+== SEE ALSO
+
+*lsof*(8)
+
+include::man-common/bugreports.adoc[]
+
+include::man-common/footer.adoc[]
+
+ifdef::translation[]
+include::man-common/translation.adoc[]
+endif::[]
diff --git a/misc-utils/lsfd.c b/misc-utils/lsfd.c
index 35abd7d8c..3b9714620 100644
--- a/misc-utils/lsfd.c
+++ b/misc-utils/lsfd.c
@@ -89,7 +89,7 @@ static struct colinfo infos[] = {
 	[COL_ASSOC]   = { "ASSOC",    0, SCOLS_FL_RIGHT, SCOLS_JSON_STRING,
 		N_("association between file and process") },
 	[COL_CHRDRV]  = { "CHRDRV",   0, SCOLS_FL_RIGHT, SCOLS_JSON_STRING,
-		N_("charcter device driver name resolved by /proc/devices") },
+		N_("character device driver name resolved by /proc/devices") },
 	[COL_COMMAND] = { "COMMAND",0.3, SCOLS_FL_TRUNC, SCOLS_JSON_STRING,
 		N_("command of the process opening the file") },
 	[COL_DELETED] = { "DELETED",  0, SCOLS_FL_RIGHT, SCOLS_JSON_BOOLEAN,
@@ -109,7 +109,7 @@ static struct colinfo infos[] = {
 	[COL_MAPLEN]  = { "MAPLEN",   0, SCOLS_FL_RIGHT, SCOLS_JSON_NUMBER,
 		N_("length of file mapping (in page)") },
 	[COL_MISCDEV] = { "MISCDEV",  0, SCOLS_FL_RIGHT, SCOLS_JSON_STRING,
-		N_("misc character device name resolved by /procmisc") },
+		N_("misc character device name resolved by /proc/misc") },
 	[COL_MNT_ID]  = { "MNTID",    0, SCOLS_FL_RIGHT, SCOLS_JSON_NUMBER,
 		N_("mount id") },
 	[COL_MODE]    = { "MODE",     0, SCOLS_FL_RIGHT, SCOLS_JSON_STRING,

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2021-09-22 17:37 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-22 17:37 Man page lsfd(1) Mario Blättermann

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.