Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add search.md #24755

Merged
merged 3 commits into from
Jun 14, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/commands/search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# vcpkg search

**The latest version of this documentation is available on [GitHub](https://github.com/Microsoft/vcpkg/tree/master/docs/commands/search.md).**

## Synopsis

```no-highlight
vcpkg search [options] [query]
```

## Description

Searches for available packages by name and description.

Search performs a case-insensitive search through all available package names and descriptions. The results are displayed in a tabular format.

## Example
```no-highlight
$ vcpkg search zlib
miniz 2.2.0#1 Single C source file zlib-replacement library
zlib 1.2.12#1 A compression library
zlib-ng 2.0.6 zlib replacement with optimizations for 'next generation' systems
```

## Options

All vcpkg commands support a set of [common options](common-options.md).

### `--x-full-desc`

**Experimental and may change or be removed at any time**

Do not truncate long descriptions.

By default, long descriptions will be truncated to keep the tabular output browsable.

ras0219-msft marked this conversation as resolved.
Show resolved Hide resolved
[Registries]: ../users/registries.md