comparison doc/vimcrosoft.txt @ 11:096e80c13781

Use the correct documentation extension.
author Ludovic Chabant <ludovic@chabant.com>
date Fri, 22 Jan 2021 16:42:25 -0800
parents doc/vimcrosoft.vim@5d2c0db51914
children
comparison
equal deleted inserted replaced
10:f444739dd8af 11:096e80c13781
1 *vimcrosoft.txt* Work with Visual Studio solutions in Vim
2
3
4 $$\ $$\$$$$$$\$$\ $$\ $$$$$$\ $$$$$$$\ $$$$$$\ $$$$$$\ $$$$$$\ $$$$$$$$\$$$$$$$$\
5 $$ | $$ \_$$ _$$$\ $$$ $$ __$$\$$ __$$\$$ __$$\$$ __$$\$$ __$$\$$ _____\__$$ __|
6 $$ | $$ | $$ | $$$$\ $$$$ $$ / \__$$ | $$ $$ / $$ $$ / \__$$ / $$ $$ | $$ |
7 \$$\ $$ | $$ | $$\$$\$$ $$ $$ | $$$$$$$ $$ | $$ \$$$$$$\ $$ | $$ $$$$$\ $$ |
8 \$$\$$ / $$ | $$ \$$$ $$ $$ | $$ __$$<$$ | $$ |\____$$\$$ | $$ $$ __| $$ |
9 \$$$ / $$ | $$ |\$ /$$ $$ | $$\$$ | $$ $$ | $$ $$\ $$ $$ | $$ $$ | $$ |
10 \$ / $$$$$$\$$ | \_/ $$ \$$$$$$ $$ | $$ |$$$$$$ \$$$$$$ |$$$$$$ $$ | $$ |
11 \_/ \______\__| \__|\______/\__| \__|\______/ \______/ \______/\__| \__|
12
13
14 VIM-CROSOFT
15
16 *vimcrosoft*
17
18 ==============================================================================
19 Configuration *vimcrosoft-configuration*
20
21 *g:vimcrosoft_trace*
22 g:vimcrosoft_trace
23 Enables debugging information.
24 Default: `0`
25
26 *g:vimcrosoft_auto_find_sln*
27 g:vimcrosoft_auto_find_sln
28 Try and find a solution for the current working
29 directory on Vim startup. This effectively executes
30 |:VimcrosoftAutoFindSln| upon startup.
31 Default: `0`
32
33 *g:vimcrosoft_sln_finder*
34 g:vimcrosoft_sln_finder
35 The name of a function to call to find a solution file
36 from a given current path. If not set, Vimcrosoft will
37 use its own default finder, which just walks up the
38 directory tree until it finds any `*.sln` files.
39 Default: `""`
40
41 *g:vimcrosoft_msbuild_path*
42 g:vimcrosoft_msbuild_path
43 By default, Vimcrosoft automatically finds where
44 MSBuild is installed. If that fails, you can specify
45 the path to the MSBuild executable directly.
46 Default: `""`
47
48 *g:vimcrosoft_make_command*
49 g:vimcrosoft_make_command
50 The command to run when starting builds. If empty,
51 Vimcrosoft will use |:make|, unless the vim-dispatch
52 plugin is detected, in which case it will use |:Make|.
53 If the option is not empty, it will use whatever you
54 specified.
55 Default: `""`
56
57 ==============================================================================
58 Commands *vimcrosoft-commands*
59
60 *vimcrosoft-solution-commands*
61 Here's a list of solution-related commands:
62
63 *:VimcrosoftAutoFindSln*
64 :VimcrosoftAutoFindSln
65 Finds a solution file (`*.sln`) in the current working
66 directory, or any of its parent directories, and sets
67 it as the current solution file (see
68 |:VimcrosoftSetSln|). If any solution files are found,
69 the first one is used.
70
71 *:VimcrosoftSetSln*
72 :VimcrosoftSetSln <file>
73 Sets the currently active solution file. All
74 vim-crosoft commands will relate to this solution.
75
76 *:VimcrosoftUnsetSln*
77 :VimcrosoftUnsetSln
78 Unsets the currently active solution file.
79
80 *:VimcrosoftSetConfigPlatform*
81 :VimcrosoftSetConfigPlatform <configplatform>
82 Sets the currently active configuration and platform
83 for the active solution. The argument is a combo of
84 configuration and platform, in the form of
85 `Configuration|Platform`.
86
87 *:VimcrosoftBuildSln*
88 :VimcrosoftBuildSln
89 Starts a build on the current solution, using the
90 current configuration and platform.
91
92 *:VimcrosoftRebuildSln*
93 :VimcrosoftRebuildSln
94 Rebuilds the current solution, using the current
95 configuration and platform.
96
97 *:VimcrosoftCleanSln*
98 :VimcrosoftCleanSln
99 Cleans the current solution for the current
100 configuration and platform.
101
102
103 *vimcrosoft-project-commands*
104 Here are some project-related commands:
105
106 *:VimcrosoftBuildProject*
107 :VimcrosoftBuildProject
108 Builds the active project for the current
109 configuration and platform. MSBuild will typically
110 build all its dependencies first.
111
112 *:VimcrosoftBuildProjectOnly*
113 :VimcrosoftBuildProjectOnly
114 Builds the active project for the current
115 configuration and platform, but skips building any
116 dependencies.
117
118 *:VimcrosoftRebuildProject*
119 :VimcrosoftRebuildProject
120 Rebuilds the active project for the current
121 configuration and platform.
122
123 *:VimcrosoftCleanProject*
124 :VimcrosoftCleanProject
125 Cleans the active project for the current
126 configuration and platform.
127
128
129 *vimcrosoft-active-project-commands*
130 Vimcrosoft lets you specify an "active project" that makes it quicker to
131 build/clean/etc.
132
133 *:VimcrosoftSetActiveProject*
134 :VimcrosoftSetActiveProject
135 Sets the active project for the current solution. This
136 enables a few "shortcut" commands that operate on it
137 directly.
138
139 *:VimcrosoftBuildActiveProject*
140 :VimcrosoftBuildActiveProject
141 Builds the active project for the current
142 configuration and platform. MSBuild will typically
143 build all its dependencies first.
144
145 *:VimcrosoftBuildActiveProjectOnly*
146 :VimcrosoftBuildActiveProjectOnly
147 Builds the active project for the current
148 configuration and platform, but skips building any
149 dependencies.
150
151 *:VimcrosoftRebuildActiveProject*
152 :VimcrosoftRebuildActiveProject
153 Rebuilds the active project for the current
154 configuration and platform.
155
156 *:VimcrosoftCleanActiveProject*
157 :VimcrosoftCleanActiveProject
158 Cleans the active project for the current
159 configuration and platform.
160
161
162 ==============================================================================
163 Statusline *vimcrosoft-statusline*
164
165 You can show some vimcrosoft-related information in your 'statusline' by
166 calling the `vimcrosoft#statusline()` function.
167
168
169 " vim:tw=78:et:ft=help:norl: