{
    "content": [
        {
            "type": "text",
            "text": "# comp (man)\n\n## NAME\n\ncomp - compose an nmh message\n\n## SYNOPSIS\n\ncomp [-help] [-version] [+folder] [msg] [-form formfile] [-use | -nouse] [-file file]\n[-draftfolder +folder] [-draftmessage msg] [-nodraftfolder] [-editor editor] [-noedit]\n[-width columns] [-from address] [-to address] [-cc address] [-fcc +folder] [-subject\ntext] [-whatnowproc program] [-nowhatnowproc] [-build]\n\n## DESCRIPTION\n\ncomp is used to create a new message to be mailed.  It copies a message form to the draft be‐\ning  composed and then invokes an editor on the draft (unless -noedit is given, in which case\nthe initial edit is suppressed).\n\n## TLDR\n\n- Compare files interactively::\n  `comp`\n- Compare two specified files::\n  `comp path\\to\\file1 path\\to\\file2`\n- Compare two sets of files::\n  `comp path\\to\\directory1\\* path\\to\\directory2\\*`\n- Display differences in decimal format::\n  `comp {{path}} path\\to\\file1 path\\to\\file2`\n- Display differences in ASCII format::\n  `comp {{path}} path\\to\\file1 path\\to\\file2`\n- Display line numbers for differences::\n  `comp {{path}} path\\to\\file1 path\\to\\file2`\n- Compare files case-insensitively::\n  `comp {{path}} path\\to\\file1 path\\to\\file2`\n- Compare only the first 5 lines of each file::\n  `comp {{path}}=5 path\\to\\file1 path\\to\\file2`\n\n*Source: cheat.sh*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION** (3 subsections)\n- **FILES**\n- **PROFILE COMPONENTS**\n- **SEE ALSO**\n- **DEFAULTS** (2 subsections)\n- **CONTEXT**\n- **BUGS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "comp",
        "section": "",
        "mode": "man",
        "summary": "comp - compose an nmh message",
        "synopsis": "comp [-help] [-version] [+folder] [msg] [-form formfile] [-use | -nouse] [-file file]\n[-draftfolder +folder] [-draftmessage msg] [-nodraftfolder] [-editor editor] [-noedit]\n[-width columns] [-from address] [-to address] [-cc address] [-fcc +folder] [-subject\ntext] [-whatnowproc program] [-nowhatnowproc] [-build]",
        "tldr_summary": "",
        "tldr_examples": [
            {
                "description": "Compare files interactively:",
                "command": "comp"
            },
            {
                "description": "Compare two specified files:",
                "command": "comp path\\to\\file1 path\\to\\file2"
            },
            {
                "description": "Compare two sets of files:",
                "command": "comp path\\to\\directory1\\* path\\to\\directory2\\*"
            },
            {
                "description": "Display differences in decimal format:",
                "command": "comp {{path}} path\\to\\file1 path\\to\\file2"
            },
            {
                "description": "Display differences in ASCII format:",
                "command": "comp {{path}} path\\to\\file1 path\\to\\file2"
            },
            {
                "description": "Display line numbers for differences:",
                "command": "comp {{path}} path\\to\\file1 path\\to\\file2"
            },
            {
                "description": "Compare files case-insensitively:",
                "command": "comp {{path}} path\\to\\file1 path\\to\\file2"
            },
            {
                "description": "Compare only the first 5 lines of each file:",
                "command": "comp {{path}}=5 path\\to\\file1 path\\to\\file2"
            }
        ],
        "tldr_source": "cheatsh",
        "flags": [
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": "Any text you give to the -subject switch will be placed in the “Subject:” field in the draft. If the draft already exists, comp will ask you as to the disposition of the draft. A reply of quit will abort comp, leaving the draft intact; replace will replace the existing draft with the appropriate form; list will display the draft; use will use the draft for further composition; and refile +folder will file the draft in the given folder, and give you a new draft with the appropriate form. (The +folder argument to refile is required.) The -draftfolder +folder and -draftmessage msg switches invoke the nmh draft folder facility. This is an advanced (and highly useful) feature. Consult the mh-draft(5) man page for more information. The -editor editor switch indicates the editor to use for the initial edit. Upon exiting from the editor, comp will invoke the whatnow program (see whatnow(1) for a discussion of available options). The invocation of this program can be inhibited by using the -nowhatnow‐‐ proc switch. (In fact, it is the whatnow program which starts the initial edit. Hence,"
            },
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": "The -build switch is intended to be used by the Emacs mh-e interface to nmh. It implies"
            },
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": "that would normally be presented to the user for editing. No mail is actually sent."
            }
        ],
        "examples": [],
        "see_also": [
            {
                "name": "dist",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/dist/1/json"
            },
            {
                "name": "forw",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/forw/1/json"
            },
            {
                "name": "repl",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/repl/1/json"
            },
            {
                "name": "send",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/send/1/json"
            },
            {
                "name": "whatnow",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/whatnow/1/json"
            },
            {
                "name": "mh-profile",
                "section": "5",
                "url": "https://www.chedong.com/phpMan.php/man/mh-profile/5/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 50,
                "subsections": [
                    {
                        "name": "-fcc",
                        "lines": 16
                    },
                    {
                        "name": "-nowhatnowproc",
                        "lines": 1
                    },
                    {
                        "name": "-nowhatnowproc",
                        "lines": 2
                    }
                ]
            },
            {
                "name": "FILES",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "PROFILE COMPONENTS",
                "lines": 7,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DEFAULTS",
                "lines": 2,
                "subsections": [
                    {
                        "name": "-nodraftfolder",
                        "lines": 1
                    },
                    {
                        "name": "-nouse",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "CONTEXT",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "BUGS",
                "lines": 7,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "comp - compose an nmh message\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "comp [-help] [-version] [+folder] [msg] [-form formfile] [-use | -nouse] [-file file]\n[-draftfolder +folder] [-draftmessage msg] [-nodraftfolder] [-editor editor] [-noedit]\n[-width columns] [-from address] [-to address] [-cc address] [-fcc +folder] [-subject\ntext] [-whatnowproc program] [-nowhatnowproc] [-build]\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "comp is used to create a new message to be mailed.  It copies a message form to the draft be‐\ning  composed and then invokes an editor on the draft (unless -noedit is given, in which case\nthe initial edit is suppressed).\n\nThe default message template “components” will direct comp to construct the message draft  as\nfollows:\n\nFrom: {from switch} or <Local-Mailbox> or <username@hostname>\nTo: {to switch} or blank\ncc: {cc switch} or blank\nFcc: {fcc switch} or +outbox\nSubject: {subject switch} or blank\n--------\n\nIf  a  file named “components” exists in the user's nmh directory, it will be used instead of\nthis form.  You may specify an alternate forms file with the switch -form formfile.\n\nYou may also start comp using the contents of an existing message as the form.  If you supply\neither a +folder or msg argument, that message will be used as the message form.  You may not\nsupply both a -form formfile and a +folder or msg argument.  The line of dashes  or  a  blank\nline  must be left between the header and the body of the message for the message to be iden‐\ntified properly when it is sent (see send(1)).\n\nThe switch -use directs comp to continue editing an already started message.  That is,  if  a\ncomp  (or  dist,  repl,  or  forw)  is terminated without sending the draft, the draft can be\nedited again via “comp -use”.\n\nThe -file file switch says to use the named file as the message draft.\n\nForms that are selected via the -form switch are processed via the nmh template  system;  see\nmh-format(5)  for details.  Drafts constructed from another message or with the -use or -file\nswitches will not be processed with mh-format(5).\n\nIn addition to the standard mh-format(5) escapes, the following component escapes are  either\nnew or have an alternate meaning:\n\nEscape  Returns  Description\nfcc     string   Any folders specified with `-fcc folder'\nfrom    string   Any addresses specified with `-from address'\nto      string   Any addresses specified with `-to address'\ncc      string   Any addresses specified with `-cc address'\nsubject string   Any text specified with `-subject text'\n\nBy  default the “To:” and “cc:” fields are empty.  You may add addresses to these fields with\nthe -to address and -cc address switches.  You may give these switches multiple times to  add\nmultiple addresses.\n\nBy  default  the  “From:”  field has either the value of the Local-Mailbox profile entry or a\nsystem default email address.  This default can be overridden  by  using  the  -from  address\nswitch.   The  default mailbox in the “Fcc:” field is +outbox.  This can be overridden by the",
                "subsections": [
                    {
                        "name": "-fcc",
                        "content": "Any text you give to the -subject switch will be placed in the “Subject:” field in the draft.\n\nIf the draft already exists, comp will ask you as to the disposition of the draft.   A  reply\nof  quit  will  abort comp, leaving the draft intact; replace will replace the existing draft\nwith the appropriate form; list will display the draft; use will use the  draft  for  further\ncomposition;  and  refile +folder will file the draft in the given folder, and give you a new\ndraft with the appropriate form.  (The +folder argument to refile is required.)\n\nThe -draftfolder +folder and -draftmessage msg switches invoke the nmh draft folder facility.\nThis  is  an advanced (and highly useful) feature.  Consult the mh-draft(5) man page for more\ninformation.\n\nThe -editor editor switch indicates the editor to use for the  initial  edit.   Upon  exiting\nfrom  the  editor,  comp  will invoke the whatnow program (see whatnow(1) for a discussion of\navailable options).  The invocation of this program can be inhibited by using the -nowhatnow‐‐\nproc  switch.   (In  fact,  it  is the whatnow program which starts the initial edit.  Hence,"
                    },
                    {
                        "name": "-nowhatnowproc",
                        "content": "The -build switch is intended to be used by the Emacs mh-e  interface  to  nmh.   It  implies"
                    },
                    {
                        "name": "-nowhatnowproc",
                        "content": "that would normally be presented to the user for editing.  No mail is actually sent.\n"
                    }
                ]
            },
            "FILES": {
                "content": "/etc/nmh/components The default message skeleton.\n<mh-dir>/components The user's message skeleton.\n$HOME/.mhprofile   The user's profile.\n",
                "subsections": []
            },
            "PROFILE COMPONENTS": {
                "content": "Path:               To determine the user's nmh directory.\nDraft-Folder:       To find the default draft-folder.\nEditor:             To override the default editor.\nMsg-Protect:        To set mode when creating a new message (draft).\nfileproc:           Program to refile the message.\nwhatnowproc:        Program to ask the “What now?” questions\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5)\n",
                "subsections": []
            },
            "DEFAULTS": {
                "content": "+folder             The current folder.\nmsg                 The current message.",
                "subsections": [
                    {
                        "name": "-nodraftfolder",
                        "content": ""
                    },
                    {
                        "name": "-nouse",
                        "content": ""
                    }
                ]
            },
            "CONTEXT": {
                "content": "None\n",
                "subsections": []
            },
            "BUGS": {
                "content": "If whatnowproc is whatnow, then comp uses a built-in whatnow, it does not  actually  run  the\nwhatnow program.  Hence, if you define your own whatnowproc, don't call it whatnow since comp\nwon't run it.\n\n\n\nnmh-1.7.1                                    2013-10-18                                    COMP(1mh)",
                "subsections": []
            }
        }
    }
}