build-232 (#119)

# upgrades/bug-fixes

  * documentation enhancements
  * mcstart, file-extension utility (#124)
  * MSTerminal maximize disabled (#122)
  * obey NODRIVES group policy (#121)
  * getmntinfo, networked/mapped drive (#120)
  * script enhancements, MC_XDG_OPEN as "start" (#119)
  * non-ascii group name handling (#118)
  * mandoc / mchelp integration (#116)
  * stat/seek64 (#35) and (#89)
  * unzip vfs (#88)
  * mc-wrapper's (#69)
  * ESC timeout, -1 enables an infinite wait (#36)

Author: adamyg

README.md

@@ -9,12 +9,12 @@
 
 Windows XP+/32 bit native port of GNU Midnight Commander, based on the [4.8.33](https://midnight-commander.org/wiki/NEWS-4.8.33) release.
 
-Supports both the recent Windows 10 plus the prior legacy console, 16 and 256 colour modes are available within either.
+Supports recent Windows 10/11 distributions, both MsTerminal and legacy console, 16 and 256 colour modes are available within all.
 
 Midnight Commander (also known as mc) is a free cross-platform orthodox file manager and a clone of Norton Commander.
 
 Features include the ability work with common archive formats as if they were simply another directory, and to function as an SFTP/FTP client.
-Midnight Commander also includes an builtin editor/viewer, features include syntax highlighting for many languages, macros, code snippets, 
+Midnight Commander also includes an built-in editor/viewer, features include syntax highlighting for many languages, macros, code snippets, 
 simple integration with external tools, automatic indentation, mouse support, clipboard and the ability to work in both ASCII and hex modes.
 
 Midnight Commander supports accessing remote filesystems through several methods, including SSH’s Secure File Transfer Protocol, SFTP. 
@@ -38,6 +38,7 @@ Internal editor.
 
 ![](https://github.com/adamyg/mcwin32/blob/master/mcwin32/art/sample05.png?raw=true)
 
+
 ## Installation
 
 Recent distributions are now bundled with an installer, the following shall prompt and then check for available upgrades.
@@ -57,18 +58,136 @@ To utilise *Files transferred over Shell protocol* **(FISH)** over SSH, an ssh c
 
 Finally the internal editor has built-in spell enabled. To utilise aspell is required, you can optionally install [Win32-Aspell](https://github.com/adamyg/aspell-win32).
 
+
+## Documentation
+
+The primary way to learn about midnight-commander is to use the context-sensitive online help available via **F1**.
+
+![](mcwin32/art/sample06.png?raw=true)
+
+Comprehensive manual pages serve as the main source of official documentation. These pages cover topics such as "mc," "mcdiff," "mcedit," and "mcview," which can be accessed through the **mchelp** utility. This utility presents relevant information on each topic using the internal viewer of _Midnight Commander_.
+
+```
+mchelp mc
+```
+
+## Configuration
+
+### Run-time profile
+
+The location of run-time configuration elements will differ across installations, and this can be checked using the ```--datadir-info``` option. Additionally, these elements are influenced by the MC_DATADIR environment variable. Further details can be found in __mchelp mc__.
+
+
+```
+$ mc --datadir-info
+
+Home directory: C:\Users\user
+Profile root directory: C:\Users\user
+Temporary directory: C:/Users/user/AppData/Local/Temp/mc-user/mc-user
+
+[System data]
+    Config directory: C:/Program Files (x86)/Midnight Commander/etc/
+    Data directory:   C:/Program Files (x86)/Midnight Commander/share/
+    File extension handlers: C:/Program Files (x86)/Midnight Commander/plugin/
+    VFS plugins and scripts: C:/Program Files (x86)/Midnight Commander/plugin/
+	extfs.d:        C:/Program Files (x86)/Midnight Commander/plugin/extfs.d/
+	shell:          C:/Program Files (x86)/Midnight Commander/plugin/shell/
+	magic:          C:/Program Files (x86)/Midnight Commander/etc/magic
+
+[User data]
+    Config directory: C:/Users/user/AppData/Roaming/Midnight Commander/
+    Data directory:   C:/Users/user/AppData/Local/Midnight Commander/
+	skins:          C:/Users/user/AppData/Local/Midnight Commander/skins/
+	extfs.d:        C:/Users/user/AppData/Local/Midnight Commander/extfs.d/
+	shell:          C:/Users/user/AppData/Local/Midnight Commander/shell/
+	mcedit macros:  C:/Users/user/AppData/Local/Midnight Commander/mc.macros
+	mcedit external macros: C:/Users/user/AppData/Local/Midnight Commander/mcedit/macros.d/macro.*
+	mcedit global-menu: n/a
+	mcedit local-menu: n/a
+	mcedit home-menu: C:/Users/user/AppData/Roaming/Midnight Commander/mcedit/menu
+    Cache directory:  C:/Users/user/AppData/Local/Microsoft/Windows/INetCache/Midnight Commander/
+```
+
+### Extensions
+
+Midnight Commander is fully extendable, allowing operations bound to file extensions. 
+
+Double-clicking on a file will try to execute the command if it is an  executable  program; and if the extension file has a program    specified for the file's extension, the specified program is executed. See [EXTENSIONS](mcwin32/doc/EXTENSIONS.md) for a number of  suitable examples.
+
+
 ## Distributions
 
-Latest builds:
+### Binaries and installers
+
+Midnight Commander:
 
    * https://github.com/adamyg/mcwin32/releases
-   * https://sourceforge.net/projects/mcwin32
+   * https://sourceforge.net/projects/mcwin32 (Mirror)
 
 Aspell:
 
    * https://github.com/adamyg/aspell-win32/releases
 
-Source:
+
+### Source
 
    * https://github.com/adamyg/mcwin32
+   
+The project can be built from source, the method dependent on the target host. 
+See [INSTALL](mcwin32/doc/INSTALL.md) for details, plus working examples are visible within the GitHub workflows.
+
+    https://github.com/adamyg/mcwin32f/blob/master/.github/workflows/build.yml
+   
+For actively supported tool-chains, configuration profiles are available.
+
+```
+    cd mcwin32
+    .\support\vc2019config
+```                      
+
+The following build profile and options shall be available.
+
+```
+ -
+ -  Configuration:
+ -
+ -               PackageName: Midnight Commander WIN32
+ -                   Version: 4.8.33
+ -
+ -                 ToolChain: Visual Studio 2019
+ -                  Compiler: cl / cl
+ -                    CFLAGS: -nologo -MD$(RTSUFFIX) -fp:precise
+ -                  CXXFLAGS: -nologo -MD$(RTSUFFIX) -EHsc -fp:precise -Zc:offsetof-
+ -                       Release: -O2 -GL -Gy -DNDEBUG
+ -                       Debug:   -Zi -RTC1 -Od
+ -                   LDFLAGS: -nologo -MD$(RTSUFFIX)
+ -
+ -
+ -      Virtual File Systems: cpio, extfs, shell, ftp, sfs, sftp, tar (see: config.h)
+ -            Screen library: console
+ -             Mouse support: native
+ -          Subshell support: n/a
+ -     Background operations: n/a
+ -           Internal editor: yes
+ -               Diff viewer: yes
+ -
+ 
+ Review the options above for accuracy.
+                        
+ Execute to build:
+                         
+    "make release"          - build software.
+                             
+ To generate an installer:
+                              
+    "make release package"  - build installer.
+                                  
+ Optionally after installation:
+                                   
+    "make release clean"    - remove build tree.
+                                       
+```
+
+## Status:
 
+Please feel free to raise tickets on **GitHub** when issues are encountered.

mcsrc/lib/file-entry.h

@@ -22,7 +22,7 @@ typedef struct
     /* File name */
     GString *fname;
     /* File attributes */
-    struct stat st;
+    mc_stat_t st;
     /* Key used for comparing names */
     char *name_sort_key;
     /* Key used for comparing extensions */

mcsrc/lib/lock.c

@@ -201,7 +201,7 @@ int
 lock_file (const vfs_path_t *fname_vpath)
 {
     char *lockfname = NULL, *newlock, *msg;
-    struct stat statbuf;
+    mc_stat_t statbuf;
     lock_s *lockinfo;
     gboolean is_local;
     gboolean symlink_ok = FALSE;
@@ -293,7 +293,7 @@ unlock_file (const vfs_path_t *fname_vpath)
     lockfname = lock_build_symlink_name (fname_vpath);
     if (lockfname != NULL)
     {
-        struct stat statbuf;
+        mc_stat_t statbuf;
 
         /* Check if lock exists */
         if (lstat (lockfname, &statbuf) != -1)

mcsrc/lib/mcconfig/common.c

@@ -107,7 +107,7 @@ mc_config_t *
 mc_config_init (const gchar *ini_path, gboolean read_only)
 {
     mc_config_t *mc_config;
-    struct stat st;
+    mc_stat_t st;
 
     mc_config = g_try_malloc0 (sizeof (mc_config_t));
     if (mc_config == NULL)

mcsrc/lib/util.c

@@ -116,7 +116,7 @@ resolve_symlinks (const vfs_path_t *vpath)
 {
     char *p, *p2;
     char *buf, *buf2, *q, *r, c;
-    struct stat mybuf;
+    mc_stat_t mybuf;
 
     if (vpath->relative)
         return NULL;
@@ -1361,7 +1361,7 @@ Q_ (const char *s)
 gboolean
 mc_util_make_backup_if_possible (const char *file_name, const char *backup_suffix)
 {
-    struct stat stat_buf;
+    mc_stat_t stat_buf;
     char *backup_path;
     gboolean ret;
 

mcsrc/lib/util.h

@@ -196,7 +196,7 @@ char *load_mc_home_file (const char *from, const char *filename, char **allocate
 /* uid/gid managing */
 void init_groups (void);
 void destroy_groups (void);
-int get_user_permissions (struct stat *buf);
+int get_user_permissions (mc_stat_t *buf);
 
 void init_uid_gid_cache (void);
 const char *get_group (gid_t gid);

mcsrc/lib/utilunix.c

@@ -1238,7 +1238,7 @@ mc_realpath (const char *path, char *resolved_path)
  */
 
 int
-get_user_permissions (struct stat *st)
+get_user_permissions (mc_stat_t *st)
 {
     static gboolean initialized = FALSE;
     static gid_t *groups;

mcsrc/lib/vfs/direntry.c

@@ -507,7 +507,7 @@ vfs_s_chdir (const vfs_path_t *vpath)
 /* --------------------------- stat and friends ---------------------------- */
 
 static int
-vfs_s_internal_stat (const vfs_path_t *vpath, struct stat *buf, int flag)
+vfs_s_internal_stat (const vfs_path_t *vpath, mc_stat_t *buf, int flag)
 {
     struct vfs_s_inode *ino;
 
@@ -611,18 +611,18 @@ vfs_s_write (void *fh, const char *buffer, size_t count)
 
 /* --------------------------------------------------------------------------------------------- */
 
-static off_t
-vfs_s_lseek (void *fh, off_t offset, int whence)
+static mc_off_t
+vfs_s_lseek (void *fh, mc_off_t offset, int whence)
 {
     vfs_file_handler_t *file = VFS_FILE_HANDLER (fh);
-    off_t size = file->ino->st.st_size;
+    mc_off_t size = file->ino->st.st_size;
 
     if (file->linear == LS_LINEAR_OPEN)
         vfs_die ("cannot lseek() after linear_read!");
 
     if (file->handle != -1)
     {                           /* If we have local file opened, we want to work with it */
-        off_t retval;
+        mc_off_t retval;
 
         retval = lseek (file->handle, offset, whence);
         if (retval == -1)
@@ -704,7 +704,7 @@ vfs_s_close (void *fh)
 
 static void
 vfs_s_print_stats (const char *fs_name, const char *action,
-                   const char *file_name, off_t have, off_t need)
+                   const char *file_name, mc_off_t have, mc_off_t need)
 {
     if (need != 0)
         vfs_print_message (_("%s: %s: %s %3d%% (%lld) bytes transferred"), fs_name, action,
@@ -878,7 +878,7 @@ vfs_s_dir_uptodate (struct vfs_class *me, struct vfs_s_inode *ino)
 /* --------------------------------------------------------------------------------------------- */
 
 struct vfs_s_inode *
-vfs_s_new_inode (struct vfs_class *me, struct vfs_s_super *super, struct stat *initstat)
+vfs_s_new_inode (struct vfs_class *me, struct vfs_s_super *super, mc_stat_t *initstat)
 {
     struct vfs_s_inode *ino;
 
@@ -1000,10 +1000,10 @@ vfs_s_entry_compare (const void *a, const void *b)
 
 /* --------------------------------------------------------------------------------------------- */
 
-struct stat *
+mc_stat_t *
 vfs_s_default_stat (struct vfs_class *me, mode_t mode)
 {
-    static struct stat st;
+    static mc_stat_t st;
     mode_t myumask;
 
     (void) me;
@@ -1041,7 +1041,7 @@ vfs_s_default_stat (struct vfs_class *me, mode_t mode)
  */
 
 void
-vfs_adjust_stat (struct stat *s)
+vfs_adjust_stat (mc_stat_t *s)
 {
 #ifdef HAVE_STRUCT_STAT_ST_BLOCKS
     if (s->st_size == 0)
@@ -1073,7 +1073,7 @@ vfs_s_generate_entry (struct vfs_class *me, const char *name, struct vfs_s_inode
                       mode_t mode)
 {
     struct vfs_s_inode *inode;
-    struct stat *st;
+    mc_stat_t *st;
 
     st = vfs_s_default_stat (me, mode);
     inode = vfs_s_new_inode (me, parent->super, st);
@@ -1396,23 +1396,23 @@ vfs_s_open (const vfs_path_t *vpath, int flags, mode_t mode)
 /* --------------------------------------------------------------------------------------------- */
 
 int
-vfs_s_stat (const vfs_path_t *vpath, struct stat *buf)
+vfs_s_stat (const vfs_path_t *vpath, mc_stat_t *buf)
 {
     return vfs_s_internal_stat (vpath, buf, FL_FOLLOW);
 }
 
 /* --------------------------------------------------------------------------------------------- */
 
 int
-vfs_s_lstat (const vfs_path_t *vpath, struct stat *buf)
+vfs_s_lstat (const vfs_path_t *vpath, mc_stat_t *buf)
 {
     return vfs_s_internal_stat (vpath, buf, FL_NONE);
 }
 
 /* --------------------------------------------------------------------------------------------- */
 
 int
-vfs_s_fstat (void *fh, struct stat *buf)
+vfs_s_fstat (void *fh, mc_stat_t *buf)
 {
     *buf = VFS_FILE_HANDLER (fh)->ino->st;
     return 0;
@@ -1424,11 +1424,11 @@ int
 vfs_s_retrieve_file (struct vfs_class *me, struct vfs_s_inode *ino)
 {
     /* If you want reget, you'll have to open file with O_LINEAR */
-    off_t total = 0;
+    mc_off_t total = 0;
     char buffer[BUF_8K];
     int handle;
     ssize_t n;
-    off_t stat_size = ino->st.st_size;
+    mc_off_t stat_size = ino->st.st_size;
     vfs_file_handler_t *fh = NULL;
     vfs_path_t *tmp_vpath;
     struct vfs_s_subclass *s = VFS_SUBCLASS (me);