1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/*
* strings.go - File which contains the specific strings used for output and
* formatting in fscrypt.
*
* Copyright 2017 Google Inc.
* Author: Joe Richey (joerichey@google.com)
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package main
import (
"fmt"
"strings"
)
const shortUsage = "A tool for managing Linux native filesystem encryption"
// Argument usage strings
const (
directoryArg = "DIRECTORY"
mountpointArg = "MOUNTPOINT"
pathArg = "PATH"
mountpointIDArg = mountpointArg + ":ID"
)
// Text Templates which format our command line output (using text/template)
var (
// indent is the prefix for the output lines in each section
indent = strings.Repeat(" ", indentLength)
// Top level help output: what is printed for "fscrypt" or "fscrypt --help"
appHelpTemplate = `{{.HelpName}} - {{.Usage}}
Usage:
` + indent + `{{.HelpName}} COMMAND [arguments] [options]
Commands:{{range .VisibleCommands}}
` + indent + `{{join .Names ", "}}{{"\t- "}}{{.Usage}}{{end}}
{{if .Description}}
Description:
` + indent + `{{.Description}}
{{end}}
Options:
{{range .VisibleFlags}}{{.}}
{{end}}`
// Command help output, used when a command has no subcommands
commandHelpTemplate = `{{.HelpName}} - {{.Usage}}
Usage:
` + indent + `{{.HelpName}}{{if .ArgsUsage}} {{.ArgsUsage}}{{end}}{{if .VisibleFlags}} [options]{{end}}
{{if .Description}}
Description:
` + indent + `{{.Description}}
{{end}}{{if .VisibleFlags}}
Options:
{{range .VisibleFlags}}{{.}}
{{end}}{{end}}`
// Subcommand help output, used when a command has subcommands
subcommandHelpTemplate = `{{.HelpName}} - {{.Usage}}
Usage:
` + indent + `{{.HelpName}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}SUBCOMMAND [arguments]{{end}}{{if .VisibleFlags}} [options]{{end}}
Subcommands:{{range .VisibleCommands}}
` + indent + `{{join .Names ", "}}{{"\t- "}}{{.Usage}}{{end}}
{{if .Description}}
Description:
` + indent + `{{.Description}}
{{end}}{{if .VisibleFlags}}
Options:
{{range .VisibleFlags}}{{.}}
{{end}}{{end}}`
)
// Add words to this map to have pluralize support them.
var plurals = map[string]string{
"argument": "arguments",
"filesystem": "filesystems",
"protector": "protectors",
"policy": "policies",
}
// pluralize prints out the correct pluralization of a word along with the
// specified count. This means pluralize(1, "policy") = "1 policy" but
// pluralize(2, "policy") = "2 policies"
func pluralize(count int, word string) string {
if count != 1 {
word = plurals[word]
}
return fmt.Sprintf("%d %s", count, word)
}
|
