github.com/gilgames000/kcc-geth@v1.0.6/cmd/geth/usage.go (about) 1 // Copyright 2015 The go-ethereum Authors 2 // This file is part of go-ethereum. 3 // 4 // go-ethereum is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // go-ethereum is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU General Public License for more details. 13 // 14 // You should have received a copy of the GNU General Public License 15 // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>. 16 17 // Contains the geth command usage template and generator. 18 19 package main 20 21 import ( 22 "io" 23 "sort" 24 25 "github.com/ethereum/go-ethereum/cmd/utils" 26 "github.com/ethereum/go-ethereum/internal/debug" 27 "github.com/ethereum/go-ethereum/internal/flags" 28 "gopkg.in/urfave/cli.v1" 29 ) 30 31 // AppHelpFlagGroups is the application flags, grouped by functionality. 32 var AppHelpFlagGroups = []flags.FlagGroup{ 33 { 34 Name: "ETHEREUM", 35 Flags: []cli.Flag{ 36 configFileFlag, 37 utils.DataDirFlag, 38 utils.AncientFlag, 39 utils.MinFreeDiskSpaceFlag, 40 utils.KeyStoreDirFlag, 41 utils.USBFlag, 42 utils.SmartCardDaemonPathFlag, 43 utils.NetworkIdFlag, 44 utils.MainnetFlag, 45 utils.TestnetFlag, 46 utils.SyncModeFlag, 47 utils.ExitWhenSyncedFlag, 48 utils.GCModeFlag, 49 utils.TxLookupLimitFlag, 50 utils.EthStatsURLFlag, 51 utils.IdentityFlag, 52 utils.LightKDFFlag, 53 utils.WhitelistFlag, 54 }, 55 }, 56 { 57 Name: "LIGHT CLIENT", 58 Flags: []cli.Flag{ 59 utils.LightServeFlag, 60 utils.LightIngressFlag, 61 utils.LightEgressFlag, 62 utils.LightMaxPeersFlag, 63 utils.UltraLightServersFlag, 64 utils.UltraLightFractionFlag, 65 utils.UltraLightOnlyAnnounceFlag, 66 utils.LightNoPruneFlag, 67 utils.LightNoSyncServeFlag, 68 }, 69 }, 70 { 71 Name: "DEVELOPER CHAIN", 72 Flags: []cli.Flag{ 73 utils.DeveloperFlag, 74 utils.DeveloperPeriodFlag, 75 }, 76 }, 77 { 78 Name: "ETHASH", 79 Flags: []cli.Flag{ 80 utils.EthashCacheDirFlag, 81 utils.EthashCachesInMemoryFlag, 82 utils.EthashCachesOnDiskFlag, 83 utils.EthashCachesLockMmapFlag, 84 utils.EthashDatasetDirFlag, 85 utils.EthashDatasetsInMemoryFlag, 86 utils.EthashDatasetsOnDiskFlag, 87 utils.EthashDatasetsLockMmapFlag, 88 }, 89 }, 90 { 91 Name: "TRANSACTION POOL", 92 Flags: []cli.Flag{ 93 utils.TxPoolLocalsFlag, 94 utils.TxPoolNoLocalsFlag, 95 utils.TxPoolJournalFlag, 96 utils.TxPoolRejournalFlag, 97 utils.TxPoolPriceLimitFlag, 98 utils.TxPoolPriceBumpFlag, 99 utils.TxPoolAccountSlotsFlag, 100 utils.TxPoolGlobalSlotsFlag, 101 utils.TxPoolAccountQueueFlag, 102 utils.TxPoolGlobalQueueFlag, 103 utils.TxPoolLifetimeFlag, 104 }, 105 }, 106 { 107 Name: "PERFORMANCE TUNING", 108 Flags: []cli.Flag{ 109 utils.CacheFlag, 110 utils.CacheDatabaseFlag, 111 utils.CacheTrieFlag, 112 utils.CacheTrieJournalFlag, 113 utils.CacheTrieRejournalFlag, 114 utils.CacheGCFlag, 115 utils.CacheSnapshotFlag, 116 utils.CacheNoPrefetchFlag, 117 utils.CachePreimagesFlag, 118 }, 119 }, 120 { 121 Name: "ACCOUNT", 122 Flags: []cli.Flag{ 123 utils.UnlockedAccountFlag, 124 utils.PasswordFileFlag, 125 utils.ExternalSignerFlag, 126 utils.InsecureUnlockAllowedFlag, 127 }, 128 }, 129 { 130 Name: "API AND CONSOLE", 131 Flags: []cli.Flag{ 132 utils.IPCDisabledFlag, 133 utils.IPCPathFlag, 134 utils.HTTPEnabledFlag, 135 utils.HTTPListenAddrFlag, 136 utils.HTTPPortFlag, 137 utils.HTTPApiFlag, 138 utils.HTTPPathPrefixFlag, 139 utils.HTTPCORSDomainFlag, 140 utils.HTTPVirtualHostsFlag, 141 utils.WSEnabledFlag, 142 utils.WSListenAddrFlag, 143 utils.WSPortFlag, 144 utils.WSApiFlag, 145 utils.WSPathPrefixFlag, 146 utils.WSAllowedOriginsFlag, 147 utils.GraphQLEnabledFlag, 148 utils.GraphQLCORSDomainFlag, 149 utils.GraphQLVirtualHostsFlag, 150 utils.RPCGlobalGasCapFlag, 151 utils.RPCGlobalTxFeeCapFlag, 152 utils.AllowUnprotectedTxs, 153 utils.JSpathFlag, 154 utils.ExecFlag, 155 utils.PreloadJSFlag, 156 }, 157 }, 158 { 159 Name: "NETWORKING", 160 Flags: []cli.Flag{ 161 utils.BootnodesFlag, 162 utils.DNSDiscoveryFlag, 163 utils.ListenPortFlag, 164 utils.MaxPeersFlag, 165 utils.MaxPendingPeersFlag, 166 utils.NATFlag, 167 utils.NoDiscoverFlag, 168 utils.DiscoveryV5Flag, 169 utils.NetrestrictFlag, 170 utils.NodeKeyFileFlag, 171 utils.NodeKeyHexFlag, 172 }, 173 }, 174 { 175 Name: "MINER", 176 Flags: []cli.Flag{ 177 utils.MiningEnabledFlag, 178 utils.MinerThreadsFlag, 179 utils.MinerNotifyFlag, 180 utils.MinerGasPriceFlag, 181 utils.MinerGasTargetFlag, 182 utils.MinerGasLimitFlag, 183 utils.MinerEtherbaseFlag, 184 utils.MinerExtraDataFlag, 185 utils.MinerRecommitIntervalFlag, 186 utils.MinerNoVerfiyFlag, 187 }, 188 }, 189 { 190 Name: "GAS PRICE ORACLE", 191 Flags: []cli.Flag{ 192 utils.GpoBlocksFlag, 193 utils.GpoPercentileFlag, 194 utils.GpoMaxGasPriceFlag, 195 }, 196 }, 197 { 198 Name: "VIRTUAL MACHINE", 199 Flags: []cli.Flag{ 200 utils.VMEnableDebugFlag, 201 utils.EVMInterpreterFlag, 202 utils.EWASMInterpreterFlag, 203 }, 204 }, 205 { 206 Name: "LOGGING AND DEBUGGING", 207 Flags: append([]cli.Flag{ 208 utils.FakePoWFlag, 209 utils.NoCompactionFlag, 210 }, debug.Flags...), 211 }, 212 { 213 Name: "METRICS AND STATS", 214 Flags: metricsFlags, 215 }, 216 { 217 Name: "ALIASED (deprecated)", 218 Flags: []cli.Flag{ 219 utils.NoUSBFlag, 220 utils.LegacyRPCEnabledFlag, 221 utils.LegacyRPCListenAddrFlag, 222 utils.LegacyRPCPortFlag, 223 utils.LegacyRPCCORSDomainFlag, 224 utils.LegacyRPCVirtualHostsFlag, 225 utils.LegacyRPCApiFlag, 226 }, 227 }, 228 { 229 Name: "MISC", 230 Flags: []cli.Flag{ 231 utils.SnapshotFlag, 232 utils.BloomFilterSizeFlag, 233 cli.HelpFlag, 234 }, 235 }, 236 } 237 238 func init() { 239 // Override the default app help template 240 cli.AppHelpTemplate = flags.AppHelpTemplate 241 242 // Override the default app help printer, but only for the global app help 243 originalHelpPrinter := cli.HelpPrinter 244 cli.HelpPrinter = func(w io.Writer, tmpl string, data interface{}) { 245 if tmpl == flags.AppHelpTemplate { 246 // Iterate over all the flags and add any uncategorized ones 247 categorized := make(map[string]struct{}) 248 for _, group := range AppHelpFlagGroups { 249 for _, flag := range group.Flags { 250 categorized[flag.String()] = struct{}{} 251 } 252 } 253 deprecated := make(map[string]struct{}) 254 for _, flag := range utils.DeprecatedFlags { 255 deprecated[flag.String()] = struct{}{} 256 } 257 // Only add uncategorized flags if they are not deprecated 258 var uncategorized []cli.Flag 259 for _, flag := range data.(*cli.App).Flags { 260 if _, ok := categorized[flag.String()]; !ok { 261 if _, ok := deprecated[flag.String()]; !ok { 262 uncategorized = append(uncategorized, flag) 263 } 264 } 265 } 266 if len(uncategorized) > 0 { 267 // Append all ungategorized options to the misc group 268 miscs := len(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags) 269 AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = append(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags, uncategorized...) 270 271 // Make sure they are removed afterwards 272 defer func() { 273 AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags[:miscs] 274 }() 275 } 276 // Render out custom usage screen 277 originalHelpPrinter(w, tmpl, flags.HelpData{App: data, FlagGroups: AppHelpFlagGroups}) 278 } else if tmpl == flags.CommandHelpTemplate { 279 // Iterate over all command specific flags and categorize them 280 categorized := make(map[string][]cli.Flag) 281 for _, flag := range data.(cli.Command).Flags { 282 if _, ok := categorized[flag.String()]; !ok { 283 categorized[flags.FlagCategory(flag, AppHelpFlagGroups)] = append(categorized[flags.FlagCategory(flag, AppHelpFlagGroups)], flag) 284 } 285 } 286 287 // sort to get a stable ordering 288 sorted := make([]flags.FlagGroup, 0, len(categorized)) 289 for cat, flgs := range categorized { 290 sorted = append(sorted, flags.FlagGroup{Name: cat, Flags: flgs}) 291 } 292 sort.Sort(flags.ByCategory(sorted)) 293 294 // add sorted array to data and render with default printer 295 originalHelpPrinter(w, tmpl, map[string]interface{}{ 296 "cmd": data, 297 "categorizedFlags": sorted, 298 }) 299 } else { 300 originalHelpPrinter(w, tmpl, data) 301 } 302 } 303 }