{
    "content": [
        {
            "type": "text",
            "text": "# folder(1) (man)\n\n**Summary:** folder, folders - set/list current nmh folder/message\n\n**Synopsis:** folder [-help] [-version] [+folder] [msg] [-all | -noall] [-create | -nocreate] [-fast | -no‐‐\nfast] [-header | -noheader] [-recurse | -norecurse] [-total | -nototal] [-list | -no‐‐\nlist] [-push | -pop] [-pack | -nopack] [-print] [-verbose | -noverbose]\nfolders is equivalent to folder -all\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| — | — | — | create an empty folder for later use.) Specifying -nocreate will cause folder to print an error message and exit without |\n| — | — | — |  |\n\n## See Also\n\n- mhpath(1)\n- refile(1)\n- rmf(1)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (6 lines)\n- **DESCRIPTION** (12 lines) — 5 subsections\n  - -create (3 lines)\n  - Multiple Folders (40 lines)\n  - Compacting a Folder (4 lines)\n  - The Folder Stack (14 lines)\n  - -pop -list -print (1 lines)\n- **FILES** (2 lines)\n- **PROFILE COMPONENTS** (5 lines)\n- **SEE ALSO** (2 lines)\n- **DEFAULTS** (2 lines) — 6 subsections\n  - -nofast (1 lines)\n  - -noheader (1 lines)\n  - -nototal (1 lines)\n  - -nopack (1 lines)\n  - -norecurse (1 lines)\n  - -noverbose (3 lines)\n- **CONTEXT** (2 lines)\n- **BUGS** (6 lines)\n\n## Full Content\n\n### NAME\n\nfolder, folders - set/list current nmh folder/message\n\n### SYNOPSIS\n\nfolder [-help] [-version] [+folder] [msg] [-all | -noall] [-create | -nocreate] [-fast | -no‐‐\nfast] [-header | -noheader] [-recurse | -norecurse] [-total | -nototal] [-list | -no‐‐\nlist] [-push | -pop] [-pack | -nopack] [-print] [-verbose | -noverbose]\n\nfolders is equivalent to folder -all\n\n### DESCRIPTION\n\nWhen  folder is given the -print switch (the default), it lists: the current folder, the num‐\nber of messages in it and their range (low-high), the folder's current message, and an  indi‐\ncation of extra files, if any.  For example:\n\ninbox+            has  16 messages (  3- 22); cur=  5.\n\nIf  a  +folder  and/or msg are specified, they will become the current folder and/or message.\n(When a +folder argument is given, this corresponds to a “cd” operation in the shell; when no\n+folder argument is given, this corresponds roughly to a “pwd” operation in the shell.)\n\nIf  the  specified  (or default) folder doesn't exist, folder will ask the user if the folder\nshould be created; when standard input is not a tty, the answer is assumed to be “yes”.   The\n\n#### -create\n\ncreate an empty folder for later use.)  Specifying -nocreate will cause folder  to  print  an\nerror message and exit without creating a folder.\n\n#### Multiple Folders\n\nSpecifying  -all  will produce a summary line for each top-level folder in the user's nmh di‐\nrectory, sorted alphabetically.  (If folder is invoked by a name ending with “s” (e.g.  fold‐‐\ners),  -all is assumed.)  Specifying -recurse with -all will include a line for all sub-fold‐\ners.  These folders are all preceded by any read-only folders, which occur as “atr-cur-”  en‐\ntries in the user's nmh context.  For example:\n\nFOLDER                  # MESSAGES RANGE      CUR     (OTHERS)\n/var/work/folder  has  35 messages ( 1- 35);  cur=23.\n/usr/bugs/Mail    has  82 messages ( 1-108);  cur=82.\nff                has  no messages.\ninbox+            has  16 messages ( 3- 22);  cur= 5.\nmh                has  76 messages (15- 76);  cur=70.\nnotes             has   2 messages ( 1-  2);  cur= 1.\nucom              has 124 messages ( 1-124);  cur= 6; (others).\nTOTAL = 339 messages in 7 folders\n\nThe  “+”  after inbox indicates that it is the current folder.  The “(others)” indicates that\nthe folder ucom contains files which aren't messages; these may  either  be  sub-folders,  or\nfiles that don't belong under the nmh file naming scheme.\n\nThe  header is output if either the -all or -header switches are specified.  It is suppressed\nby -noheader.\n\nThe folder and message totals are output if either the -all or -total switches are specified.\nThey are suppressed by -nototal.\n\nIf  -fast  is  given,  only  the  folder name (or names, in the case of -all) will be listed.\n(This is faster because the folders need not be read.)\n\nIf a +folder is given with the -all switch, folder will, in addition to setting  the  current\nfolder,  list  the top-level sub-folders for the current folder (with -norecurse) or list all\nsub-folders under the current folder recursively (with -recurse).\n\nIf msg is supplied, together with +folder or without -all, it will become the current message\nof +folder (if it had been supplied) or the current folder.\n\nThe  -recurse  switch lists each folder recursively, so its use effectively defeats the speed\nenhancement of -fast, since each folder must be searched for sub-folders.  Nevertheless,  the\ncombination of these options is useful.\n\n#### Compacting a Folder\n\nThe -pack switch will compress the message names in the designated folders, removing holes in\nmessage numbering.  The -verbose switch directs folder to tell the user the  general  actions\nit is taking to compress the folder.\n\n#### The Folder Stack\n\nThe  -push  switch  directs folder to push the current folder onto the folder-stack, and make\nthe +folder argument the current folder.  If +folder is not given, the current folder and the\ntop  of  the  folder-stack  are  exchanged.  This corresponds to the “pushd” operation in the\nshell.\n\nThe -pop switch directs folder to discard the top of the folder-stack, after setting the cur‐\nrent  folder  to that value.  No +folder argument is allowed.  This corresponds to the “popd”\noperation in the shell.  The -push and -pop switches are mutually exclusive: the last  occur‐\nrence  of  either  one  overrides any previous occurrence of the other.  The use of either of\nthese switches also sets -list, by default.\n\nThe -list switch directs folder to list the folder-stack.  No +folder  argument  is  allowed.\nAfter  a successful -push or -pop, the -list action is taken, unless a -nolist switch follows\nthem on the command line.  This corresponds to the “dirs” operation in the shell.  The -push,\n\n#### -pop -list -print\n\n### FILES\n\n$HOME/.mhprofile   The user's profile.\n\n### PROFILE COMPONENTS\n\nPath:               To determine the user's nmh directory.\nCurrent-Folder:     To find the default current folder.\nFolder-Protect:     To set mode when creating a new folder.\nFolder-Stack:       To determine the folder stack.\n\n### SEE ALSO\n\nmhpath(1), refile(1), rmf(1)\n\n### DEFAULTS\n\n+folder             The current folder.\nmsg                 “none”\n\n#### -nofast\n\n#### -noheader\n\n#### -nototal\n\n#### -nopack\n\n#### -norecurse\n\n#### -noverbose\n\n-print              is the default if no -list, -push, or -pop is specified.\n-list               is the default if -push, or -pop is specified.\n\n### CONTEXT\n\nIf +folder and/or msg are given, they will become the current folder and/or message.\n\n### BUGS\n\nThere  is no way to restore the default behavior (to ask the user whether to create a non-ex‐\nistent folder) after -create or -nocreate is given.\n\n\n\nnmh-1.7.1                                    2016-08-29                                  FOLDER(1mh)\n\n"
        }
    ],
    "structuredContent": {
        "command": "folder",
        "section": "1",
        "mode": "man",
        "summary": "folder, folders - set/list current nmh folder/message",
        "synopsis": "folder [-help] [-version] [+folder] [msg] [-all | -noall] [-create | -nocreate] [-fast | -no‐‐\nfast] [-header | -noheader] [-recurse | -norecurse] [-total | -nototal] [-list | -no‐‐\nlist] [-push | -pop] [-pack | -nopack] [-print] [-verbose | -noverbose]\nfolders is equivalent to folder -all",
        "flags": [
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": "create an empty folder for later use.) Specifying -nocreate will cause folder to print an error message and exit without creating a folder."
            },
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": ""
            }
        ],
        "examples": [],
        "see_also": [
            {
                "name": "mhpath",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/mhpath/1/json"
            },
            {
                "name": "refile",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/refile/1/json"
            },
            {
                "name": "rmf",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/rmf/1/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 12,
                "subsections": [
                    {
                        "name": "-create",
                        "lines": 3
                    },
                    {
                        "name": "Multiple Folders",
                        "lines": 40
                    },
                    {
                        "name": "Compacting a Folder",
                        "lines": 4
                    },
                    {
                        "name": "The Folder Stack",
                        "lines": 14
                    },
                    {
                        "name": "-pop -list -print",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "FILES",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "PROFILE COMPONENTS",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DEFAULTS",
                "lines": 2,
                "subsections": [
                    {
                        "name": "-nofast",
                        "lines": 1
                    },
                    {
                        "name": "-noheader",
                        "lines": 1
                    },
                    {
                        "name": "-nototal",
                        "lines": 1
                    },
                    {
                        "name": "-nopack",
                        "lines": 1
                    },
                    {
                        "name": "-norecurse",
                        "lines": 1
                    },
                    {
                        "name": "-noverbose",
                        "lines": 3
                    }
                ]
            },
            {
                "name": "CONTEXT",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "BUGS",
                "lines": 6,
                "subsections": []
            }
        ]
    }
}