Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Slashes

There are two kinds of slashes: the backslash and the forward slash.

Backslash ( \ )

Backlashes are used in a couple of ways:

  • Windows operating systems use backslashes in URL and URI paths. When writing instructions for Windows users and developers, always include the *nix path first, followed by the Windows path. See the following example:
*nix
$SPLUNK_HOME/bin/splunkd
Windows
%SPLUNK_HOME%\bin\splunkd.exe
  • Backslashes are used in code.

Forward slash ( / )

A forward slash has multiple meanings:

  • *nix operating systems use forward slashes as a path divider. When writing instructions for *nix users and developers, always include the *nix path first, follow by the Windows path. See the following example:
*nix
$SPLUNK_HOME/bin/splunkd
Windows
%SPLUNK_HOME%\bin\splunkd.exe
  • Forward slashes can mean "and", "divide by", "or", "per", or "with". In most cases, use the word you intend instead of a slash. You can use the forward slash when you write about read, write, and delete permissions.
Correct
Linux or Windows.
All registration information is written to and stored in the database.
An 8 CPU, 16 GB memory machine can achieve 50 to 60 Mb per second throughput.
Add read/write permissions for all users.
Incorrect
Linux and/or Windows.
All registration information is written to/stored in the database.
An 8 CPU, 16 GB memory machine can achieve 50 to 60 Mb/second throughput.
Last modified on 15 August, 2023
PREVIOUS
Quotation marks
  NEXT
Splunk product terminology

This documentation applies to the following versions of Splunk® Style Guide: current


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters