1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 09:30:04 +08:00
SpaceVim/docs/layers/cscope.md
Wang Shidong 0a2722d52f
Update cscope layer (#3023)
* Update doc

* Update

* Update cscope layer
2019-08-27 19:57:17 +08:00

68 lines
1.8 KiB
Markdown

---
title: "SpaceVim cscope layer"
description: "cscope layer provides a smart cscope and pycscope helper for SpaceVim, help users win at cscope"
---
# [Available Layers](../) >> cscope
<!-- vim-markdown-toc GFM -->
- [Description](#description)
- [Features](#features)
- [Install](#install)
- [cscope](#cscope)
- [layer](#layer)
- [Key bindings](#key-bindings)
<!-- vim-markdown-toc -->
## Description
This layer provides a smart [Cscope](http://cscope.sourceforge.net/) and [PyCscope](https://github.com/portante/pycscope) helper for SpaceVim.
For more info about the differences between Cscope and other similar tools, please read [Comparison with Similar Tools](https://github.com/oracle/opengrok/wiki/Comparison-with-Similar-Tools)
## Features
- Tag indexing and searching for C-C++ via Cscope
- Tag indexing and searching for python via PyCscope
## Install
### cscope
```shell
sudo pacman -S cscope
```
In windows, you can use scoop to install cscope:
```
scoop install cscope
```
### layer
To use this configuration layer, add it to your configuration file.
```toml
[[layers]]
name = "cscope"
```
## Key bindings
| Key Binding | Description |
| ----------- | -------------------------------------- |
| `SPC m c =` | Find assignments to this symbol |
| `SPC m c i` | Create cscope DB |
| `SPC m c u` | Update cscope DBs |
| `SPC m c c` | Find functions called by this function |
| `SPC m c C` | Find functions calling this function |
| `SPC m c d` | find global definition of a symbol |
| `SPC m c r` | find references of a symbol |
| `SPC m c f` | find file |
| `SPC m c F` | find which files include a file |
| `SPC m c e` | search regular expression |
| `SPC m c t` | search text |