Skip to content

Commit

Permalink
[docs] Add search.md (#24755)
Browse files Browse the repository at this point in the history
* [docs] Add search.md

* [docs] Remove mention of registries from search.md
  • Loading branch information
ras0219-msft authored Jun 14, 2022
1 parent 8d2bff3 commit 06acb79
Showing 1 changed file with 37 additions and 0 deletions.
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.

[Registries]: ../users/registries.md

0 comments on commit 06acb79

Please sign in to comment.