ShowFiles (sf) manual/documentation

Home of Marko's Amiga and AmigaOS stuff - both Classic and AmigaOS 4
Back to Software
ShowFiles (sf) manual/documentation

On this page you find the manual/documentation for the ShowFiles (sf) command. This is the same content as in the ShowFiles.doc file found in the Lha archive. If you need help take a look in this text and see if it helps...

Back to ShowFiles page
		
ShowFiles (sf) - 0.972
======================

DIR/LIST command - displays a sorted and text-formatted list.

ShowFiles (sf) is yet another DIR command (written in C).  It displays a sorted
and text-formatted list of files, drawers (dirs) and soft/hard-links on disk or
other storage medium. It will also display their additional information such as
size,  date,  possible comment,  executable  header type  (68k or PPC program),
protection-bits, etc, etc.

It supports  a number of different option/switch formats  (Amiga like switches,
Unix/Linux style  and DOS/Windows style).  It also supports  wildcards/pattern-
matching and Amiga templates.
  After installation, in the Shell,  please type "sf HELP" (or "sf --help") for
listing all options/switches. Or look in the .doc-file in the archive.


ShowFiles|sf [ [[assignment:][path]|DIR] [MORE|CLARIFY|DEFAULT] | [[REVERSE][TIME][SIZE][ALL][TRAIL][QUICK][FILES][DIRS][LINKS][68K][PPC][REALDATE][DATEFIRST]] ] | [VERSION|HELP|?]

DIR/m,MORE/s,CLARIFY/s,DEFAULT/s,REVERSE/s,TIME/s,SIZE/s,ALL/s,TRAIL/s,QUICK/s,FILES/s,DIRS/s,LINKS/s,68K/s,PPC/s,REALDATE/s,DATEFIRST/s,VERSION/s,HELP/s

Usage: ShowFiles [assignment:][path] [List-view-option] [Other-options...]
or:           sf [assignment:][path] [List-view-option] [Other-options...]

Where: [assignment:][path]    Specify assignment and/or drawer (directory)
                              and ShowFiles will list the files there.

List-view-option (only one at a time)
----------------

List-view-option is ONE of the following three:
  (1)      (1)        (2) (2)  
  MORE     --more     -m  /m  Display a list with more specific information
                              about files.
  CLARIFY  --clarify  -c  /c  Display an even more clarified listing about
                              files (displays all info that can be found,
                              same info for all locales).
  DEFAULT  --default  -e  /e  *DEFAULT* Force to display the default listing.


Other-options/switches
----------------------

Sort options:
  (1)      (1)        (2) (2)  
  REVERSE  --reverse  -r  /r  Display the files/dirs in reverse order.
  SIZE     --size     -s  /s  Sort by size, smallest first, biggest last.
  TIME     --time     -t  /t  Sort by time/date, oldest first, newest/latest last.

Additional options:
  (1)      (1)        (2) (2)  
  68K      --68k      -6  /6  Only lists all 68k (m680x0) executables. Overides
                              the QUICK option.
  ALL      --all      -a  /a  Lists all items in directories and subdirs.
  BARE     --bare     -b  /b  Uses bare format (no heading/summary information).
  DIRS     --dirs     -d  /d  Displays only dirs, no regular files or links).
  FILES    --files    -f  /f  Displays only regular files, no dirs or links.
  TRAIL    --trail    -i  /i  Trail dirs with an initial "/", executable
                              headers with an "*", and links with an "@".
  LINKS    --links    -l  /l  Displays only links, no regular files or
                              dirs), however you may intermix -f, -d, -l how
                              you please. F.ex. for listing dirs and links
                              type: sf dirs links
  PPC      --ppc      -P  /P  Only lists all PowerPC (ELF) executables.
                              Overides the QUICK option.
  QUICK    --quick    -q  /q  Process the output quicker, this will skip the
                              fetching of executable headers (cannot identify
                              EHeads and does not influence the timer).
                      
Information options:
  (1)      (1)        (2) (2)  
  HELP     --help     -?  /?  Displays this help/about message.
  MANUAL   --manual   -n  /n  *REMOVED* See .doc file instead in the archive
                              or SYS:Documentation/C/ShowFiles.doc.
  VERSION  --version  -v  /v  Display version information.


Special swith(es):
  ?                           Shows the Template for this command.


Commands
--------

  REALDATE    --realdate      Show Dates in international ISO 8601 format (yyyy-mm-dd). (Does not apply CLARIFY view.)
  DATEFIRST   --datefirst     Moves the Date (and Time) column as first column. (Does not apply DEFAULT view.)
  get_verstag                 Returns the VERSTAG of ShowFiles.


(1) Non-single letter options are not case sensitive. Options all, ALL, --all
    and --ALL are all the same option.
(2) One single letter options such as m, p, P, /a, -H, etc are case-sensitive,
    and all denotes different options.


Reservations
------------
Reserved for future:
  Option p, h and H are reserved (case sensitive).



Formats of options
------------------
Supports multiple formats of switches/options/flags. You may use and intermix
whichever formats you prefer.

All 4 formats below means the same thing:
  sf TIME    AmigaOS
  sf --time  UNIX/Linux long options with --.
  sf -t      UNIX/Linux, single-letter starting with - options.
  sf /t      MS-DOS/Windows, single-letter starting with / switches.

NOTE: One-single-letter options, such as -t, /P are case-sensitive. Long
options and Amiga options are not.


List views
----------
There are 3 different list-views in ShowFiles, which are displayed as follows:

*DEFAULT*
Ex: sf
Output: Date Short-Time PFT KiB [T] Name|Link [-> LinkPointsTo] [(Comment)]

With MORE option:
Ex: sf more
Output: PFT Short-PB [EH] Date Full-Time KiB B [T] Name|Link [-> LinkPointsTo]
        [(Comment)]

With CLARIFY option:
Ex: sf clarify
Output: PFT PB [EH] UID GID UC ID Int-Date Full-Time KiB kB B [T] Name|Link
        [-> LinkPointsTo] [(Comment)]

Description:
- PFT: The "Primitive" or base/super File Type of a file as reported by the
  DOS/File-System. However, the script type is derived from the file's
  script-protection-bit. Each type are reported either in short or in a longer
  form depending on which option is used.
  - Dir (d) - Directory/drawer.
  - SLink (sl) - Softlink.
  - HLink (hl) - Hardlink.
  - Script (s) - Amiga Script file derived from the file's
                 script-protection-bit.
  - File (f) - Regular file.
  - Exe (e) - (Identified) Executable file format Header. (see more below)
  - Unknown (uk) - If none of above (may happen).
- Short-PB: 5 Protection-Bits in the following order: a, r, w, e, d.
- PB: 8 Amiga Protection-Bits in the following order: h, s, p, a, r, w, e, d.
  Where each letter stand for:
  r - read bit set
  w - write bit set
  e - executable bit set
  d - delete bit set
  s - script bit set
  p - pure-command bit set
  a - archive bit set
  h - hold-resident bit set		
  (If you want more info, please refer to the OS documentation,
  f. ex.: see SYS:Documentation/C/Protect.doc)
- E: Name of (identified) Executable Header (Exe).
- UID: Owner User-ID.
- GID: Owner Group-ID.
- UC: Use-Count.
- ID: Object-ID.
- Date: Date in localized format.
- Int-Date: Date in international format, YYYY-MM-DD.
- Short-Time: Time in HH:MM format.
- Full-Time: Time in HH:MM:SS format.
- KiB: 1024 bytes (IEC 60027 binary prefix).
- kB: 1000 bytes (SI decimal prefix).
- B: Amount of bytes.
- T: A character (a trail):
  / - dir
  * - executable
  @ - link
- Name: Name of the file.
- Link: Name of the soft/hard-link.
- LinkPointsTo: The file name where a link points at.
- Comment: The comment (or file-note) for a file.


Executable headers
------------------
Executable file format headers (Exe) are identified by their "magic number",
currently DF knows 6 different executable file formats:
- 68K: The actual name of this is Amiga "Hunk", which is the executable file
  format of the "Classic" Amiga Operating System for the Motorola 68000 CPU
  processor family.
- PPC: Executable and Linkable Format, used by many different systems on many
  different platforms including phones and game consoles. All kinds from
  AmigaOS 4 and MorphOS to Linux, Haiku and PlayStation 3 uses ELF.
- EXE: MS-DOS executable and Portable Executable (PE) on Windows.
- PEF: Used by Mac OS and BeOS for PowerPC executables.
- JBC: Java bytecode (class files).
- CBC: Compressed Java bytecode.
- fld: *error code* Checking header failed, file might be read protected, etc.

Don't forget that all files that are identified gets the Exe PFT set,
including SOBJs, Windows EXEs, DLLs, etc..

Also, the "fetching-of-executable-headers" procedure has been optimized. ->
Moved the procedure to fetch while printing the output which resulted much
smoother executation (less delay before anything is printed, particularly on
large dirs). 
Some quick benchmarks on a dir on a SFS2 partition with 1000 files performed
with 4-10 times less delay before printing but roughly 1-2% longer total
execution time, though. 


Size prefixes
-------------
File sizes are displayed in 3 different ways: KiB, kB and bytes.

Where prefixes are: (note: case specific)
- KiB (kibibyte)	2^10 = 1024 	// IEC 60027 binary prefix
- kB  (kilobyte) 	10^3 = 1000 	// SI decimal prefix

Sizes are rounded to the nearest integer, while percent of free disk space
is floored.

Note about zero file sizes: If a file size of 0 is displayed in the listing,
then the actual file size is exactly 0 otherwise non-zero. Thus, this means
that if a file's actual size is 1 byte then it will show up as 1 KiB or 1kB in
the listing. Only zero size (empty) files shows up as 0 KiB or 0 kB.


Timer
-----
The time is measured from that the program starts, to after all data (except
"fetching-of-executable-headers") has been read + processed, and just before
any data has been printed.

NOTE: Executable headers are fetch while printing the output and does not
influence this timer.

NOTE2: Timer is disabled when using the ALL option.


Version numbers and betas
-------------------------
Each release has 2 version numbers present: public and internal.
F.ex: "Beta 4: 0.4:"
"Beta 4" is the public version name where as
"0.4" is the internal version name (Amiga version tag/string).

Now when ShowFiles is out of beta, both the public and the internal version
number are the same. However, there may still come some version wich is tagged
as beta, these betas reflects the updated part of the program and not the whole
program, in this case the name "beta" comes after the version number, f.ex.
10.3 beta and not Beta 5.


Milestones and major events
---------------------------
2015 Jul, version 0.970
  - Pattern matching implemented.
2014 Feb, version 0.943
  - A rare bug with option ALL (recursive dirs) found and tested on 
    A1-X1000, Sam460ex and Sam440ep-flex. Bug caused by a compiler switch.
2013 Dec, version 0.923
  - All major/minor typos, quirks and bugs resolved in all scripts
    (AutoInstall, Install and UnInstall scripts).
2012 Nov, version 0.8
  - Renamed to ShowFiles (SF/sf) from DF (DisplayFiles).
2011 Feb, version Beta 5, (0.5)
  - AmiUpdate implemetation completed and fully working autoinstall.
2011 Feb, version Beta 2
  - Dynamic memory allocation for storing file meta data (dir listing handling),
    no more "max limit of 1000 files".
2011 Jan, version Alpha 1
  - First public release.


Changes
-------
Version 0.972: (Sep 2015)
  - Compiled with latest SDK version 53.29.
  - Fixed case sensitive issue with pattern matching. (thanks Guillaume
    (zzd10h) for reporting)
  - Fixed a rare condition where header whould not print correctly.
  - UseCount removed from output, DOS structure no longer support it.
Version 0.971: (Jul 2015)
  - Fixed bug, pattern matching in current dir failed.
Version 0.970: (Jul 2015)
  - Pattern matching implemented.
  - Fixed bug, header background-color sometimes smearing to next line.
  - Fixed issue with template and option/command-info-format, a few working
    commands/options were missing in the printed output.
  - Fixed APP-string/name, leftover garbage ("DEBUG") removed from the string.
  - Included output of the EXTVER-tag to the version/help output.
Version 0.960: (Sep 2014)
  - Added ? switch for showing the Template, suggested by JosDuchIt.
  - Added BARE option, for using bare format (no heading/summary information).
  - Safety improved, added more checks concerning memory (just to be sure).
    (Sentinels placed around memory allocations, about 20 in total.)
  - Corrected information in the HELP option.
  - Typos fixed in the Options-section and in the Readme file.
  - Added Format-info and Template-info to documentation.
  - Added small hidden message to binary (only #JustForFun, ~60 chars).
  - Added Milestones-section to documentation.
Version 0.950: (Jun 2014)
  - Added REALDATE command, shows Date in international format (yyyy-mm-dd),
    suggested by JosDuchIt.
  - Added DATEFIRST command, Date (and Time) column is as first column, sort
    of suggested by JosDuchIt.
  - Bugfix/change: The few first protectionbits are seen now again in MORE
    view. This was little "too much of a feature" that looked broken.
  - Bugfix/change: The three first columns in the DEFAULT view removed, yes
    those should not be seen, please use option MORE instead to see those
    as well.
  - Added Extversion (EXTVER) tag/cookie.
  - Minor fixes in readme, among other small fixes.
Version 0.943: (Feb 2014)
  - Bugfixed option ALL. This exact compile was *VERIFIED* thanks to
    Guillaume Boesel (zzd10h) on his A1-X1000 and Joel Edberg (Joeled) on his
    Sam460ex, and also tested on author's Sam440ep-flex. The bug was due to a
    compiler optimization switch.
Version 0.942: (Feb 2014)
  - Bugfixed option ALL. (Edit: No bummer, still something fishy, sorry.)
Version 0.942d1: (Feb 2014)
  - Debug-version for option ALL. (Thanks for testing Guillaume Boesel (zzd10h)
    on AmigaOne X1000 and Joel Edberg (Joeled) for testing on Sam460ex. Also
    runs fine on my (the author's) Sam440ep-flex with AmigaOS 4.1 Update 6.)
Version 0.941: (Jan 2014)
  - AmiUpdate fix, AutoInstall file included again, it did escape for some
    mysterious reason ( ;) ) in the last archive. (Thanks zzd10h)
  - Option for showing the manual has been removed (since it's ever growing)
    and at least 10 KiB (20%) has been shaved off the ShowFiles executable. See
    the .doc file instead in the archive or SYS:Documentation/C/ShowFiles.doc.
  - Fixes in readme/documentation, some last minute typos did crawl into the
    last upload.
Version 0.940: (Jan 2014)
  - Bugfix for DSI crash in option ALL, reported by Guillaume Boesel (zzd10h),
    resulting in a total rewrite of the ALL-option specific part.
  - Fixed bug, row-break/new-line issue in the footer.
  - Much improved error handling and stability with more graceful exit.
  - In addition to above, fixed/updated several error-messages, numbered them
    as well for referencing purpose.
  - Added 68K, --68k, -6 and /6 option(s) for only listing all 68k executables.
  - Added PPC, --ppc, -P and /P option(s) for only listing all PPC (ELF)
    executables.
  - CHANGE: All one single letter options such as a, -m, /? are now case
    sensitive, where as non-single-letter options are not. This is because
    available free letters for more options are becomming scarce.
  - Changed single letter option h to ? (because of above reason).
  - Added get_verstag function for returning the VERSTAG.
  - Comments in output are now in italic black on grey for better visibility.
  - Output header now in bold on grey for better visibility.
  - Output footer now in italic for better visibility.
  - Dirs in output are now also in bold for better visibility.
  - Other minor bugfixes and further fixes and typos in readme/documentation.
Version 0.930: (Jan 2014)
  - ALL option added, for displaying all subdirectories and their items.
  - File installation structure changed, no dir with extra files copied to C:
    or anywhere else anymore.
  - Changed so "PPC" is shown rather than "elf" in dir listings.
  - Compiled with the latest updated SDK (version 53.24).
  - Typos and minor fixes in readme/documentation.
Version 0.923: (Dec 2013)
  - Bugfix regarding links not being underlined or marked in output. (PS: That
    bug was kind of hard to track and hunt down but now resolved ;) )
  - File comments and link arrows now also in white (pen 2).
  - More bugfixes in AutoInstall, Install and UnInstall scripts.
Version 0.922: (Dec 2013)
  - Bugfixes in AutoInstall, Install and UnInstall scripts.
  - Minor typos in readme fixed.
Version 0.921: (Jan 2013)
  - Moved AutoInstall to the root.
Version 0.92: (Dec 2012)
  - Fixed bug, "Total size listed is always 0 in the footer."
  - Fixed the AutoInstall, there were some unknown parameters (oops).
  - Changed the footer info so files and dirs are separate, and items is the
    total of those, among other minor there in the footer.
Version 0.91: (Dec 2012)
  - Fixed a serious bug introduced in version 0.9 after adding options.
  - Changed file structure, Install, Uninstall and AutoInstall scripts to the 
    one structure suggested by cha05e90, where no dir is created C: .
  - Added credits and made lots of improvments to the documentation, except
    for what's new.
  - Changed the primitive file type "Exe" back to "Exec" (as it was in the
    beginning), since "Exe" is a type of Executable-Header).
  - Fixed a few other minor bugs (AmiUpdate bug among others (hopefully)).
Version 0.9: (Dec 2012)
  - Added options for FILES, DIRS, and LINKS, it is also possible to
    intermix them.
  - Changed the name for "EHead" to "Exe" (and "eh" to "e").
  - Fetching of exe-headers -> little faster (some code cleaned up there).
  - Updated Install/Uninstall scripts further, to be more safer and error
    resistant, and typos fixed.
  - Updated the documentation some further, except for documenting what's new.
  - Output slightly changed.
Version 0.8: (Nov 2012)
  - DF (DisplayFiles) renamed to ShowFiles (sf) because DF was clashing with
    the UNIX/Linux command df, (thanks Beeblebrox). ShowFiles was the winning
    name on a Poll on AmigaWorld.net 2011, the name was suggestied by kas1e).
  - New: Added install and uninstall scripts, and links to executable.
  - Changed the structure of files (the executable file, links, doc-file, etc).
  - Updated AutoInstall to reflect the renaming to ShowFiles and the new
    file structure.
  - ShowFiles is now out of Beta (with regard to the base engine).
Beta 7 - (0.7): (Apr 2011)
  - Added info to footer-output about amount of dirs listed.
  - Fixed bug, "dirs and files with same size are not sorted when sorting
    by SIZE".
  - Fixed issue, "multiple messages on error".
  - Fixed a few other minor issues.
Beta 6 - (0.6): (Mar 2011)
  - Optimized the "fetching-of-executable-headers" procedure. -> Moved
    "fetching-of-executable-headers" to fetch while printing the output
    resulting smoother executation (less delay before anything is printed,
    especially on large dirs). 
  - Added a SIZE option so the list can be sorted by size.
  - Added a TRAIL option that will trail dirs with an initial '/', executable
    headers with an '*', and links with an (at)-char.
  - Renamed the option "DETAILS" to "CLARIFY" ("D" will be reserved for
    another usage.
  - Renamed the option "FAST" to "QUICK" ("F" will be reserved for
    another usage.
  - Swapped "kB" and "KiB" columns in the DETAILS view.
  - Added DEFAULT option so the default listing can be forced (in future).
  - Fixed a few other minor bugs.
Beta 5 - (0.5): (Feb 2011)
  - Added TIME option/switch so the list can be sorted by time and date.
  - Added REVERSE option/switch so the list can be displayed in reverse order.
  - Changed so that protection bits are showed in short format in the MORE
    view (to save some space).
  - Renamed the option "ALL" to "DETAILS" (ALL is reserved for another
    future option).
  - Renamed primitive file type "Drawer" to "Dir" (shorter -> perhaps better).
  - Added so that the VERSION option prints out the "Amiga version string" too.
  - Added AutoInstall script for AmiUpdate.
  - Fixed bug, "all columns not correctly aligned with some date formats", 
    (thanks samo79).
Beta 4 - (0.4): (Feb 2011)
  - Quick release with bugfix for "DSI error when started" on some systems
    introduced in Beta 3. (Thanks davebraco)
Beta 3 - (0.03): (Feb 2011)
  - Renamed the "primitive" file type "Exec" to "EHead", which is short for
    (identified) Executable-file-format-Header.
  - Added Amiga-version tag/string (as internal version number).
  - Added support for AmiUpdate.
  - Fixed correct return codes (according to AmigaDOS conventions).
  - Major internal changes (heavy refactoring, etc), hopefully nothing
    got broken.
  - Added a MANUAL option/switch for displaying the documentation.
  - Clarified and expanded documentation some more.
Beta 2: (Feb 2011)
  - Implemented the "possibility to specify a path" issue.
  - Fixed the "max limit of 1000 files" issue, there's "no limit" anymore.
  - Added two new primitive file types, Unknown and Exec (renamed to EHead).
  - Added a FAST option/switch, this will skip the fetching of
    executable headers, hence faster.
  - Some changes in text output/formatting, most notable in header and footer.
  - Added another foot-row with info about remaining disk space.
  - Clarified documentation much more.
Beta 1: (Jan 2011)
  - Fixed sort-order so that drawers appears at the top and
    lower/upper-case are treated as same, (if same letter but different case,
    then upper has precedence over lowercase).
  - Added a timer function.
  - Added footer with info about total amount of files, KiB and
    bytes displayed, + timer info.
  - Added header with info (name) about what directory is being displayed.
  - Fixed so that sizes are only displayed for scripts and regular files.
  - Fixed bug regarding "directories has wrong alignment in more/all view"
  - Fixed bug regarding "wrong file size for none-regular files".
  - Expanded documentation much more.
Alpha 1: (Jan 2011)
  - First public release.


Thank You
---------
Thank you to everyone giving help, feedback, bug/error-reports and suggestions.
Individual credits are in history body text.


Licence
-------
This software is freeware.


Donation
--------
Feel free to make a donation by using PayPal:
marko . seppanen // g m a i l. com (without spaces)


Author
------
Marko K. Seppänen


Homepage
--------
http://m4rko.com/amiga
Back to ShowFiles page
ï¿½ 2024, Marko K. Seppänen, m4rko.com, all rights reserved, Legal and Credits.
Website optimized for Odyssey Web Browser (WebKit-based) version 1.23 for AmigaOS 4.
Amiga, AmigaOS and BoingBall are registered trademarks of either "Amiga, Inc" or "Hyperion Entertainment".

m4rko.com/AMIGA

Support my work!