Changeset View
Changeset View
Standalone View
Standalone View
usr.bin/ctags/ctags.1
Show All 22 Lines | |||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" @(#)ctags.1 8.1 (Berkeley) 6/6/93 | .\" @(#)ctags.1 8.1 (Berkeley) 6/6/93 | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd June 6, 1993 | .Dd May 23, 2023 | ||||
.Dt CTAGS 1 | .Dt CTAGS 1 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm ctags | .Nm ctags | ||||
.Nd create a | .Nd create a | ||||
.Pa tags | .Pa tags | ||||
file | file | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
▲ Show 20 Lines • Show All 48 Lines • ▼ Show 20 Lines | |||||
that do not take arguments; | that do not take arguments; | ||||
.Li #defines | .Li #defines | ||||
that take arguments are tagged automatically. | that take arguments are tagged automatically. | ||||
.It Fl f | .It Fl f | ||||
Place the tag descriptions in a file called | Place the tag descriptions in a file called | ||||
.Ar tagsfile . | .Ar tagsfile . | ||||
The default behaviour is to place them in a file called | The default behaviour is to place them in a file called | ||||
.Pa tags . | .Pa tags . | ||||
If | |||||
.Ar tagsfile | |||||
is | |||||
.Dq - , | |||||
the tags will be written to standard output instead. | |||||
.It Fl u | .It Fl u | ||||
Update the specified files in the | Update the specified files in the | ||||
.Pa tags | .Pa tags | ||||
file, that is, all | file, that is, all | ||||
references to them are deleted, and the new values are appended to the | references to them are deleted, and the new values are appended to the | ||||
file. | file. | ||||
(Beware: this option is implemented in a way which is rather | This is ignored if the tags file does not exist or is not a regular | ||||
file (e.g. | |||||
.Fl f Ns - | |||||
was used to write to standard output). | |||||
.Pp | |||||
Beware: this option is implemented in a way which is rather | |||||
slow; it is usually faster to simply rebuild the | slow; it is usually faster to simply rebuild the | ||||
.Pa tags | .Pa tags | ||||
file.) | file. | ||||
.It Fl v | .It Fl v | ||||
An index of the form expected by | An index of the form expected by | ||||
.Xr vgrind 1 | .Xr vgrind 1 | ||||
is produced on the standard output. | is produced on the standard output. | ||||
This listing | This listing | ||||
contains the object name, file name, and page number (assuming 64 | contains the object name, file name, and page number (assuming 64 | ||||
line pages). | line pages). | ||||
Since the output will be sorted into lexicographic order, | Since the output will be sorted into lexicographic order, | ||||
▲ Show 20 Lines • Show All 138 Lines • Show Last 20 Lines |