CSpell

CSpell Options

This page lists all system options for CSpell programs

OptionFeature Descriptions
-ciPrint configuration information.
-dTurn on debug print.
-f:ndSet function to non-dictionary.
-f:nwSet function to non-word.
-f:rwSet function to real-word (default).
-f:hPrint function help information.
-hPrint program help information (this is it).
-hsPrint option's hierarchy structure.
-i:STRSpecify input file name. The default is screen input.
-mcn:INTSpecify Max. candidate no.
-nReturn a "-No Output-" message when an input produces no output.
-o:STRSpecify output file name. The default is screen output.
-pShow the prompt. The default is no prompt.
-r:hPrint NW-1To1 ranking help information.
-siShow input text.
-tShow token operations.
-vPrint the version of cSpell.
-X:STRLoading an alternative configuration file.

Examples: 

  • shell> CSpell -v
cSpell.2018


  • shell> CSpell -i:in.data -o:out.data

    Read data from file, in.data, and send output to file, out.data.


  • shell> CSpell -x:config.data

    Use an alternative configuration file, config.data


  • shell> CSpell -ci
========== Files/Directory Setup ==========
CS_DIR: [/Projects/cSpell2018/]
CS_CHECK_DIC_FILES: [data/Dictionary/check.dic]
CS_SUGGEST_DIC_FILES: [data/Dictionary/sugg.dic]
CS_SPLIT_WORD_DIC_FILES: [data/Dictionary/split.dic]
CS_MW_DIC_FILE: [data/Dictionary/lexicon.mw.dic]
CS_PN_DIC_FILE: [data/Dictionary/lexicon.pn.dic]
CS_AA_DIC_FILE: [data/Dictionary/lexicon.aa.dic]
CS_SV_DIC_FILE: [data/Dictionary/sv.dic]
CS_UNIT_DIC_FILE: [data/Dictionary/unit.data]
CS_FREQUENCY_FILE: [data/Frequency/wcWord.data]
CS_W2V_IM_FILE: [data/Context/syn0.data]
CS_W2V_OM_FILE: [data/Context/syn1n.data]
========== CSpell Mode ==========CS_FUNC_MODE: [10]
CS_RANK_MODE: [5]
========== Detectors Setup ==========
CS_RW_SPLIT_WORD_MIN_LENGTH: [4]
CS_RW_SPLIT_WORD_MIN_WC: [200]
CS_RW_SPLIT_1TO1_MIN_LENGTH: [2]
CS_RW_1TO1_WORD_MIN_WC: [1]
========== Candidates Setup ==========
CS_ND_MAX_SPLIT_NO: [5]
CS_NW_MAX_SPLIT_NO: [5]
CS_NW_MAX_MERGE_NO: [2]
CS_NW_MERGE_WITH_HYPHEN: [true]
CS_RW_MAX_SPLIT_NO: [2]
CS_RW_MAX_MERGE_NO: [2]
CS_RW_MERGE_WITH_HYPHEN: [false]
CS_RW_SHORT_SPLIT_WORD_LENGTH: [3]
CS_RW_MAX_SHORT_SPLIT_WORD_NO: [2]
CS_MAX_CANDIDATE_NO: [30]
CS_RW_MERGE_CAND_MIN_WC: [15]
CS_RW_SPLIT_CAND_MIN_WC: [200]
CS_RW_1TO1_CAND_MIN_LENGTH: [2]
CS_RW_1TO1_CAND_MAX_KEY_SIZE: [1000000000]
========== Rankers Setup ==========
CS_NW_S1_RANK_RANGE_FAC: [0.08]
CS_NW_S1_MIN_OSCORE: [2.70]
CS_RW_1TO1_C_FAC: [0.00]
CS_RW_SPLIT_C_FAC: [0.01]
CS_RW_MERGE_C_FAC: [0.60]
CS_RW_1TO1_WORD_MIN_CS: [-0.085]
CS_RW_1TO1_CAND_CS_FAC: [0.10]
CS_RW_1TO1_CAND_MIN_CS: [0.00]
CS_RW_1TO1_CAND_CS_DIST: [0.085]
CS_RW_1TO1_CAND_FS_FAC: [0.035]
CS_RW_1TO1_CAND_MIN_FS: [0.0006]
CS_RW_1TO1_CAND_FS_DIST: [0.02]
CS_W2V_SKIP_WORD: [true]
CS_NW_1_CONTEXT_RADIUS: [2]
CS_NW_S_CONTEXT_RADIUS: [2]
CS_NW_M_CONTEXT_RADIUS: [2]
CS_RW_1_CONTEXT_RADIUS: [2]
CS_RW_S_CONTEXT_RADIUS: [2]
CS_RW_M_CONTEXT_RADIUS: [2]