pavliktt/fileinfo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
pavlik_dev 2024-08-23 20:06:59 +03:00 committed by GitHub
parent bebe7ec0a8
commit f825bb01fb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 67 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
README.md
View File

@ -1,36 +1,80 @@
[![C/C++ CI](https://github.com/pavliktt/fileinfo/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/pavliktt/fileinfo/actions/workflows/c-cpp.yml)
<h1>fileinfo</h1>
# fileinfo
A simple C++ program that displays information about files and folders.
<h2>Contents</h2>
## Contents
* [Installation](#installation)
* [Usage](#usage)
* [Example](#example)
<h2>Installation</h2>
First, install libmagic-dev:<br>
<pre>
sudo apt install libmagic-dev
</pre>
Or, you can just run<br>
<pre>
./configure
</pre>
Now, compile the source code.<br>
<pre>
## Installation
If you want the program to detect the file type more accurately, install `libmagic-dev` through your package manager, or with the `./configure` command
<br>
If you haven't installed `libmagic-dev`, please add this line to the very top of `main.cpp`:
```c++
#define NO_MIME
```
Then, compile the source code.<br>
```
make
</pre>
```
And finally, copy that executable to /usr/local/bin folder. (not required)<br>
<pre>
```
sudo cp fileinfo /usr/local/bin/
</pre>
<h2>Usage</h2>
<pre>
```
## Usage
```
./a.out [args] filename ...
Args:
-A Output absolute path
-E Do not show emojis
</pre>
<h2>Example</h2>
<pre>
pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ ls<br/>LICENSE main.c README.md<br/>pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ fileinfo main.c # Single file<br/>📝 main.c:<br/>&nbsp;&nbsp;&nbsp;&nbsp;Name: main.c<br/>&nbsp;&nbsp;&nbsp;&nbsp;Type: Text<br/>&nbsp;&nbsp;&nbsp;&nbsp;MIME: text/x-c<br/>&nbsp;&nbsp;&nbsp;&nbsp;File size: 10.1 KB or 9.9 KiB (10110 bytes)<br/>&nbsp;&nbsp;&nbsp;&nbsp;Permissions: -rw-rw-r--<br/>pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ fileinfo main.c -A # Single file with argument<br/>📝 main.c:<br/>&nbsp;&nbsp;&nbsp;&nbsp;Name: main.c<br/>&nbsp;&nbsp;&nbsp;&nbsp;Type: Text<br/>&nbsp;&nbsp;&nbsp;&nbsp;Absolute path: /home/pavlik/rgb-terminal/main.c<br/>&nbsp;&nbsp;&nbsp;&nbsp;MIME: text/x-c<br/>&nbsp;&nbsp;&nbsp;&nbsp;File size: 10.1 KB or 9.9 KiB (10110 bytes)<br/>&nbsp;&nbsp;&nbsp;&nbsp;Permissions: -rw-rw-r--<br/>pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ fileinfo * # All files in this directory<br/>📝 LICENSE:<br/>&nbsp;&nbsp;&nbsp;&nbsp;Name: LICENSE<br/>&nbsp;&nbsp;&nbsp;&nbsp;Type: Text<br/>&nbsp;&nbsp;&nbsp;&nbsp;MIME: text/plain<br/>&nbsp;&nbsp;&nbsp;&nbsp;File size: 1.2 KB or 1.2 KiB (1211 bytes)<br/>&nbsp;&nbsp;&nbsp;&nbsp;Permissions: -rw-rw-r--<br/><br/>📝 main.c:<br/>&nbsp;&nbsp;&nbsp;&nbsp;Name: main.c<br/>&nbsp;&nbsp;&nbsp;&nbsp;Type: Text<br/>&nbsp;&nbsp;&nbsp;&nbsp;MIME: text/x-c<br/>&nbsp;&nbsp;&nbsp;&nbsp;File size: 10.1 KB or 9.9 KiB (10110 bytes)<br/>&nbsp;&nbsp;&nbsp;&nbsp;Permissions: -rw-rw-r--<br/><br/>📝 README.md:<br/>&nbsp;&nbsp;&nbsp;&nbsp;Name: README.md<br/>&nbsp;&nbsp;&nbsp;&nbsp;Type: Text<br/>&nbsp;&nbsp;&nbsp;&nbsp;MIME: text/plain<br/>&nbsp;&nbsp;&nbsp;&nbsp;File size: 173 bytes<br/>&nbsp;&nbsp;&nbsp;&nbsp;Permissions: -rw-rw-r--<br/>pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ fileinfo . # Current directory<br/>📁 rgb-terminal/:<br/>&nbsp;&nbsp;&nbsp;&nbsp;Name: rgb-terminal/<br/>&nbsp;&nbsp;&nbsp;&nbsp;Type: Folder<br/>&nbsp;&nbsp;&nbsp;&nbsp;MIME: inode/directory<br/>&nbsp;&nbsp;&nbsp;&nbsp;Contents:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Normal: 3 files and 0 folders.<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Hidden: 0 files and 1 folders.<br/>&nbsp;&nbsp;&nbsp;&nbsp;Permissions: drwxrwxr-x
</pre>
```
## Example
```
pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ ls
LICENSE main.c README.md
pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ fileinfo main.c # Single file
📝 main.c:
Name: main.c
Type: Text
MIME: text/x-c
File size: 10.1 KB or 9.9 KiB (10110 bytes)
Permissions: -rw-rw-r--
pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ fileinfo main.c -A # Single file with argument
📝 main.c:
Name: main.c
Type: Text
Absolute path: /home/pavlik/rgb-terminal/main.c
MIME: text/x-c
File size: 10.1 KB or 9.9 KiB (10110 bytes)
Permissions: -rw-rw-r--
pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ fileinfo * # All files in this directory
📝 LICENSE:
Name: LICENSE
Type: Text
MIME: text/plain
File size: 1.2 KB or 1.2 KiB (1211 bytes)
Permissions: -rw-rw-r--
📝 main.c:
Name: main.c
Type: Text
MIME: text/x-c
File size: 10.1 KB or 9.9 KiB (10110 bytes)
Permissions: -rw-rw-r--
📝 README.md:
Name: README.md
Type: Text
MIME: text/plain
File size: 173 bytes
Permissions: -rw-rw-r--
pavlik@pavlik-MacBookPro9-2:~/rgb-terminal$ fileinfo . # Current directory
📁 rgb-terminal/:
Name: rgb-terminal/
Type: Folder
MIME: inode/directory
Contents:
Normal: 3 files and 0 folders.
Hidden: 0 files and 1 folders.
Permissions: drwxrwxr-x
```