anvil/man/anvil-file-details.8
digimer 4c118cf3b4 * Created empty man page files all remaining tools.
* Started fixing existing man pages, and writting needed ones.

Signed-off-by: digimer <mkelly@alteeve.ca>
2023-08-11 13:55:51 -04:00

59 lines
1.5 KiB
Groff

.\" Manpage for the Anvil! file detail tool
.\" Contact mkelly@alteeve.com to report issues, concerns or suggestions.
.TH anvil-file-details "8" "August 11 2023" "Anvil! Intelligent Availability™ Platform"
.SH NAME
anvil-file-details \- Display details of the file passed in
.SH SYNOPSIS
.B anvil-file-details
\fI\,</path/to/file> \/\fR
.SH DESCRIPTION
All this does is stat a file and return the information in a parsable way. For this reason, translatable strings are not used.
.TP
.SH OPTIONS
.TP
\-?, \-h, \fB\-\-help\fR
Show this man page.
.TP
\fB\-\-log\-secure\fR
When logging, record sensitive data, like passwords.
.TP
\-v, \-vv, \-vvv
Set the log level to 1, 2 or 3 respectively. Be aware that level 3 generates a significant amount of log data.
.SS "Commands:"
.TP
\fB\-\-file\fR /path/to/file
.TP
This is the file being examined.
.TP
\fB\-\-with\-md5sum\fR
.TP
Given how long calculating MD5 sums can take on large files, by default this is not done. If you want the md5sum calculated, use this switch.
.TP
.SS "EXAMPLE"
.TP
The output will show the following information:
.TP
.Bl -width
.It
[root@an-striker01 ~]# anvil-file-details --with-md5sum --file /mnt/shared/files/rhel-9.2-x86_64-dvd.iso
.It
File: [/mnt/shared/files/rhel-9.2-x86_64-dvd.iso]
.It
size: [9595977728]
.It
mode: [04644]
.It
uid: [1000]
.It
gid: [1000]
.It
mtime: [1690423778]
.It
md5sum: [90cf58ff7a8f6ef8cb20b8ff091e84b7]
.El
.IP
.SH AUTHOR
Written by Madison Kelly, Alteeve staff and the Anvil! project contributors.
.SH "REPORTING BUGS"
Report bugs to users@clusterlabs.org